1---2name: synthetics3description: Synthetics API skill. Use when working with Synthetics for group, canary, canaries. Covers 21 endpoints.4---5
6# Synthetics
7API version: 2017-10-11
8
9## Auth
10AWS SigV4
11
12## Base URL
13Not specified.
14
15## Setup
161. Configure auth: AWS SigV4
172. GET /canary/{name} -- verify access
183. POST /canary -- create first canary
19
20## Endpoints
21
2221 endpoints across 7 groups. See references/api-spec.lap for full details.
23
24### group
25| Method | Path | Description |
26|--------|------|-------------|
27| PATCH | /group/{groupIdentifier}/associate | Associates a canary with a group. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group. You must run this operation in the Region where the canary exists. |
28| POST | /group | Creates a group which you can use to associate canaries with each other, including cross-Region canaries. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group. Groups are global resources. When you create a group, it is replicated across Amazon Web Services Regions, and you can view it and add canaries to it from any Region. Although the group ARN format reflects the Region name where it was created, a group is not constrained to any Region. This means that you can put canaries from multiple Regions into the same group, and then use that group to view and manage all of those canaries in a single view. Groups are supported in all Regions except the Regions that are disabled by default. For more information about these Regions, see Enabling a Region. Each group can contain as many as 10 canaries. You can have as many as 20 groups in your account. Any single canary can be a member of up to 10 groups. |
29| DELETE | /group/{groupIdentifier} | Deletes a group. The group doesn't need to be empty to be deleted. If there are canaries in the group, they are not deleted when you delete the group. Groups are a global resource that appear in all Regions, but the request to delete a group must be made from its home Region. You can find the home Region of a group within its ARN. |
30| PATCH | /group/{groupIdentifier}/disassociate | Removes a canary from a group. You must run this operation in the Region where the canary exists. |
31| GET | /group/{groupIdentifier} | Returns information about one group. Groups are a global resource, so you can use this operation from any Region. |
32| POST | /group/{groupIdentifier}/resources | This operation returns a list of the ARNs of the canaries that are associated with the specified group. |
33
34### canary
35| Method | Path | Description |
36|--------|------|-------------|
37| POST | /canary | Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the outside-in. Canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. You can set up a canary to run continuously or just once. Do not use CreateCanary to modify an existing canary. Use UpdateCanary instead. To create canaries, you must have the CloudWatchSyntheticsFullAccess policy. If you are creating a new IAM role for the canary, you also need the iam:CreateRole, iam:CreatePolicy and iam:AttachRolePolicy permissions. For more information, see Necessary Roles and Permissions. Do not include secrets or proprietary information in your canary names. The canary name makes up part of the Amazon Resource Name (ARN) for the canary, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries. |
38| DELETE | /canary/{name} | Permanently deletes the specified canary. If you specify DeleteLambda to true, CloudWatch Synthetics also deletes the Lambda functions and layers that are used by the canary. Other resources used and created by the canary are not automatically deleted. After you delete a canary that you do not intend to use again, you should also delete the following: The CloudWatch alarms created for this canary. These alarms have a name of Synthetics-SharpDrop-Alarm-MyCanaryName . Amazon S3 objects and buckets, such as the canary's artifact location. IAM roles created for the canary. If they were created in the console, these roles have the name role/service-role/CloudWatchSyntheticsRole-MyCanaryName . CloudWatch Logs log groups created for the canary. These logs groups have the name /aws/lambda/cwsyn-MyCanaryName . Before you delete a canary, you might want to use GetCanary to display the information about this canary. Make note of the information returned by this operation so that you can delete these resources after you delete the canary. |
39| GET | /canary/{name} | Retrieves complete information about one canary. You must specify the name of the canary that you want. To get a list of canaries and their names, use DescribeCanaries. |
40| POST | /canary/{name}/runs | Retrieves a list of runs for a specified canary. |
41| POST | /canary/{name}/start | Use this operation to run a canary that has already been created. The frequency of the canary runs is determined by the value of the canary's Schedule. To see a canary's schedule, use GetCanary. |
42| POST | /canary/{name}/stop | Stops the canary to prevent all future runs. If the canary is currently running,the run that is in progress completes on its own, publishes metrics, and uploads artifacts, but it is not recorded in Synthetics as a completed run. You can use StartCanary to start it running again with the canary’s current schedule at any point in the future. |
43| PATCH | /canary/{name} | Updates the configuration of a canary that has already been created. You can't use this operation to update the tags of an existing canary. To change the tags of an existing canary, use TagResource. |
44
45### canaries
46| Method | Path | Description |
47|--------|------|-------------|
48| POST | /canaries | This operation returns a list of the canaries in your account, along with full details about each canary. This operation supports resource-level authorization using an IAM policy and the Names parameter. If you specify the Names parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response. You are required to use the Names parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries. |
49| POST | /canaries/last-run | Use this operation to see information from the most recent run of each canary that you have created. This operation supports resource-level authorization using an IAM policy and the Names parameter. If you specify the Names parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response. You are required to use the Names parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries. |
50
51### runtime-versions
52| Method | Path | Description |
53|--------|------|-------------|
54| POST | /runtime-versions | Returns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions. |
55
56### resource
57| Method | Path | Description |
58|--------|------|-------------|
59| POST | /resource/{resourceArn}/groups | Returns a list of the groups that the specified canary is associated with. The canary that you specify must be in the current Region. |
60
61### groups
62| Method | Path | Description |
63|--------|------|-------------|
64| POST | /groups | Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups from all Regions are returned. |
65
66### tags
67| Method | Path | Description |
68|--------|------|-------------|
69| GET | /tags/{resourceArn} | Displays the tags associated with a canary or group. |
70| POST | /tags/{resourceArn} | Assigns one or more tags (key-value pairs) to the specified canary or group. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a canary or group. |
71| DELETE | /tags/{resourceArn} | Removes one or more tags from the specified resource. |
72
73## Common Questions
74
75Match user requests to endpoints in references/api-spec.lap. Key patterns:
76- "Create a canary?" -> POST /canary
77- "Create a group?" -> POST /group
78- "Delete a canary?" -> DELETE /canary/{name}
79- "Delete a group?" -> DELETE /group/{groupIdentifier}
80- "Create a canary?" -> POST /canaries
81- "Create a last-run?" -> POST /canaries/last-run
82- "Create a runtime-version?" -> POST /runtime-versions
83- "Get canary details?" -> GET /canary/{name}
84- "Create a run?" -> POST /canary/{name}/runs
85- "Get group details?" -> GET /group/{groupIdentifier}
86- "Create a group?" -> POST /resource/{resourceArn}/groups
87- "Create a resource?" -> POST /group/{groupIdentifier}/resources
88- "Create a group?" -> POST /groups
89- "Get tag details?" -> GET /tags/{resourceArn}
90- "Create a start?" -> POST /canary/{name}/start
91- "Create a stop?" -> POST /canary/{name}/stop
92- "Delete a tag?" -> DELETE /tags/{resourceArn}
93- "Partially update a canary?" -> PATCH /canary/{name}
94- "How to authenticate?" -> See Auth section
95
96## Response Tips
97- Check response schemas in references/api-spec.lap for field details
98- Create/update endpoints typically return the created/updated object
99
100## References
101- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
102
103> Generated from the official API spec by [LAP](https://lap.sh)
Lap-Platform