Amazon CloudWatch Cloudwatch Group API

openapi: 3.1.0
info:
  title: Amazon CloudWatch Group API
  version: '2010-08-01'
  description: Generated from AWS's published Smithy model for Amazon CloudWatch. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://synthetics.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /group:
    post:
      operationId: CreateGroup
      summary: Create Group
      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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateGroupResponse'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyntheticsInternalServerException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyntheticsServiceQuotaExceededException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyntheticsValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGroupRequest'
      tags:
      - Group
  /group/{GroupIdentifier}:
    delete:
      operationId: DeleteGroup
      summary: Delete Group
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteGroupResponse'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyntheticsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyntheticsResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyntheticsValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteGroupRequest'
      tags:
      - Group
    get:
      operationId: GetGroup
      summary: Get Group
      description: Returns information about one group. Groups are a global resource, so you can use this operation from any
        Region.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGroupResponse'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyntheticsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyntheticsResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyntheticsValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetGroupRequest'
      tags:
      - Group
  /resource/{ResourceArn}/groups:
    post:
      operationId: ListAssociatedGroups
      summary: List Associated Groups
      description: Returns a list of the groups that the specified canary is associated with. The canary that you specify
        must be in the current Region.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAssociatedGroupsResponse'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyntheticsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyntheticsResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyntheticsValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAssociatedGroupsRequest'
      tags:
      - Group
  /groups:
    post:
      operationId: ListGroups
      summary: List Groups
      description: Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups from
        all Regions are returned.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListGroupsResponse'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyntheticsInternalServerException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyntheticsValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListGroupsRequest'
      tags:
      - Group
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: synthetics
  schemas:
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    CreateGroupRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name for the group. It can include any Unicode characters. The names for all groups in your account,
            across all Regions, must be unique.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: A list of key-value pairs to associate with the group. You can associate as many as 50 tags with a
            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 the resources that have certain tag values.
      required:
      - Name
    CreateGroupResponse:
      type: object
      properties:
        Group:
          $ref: '#/components/schemas/Group'
    DeleteGroupRequest:
      type: object
      properties:
        GroupIdentifier:
          type: string
          description: Specifies which group to delete. You can specify the group name, the ARN, or the group ID as the GroupIdentifier.
      required:
      - GroupIdentifier
    DeleteGroupResponse:
      type: object
      properties: {}
    GetGroupRequest:
      type: object
      properties:
        GroupIdentifier:
          type: string
          description: Specifies the group to return information for. You can specify the group name, the ARN, or the group
            ID as the GroupIdentifier.
      required:
      - GroupIdentifier
    GetGroupResponse:
      type: object
      properties:
        Group:
          $ref: '#/components/schemas/Group'
    Group:
      type: object
      properties:
        Id:
          type: string
          description: The unique ID of the group.
        Name:
          type: string
          description: The name of the group.
        Arn:
          type: string
          description: The ARN of the group.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The list of key-value pairs that are associated with the canary.
        CreatedTime:
          type: string
          format: date-time
          description: The date and time that the group was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: The date and time that the group was most recently updated.
    GroupSummary:
      type: object
      properties:
        Id:
          type: string
          description: The unique ID of the group.
        Name:
          type: string
          description: The name of the group.
        Arn:
          type: string
          description: The ARN of the group.
    ListAssociatedGroupsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: A token that indicates that there is more data available. You can use this token in a subsequent operation
            to retrieve the next set of results.
        MaxResults:
          type: integer
          description: Specify this parameter to limit how many groups are returned each time you use the ListAssociatedGroups
            operation. If you omit this parameter, the default of 20 is used.
        ResourceArn:
          type: string
          description: The ARN of the canary that you want to view groups for.
      required:
      - ResourceArn
    ListAssociatedGroupsResponse:
      type: object
      properties:
        Groups:
          type: array
          items:
            $ref: '#/components/schemas/GroupSummary'
          description: An array of structures that contain information about the groups that this canary is associated with.
        NextToken:
          type: string
          description: A token that indicates that there is more data available. You can use this token in a subsequent ListAssociatedGroups
            operation to retrieve the next set of results.
    ListGroupsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: A token that indicates that there is more data available. You can use this token in a subsequent operation
            to retrieve the next set of results.
        MaxResults:
          type: integer
          description: Specify this parameter to limit how many groups are returned each time you use the ListGroups operation.
            If you omit this parameter, the default of 20 is used.
    ListGroupsResponse:
      type: object
      properties:
        Groups:
          type: array
          items:
            $ref: '#/components/schemas/GroupSummary'
          description: An array of structures that each contain information about one group.
        NextToken:
          type: string
          description: A token that indicates that there is more data available. You can use this token in a subsequent ListGroups
            operation to retrieve the next set of results.
    SyntheticsInternalServerException:
      type: object
      properties:
        Message:
          type: string
    SyntheticsResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    SyntheticsServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
    SyntheticsValidationException:
      type: object
      properties:
        Message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/synthetics/service/2017-10-11/synthetics-2017-10-11.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)