Synthetics
Amazon CloudWatch Synthetics You can use Amazon CloudWatch Synthetics to continually monitor your services. You can create and manage canaries , which are…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Amazon CloudWatch Synthetics
You can use Amazon CloudWatch Synthetics to continually monitor your services. You can
create and manage canaries , which are modular, lightweight scripts
that monitor your endpoints and APIs
from the outside-in. You can set up your canaries to run
24 hours a day, once per minute. The 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. The canaries seamlessly integrate with CloudWatch
ServiceLens to help you trace the causes of impacted nodes in your applications. For more
information, see Using ServiceLens to Monitor
the Health of Your Applications in the Amazon CloudWatch User
Guide .
Before you create and manage canaries, be aware of the security considerations. For more
information, see Security
Considerations for Synthetics Canaries .
Endpoints 22
- PATCHAssociate resource
/group/:GroupIdentifier/associateAssociates 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… - POSTCreate canary
/canaryCreates 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… - POSTCreate group
/groupCreates a group which you can use to associate canaries with each other, including cross-Region canaries. Using groups can help you with managing and… - GETGet canary
/canary/:Name?dryRunId=stringRetrieves 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… - DELETEDelete canary
/canary/:Name?deleteLambda=truePermanently deletes the specified canary. If the canary's ProvisionedResourceCleanup field is set to AUTOMATIC or you specify DeleteLambda in this operation… - PATCHUpdate canary
/canary/:NameUpdates the configuration of a canary that has already been created. For multibrowser canaries, you can add or remove browsers by updating the browserConfig… - GETGet group
/group/:GroupIdentifierReturns information about one group. Groups are a global resource, so you can use this operation from any Region. - DELETEDelete group
/group/:GroupIdentifierDeletes 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… - POSTDescribe canaries
/canariesThis operation returns a list of the canaries in your account, along with full details about each canary. This operation supports resource-level authorization… - POSTDescribe canaries last run
/canaries/last-runUse this operation to see information from the most recent run of each canary that you have created. This operation supports resource-level authorization… - POSTDescribe runtime versions
/runtime-versionsReturns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions . - PATCHDisassociate resource
/group/:GroupIdentifier/disassociateRemoves a canary from a group. You must run this operation in the Region where the canary exists. - POSTGet canary runs
/canary/:Name/runsRetrieves a list of runs for a specified canary. - POSTList associated groups
/resource/:ResourceArn/groupsReturns a list of the groups that the specified canary is associated with. The canary that you specify must be in the current Region. - POSTList group resources
/group/:GroupIdentifier/resourcesThis operation returns a list of the ARNs of the canaries that are associated with the specified group. - POSTList groups
/groupsReturns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups from all Regions are returned. - GETList tags for resource
/tags/:ResourceArnDisplays the tags associated with a canary or group. - POSTTag resource
/tags/:ResourceArnAssigns 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… - DELETEUntag resource
/tags/:ResourceArn?tagKeys=Removes one or more tags from the specified resource. - POSTStart canary
/canary/:Name/startUse 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… - POSTStart canary dry run
/canary/:Name/dry-run/startUse this operation to start a dry run for a canary that has already been created - POSTStop canary
/canary/:Name/stopStops 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…
API details
- Base URL
https://synthetics.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 22 operations on 17 pathsPOST 13GET 3PATCH 3DELETE 3
- Description format
- AWS Smithy model, API version
2017-10-11 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Synthetics in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Synthetics collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Associate resource” (PATCH /group/:GroupIdentifier/associate), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Synthetics?
Amazon CloudWatch Synthetics You can use Amazon CloudWatch Synthetics to continually monitor your services. You can create and manage canaries , which are… It is listed under Developer tools and has 22 endpoints.
Who publishes the Synthetics?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Synthetics?
Requests go to https://synthetics.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Synthetics?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Synthetics have?
22 operations on 17 paths (13 POST, 3 GET, 3 PATCH, 3 DELETE).
Is forking the Synthetics free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.