Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Amazon Web Services synthetics Group API
description: 'Amazon CloudWatch Synthetics
You can use Amazon CloudWatch Synthetics to continually monitor your services.'
tags:
- name: Group
paths:
/group/{groupIdentifier}/associate:
PATCH:
summary: Amazon Web Services Associateresource
description: 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.
operationId: amazonWebServicesAssociateResource
tags:
- Group
/group:
POST:
summary: Amazon Web Services Creategroup
description: 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.
operationId: amazonWebServicesCreateGroup
tags:
- Group
/group/{groupIdentifier}:
GET:
summary: Amazon Web Services Getgroup
description: Returns information about one group. Groups are a global resource, so you can use this operation from any Region.
operationId: amazonWebServicesGetGroup
tags:
- Group
/group/{groupIdentifier}/disassociate:
PATCH:
summary: Amazon Web Services Disassociateresource
description: Removes a canary from a group. You must run this operation in the Region where the canary exists.
operationId: amazonWebServicesDisassociateResource
tags:
- Group
/group/{groupIdentifier}/resources:
POST:
summary: Amazon Web Services Listgroupresources
description: This operation returns a list of the ARNs of the canaries that are associated with the specified group.
operationId: amazonWebServicesListGroupResources
tags:
- Group