Amazon Incident Manager Incident Manager Rotation Override API

openapi: 3.2.0
info:
  title: AWS Systems Manager Incident Manager Rotation Override API
  version: '2018-05-10'
  description: Generated from AWS's published Smithy model for AWS Systems Manager Incident Manager. 4 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://ssm-contacts.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Rotation Override
paths:
  /#CreateRotationOverride:
    post:
      operationId: CreateRotationOverride
      summary: Create Rotation Override
      description: Creates an override for a rotation in an on-call schedule.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateRotationOverrideResult'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SSMContacts.CreateRotationOverride
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateRotationOverrideRequest'
      tags:
      - Rotation Override
  /#DeleteRotationOverride:
    post:
      operationId: DeleteRotationOverride
      summary: Delete Rotation Override
      description: Deletes an existing override for an on-call rotation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteRotationOverrideResult'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SSMContacts.DeleteRotationOverride
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteRotationOverrideRequest'
      tags:
      - Rotation Override
  /#GetRotationOverride:
    post:
      operationId: GetRotationOverride
      summary: Get Rotation Override
      description: Retrieves information about an override to an on-call rotation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetRotationOverrideResult'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SSMContacts.GetRotationOverride
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetRotationOverrideRequest'
      tags:
      - Rotation Override
  /#ListRotationOverrides:
    post:
      operationId: ListRotationOverrides
      summary: List Rotation Overrides
      description: Retrieves a list of overrides currently specified for an on-call rotation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListRotationOverridesResult'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsAccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SSMContacts.ListRotationOverrides
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListRotationOverridesRequest'
      tags:
      - Rotation Override
components:
  schemas:
    SsmContactsServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
          description: Identifier of the resource affected
        ResourceType:
          type: string
          description: Type of the resource affected
        QuotaCode:
          type: string
          description: Service Quotas requirement to identify originating service
        ServiceCode:
          type: string
          description: Service Quotas requirement to identify originating quota
      required:
      - Message
      - QuotaCode
      - ServiceCode
    SsmContactsResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
          description: Hypothetical resource identifier that was not found
        ResourceType:
          type: string
          description: Hypothetical resource type that was not found
      required:
      - Message
      - ResourceId
      - ResourceType
    ListRotationOverridesRequest:
      type: object
      properties:
        RotationId:
          type: string
          description: The Amazon Resource Name (ARN) of the rotation to retrieve information about.
        StartTime:
          type: string
          format: date-time
          description: The date and time for the beginning of a time range for listing overrides.
        EndTime:
          type: string
          format: date-time
          description: The date and time for the end of a time range for listing overrides.
        NextToken:
          type: string
          description: A token to start the list. Use this token to get the next set of results.
        MaxResults:
          type: integer
          description: The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
      required:
      - RotationId
      - StartTime
      - EndTime
    RotationOverride:
      type: object
      properties:
        RotationOverrideId:
          type: string
          description: The Amazon Resource Name (ARN) of the override to an on-call rotation.
        NewContactIds:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the contacts assigned to the override of the on-call rotation.
        StartTime:
          type: string
          format: date-time
          description: The time a rotation override begins.
        EndTime:
          type: string
          format: date-time
          description: The time a rotation override ends.
        CreateTime:
          type: string
          format: date-time
          description: The time a rotation override was created.
      required:
      - RotationOverrideId
      - NewContactIds
      - StartTime
      - EndTime
      - CreateTime
    SsmContactsInternalServerException:
      type: object
      properties:
        Message:
          type: string
        RetryAfterSeconds:
          type: integer
          description: Advice to clients on when the call can be safely retried
      required:
      - Message
    SsmContactsValidationException:
      type: object
      properties:
        Message:
          type: string
        Reason:
          type: string
          enum:
          - UNKNOWN_OPERATION
          - CANNOT_PARSE
          - FIELD_VALIDATION_FAILED
          - OTHER
          description: Reason the request failed validation
        Fields:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: The fields that caused the error
      required:
      - Message
    GetRotationOverrideResult:
      type: object
      properties:
        RotationOverrideId:
          type: string
          description: The Amazon Resource Name (ARN) of the override to an on-call rotation.
        RotationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the on-call rotation that was overridden.
        NewContactIds:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the contacts assigned to the override of the on-call rotation.
        StartTime:
          type: string
          format: date-time
          description: The date and time when the override goes into effect.
        EndTime:
          type: string
          format: date-time
          description: The date and time when the override ends.
        CreateTime:
          type: string
          format: date-time
          description: The date and time when the override was created.
    ListRotationOverridesResult:
      type: object
      properties:
        RotationOverrides:
          type: array
          items:
            $ref: '#/components/schemas/RotationOverride'
          description: A list of rotation overrides in the specified time range.
        NextToken:
          type: string
          description: The token for the next set of items to return. Use this token to get the next set of results.
    SsmContactsThrottlingException:
      type: object
      properties:
        Message:
          type: string
        QuotaCode:
          type: string
          description: Service Quotas requirement to identify originating service
        ServiceCode:
          type: string
          description: Service Quotas requirement to identify originating quota
        RetryAfterSeconds:
          type: integer
          description: Advice to clients on when the call can be safely retried
      required:
      - Message
    SsmContactsAccessDeniedException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    CreateRotationOverrideResult:
      type: object
      properties:
        RotationOverrideId:
          type: string
          description: The Amazon Resource Name (ARN) of the created rotation override.
      required:
      - RotationOverrideId
    DeleteRotationOverrideResult:
      type: object
      properties: {}
    DeleteRotationOverrideRequest:
      type: object
      properties:
        RotationId:
          type: string
          description: The Amazon Resource Name (ARN) of the rotation that was overridden.
        RotationOverrideId:
          type: string
          description: The Amazon Resource Name (ARN) of the on-call rotation override to delete.
      required:
      - RotationId
      - RotationOverrideId
    CreateRotationOverrideRequest:
      type: object
      properties:
        RotationId:
          type: string
          description: The Amazon Resource Name (ARN) of the rotation to create an override for.
        NewContactIds:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the contacts to replace those in the current on-call rotation with. If you want to include any current team members in the override shift, you must include their ARNs in the new contact ID list.
        StartTime:
          type: string
          format: date-time
          description: The date and time when the override goes into effect.
        EndTime:
          type: string
          format: date-time
          description: The date and time when the override ends.
        IdempotencyToken:
          type: string
          description: A token that ensures that the operation is called only once with the specified details.
      required:
      - RotationId
      - NewContactIds
      - StartTime
      - EndTime
    ValidationExceptionField:
      type: object
      properties:
        Name:
          type: string
          description: The name of the field that caused the exception.
        Message:
          type: string
          description: Information about what caused the field to cause an exception.
      required:
      - Name
      - Message
    GetRotationOverrideRequest:
      type: object
      properties:
        RotationId:
          type: string
          description: The Amazon Resource Name (ARN) of the overridden rotation to retrieve information about.
        RotationOverrideId:
          type: string
          description: The Amazon Resource Name (ARN) of the on-call rotation override to retrieve information about.
      required:
      - RotationId
      - RotationOverrideId
  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: ssm-contacts
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/ssm-contacts/service/2021-05-03/ssm-contacts-2021-05-03.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)