Amazon Incident Manager Incident Manager Rotation API

openapi: 3.2.0
info:
  title: AWS Systems Manager Incident Manager Rotation API
  version: '2018-05-10'
  description: Generated from AWS's published Smithy model for AWS Systems Manager Incident Manager. 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://ssm-contacts.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Rotation
paths:
  /#CreateRotation:
    post:
      operationId: CreateRotation
      summary: Create Rotation
      description: Creates a rotation in an on-call schedule.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateRotationResult'
        '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.CreateRotation
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateRotationRequest'
      tags:
      - Rotation
  /#DeleteRotation:
    post:
      operationId: DeleteRotation
      summary: Delete Rotation
      description: Deletes a rotation from the system. If a rotation belongs to more than one on-call schedule, this operation deletes it from all of them.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteRotationResult'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsConflictException'
        '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.DeleteRotation
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteRotationRequest'
      tags:
      - Rotation
  /#GetRotation:
    post:
      operationId: GetRotation
      summary: Get Rotation
      description: Retrieves information about an on-call rotation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetRotationResult'
        '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.GetRotation
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetRotationRequest'
      tags:
      - Rotation
  /#ListRotations:
    post:
      operationId: ListRotations
      summary: List Rotations
      description: Retrieves a list of on-call rotations.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListRotationsResult'
        '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.ListRotations
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListRotationsRequest'
      tags:
      - Rotation
  /#UpdateRotation:
    post:
      operationId: UpdateRotation
      summary: Update Rotation
      description: Updates the information specified for an on-call rotation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateRotationResult'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsAccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/SsmContactsConflictException'
        '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.UpdateRotation
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateRotationRequest'
      tags:
      - Rotation
components:
  schemas:
    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
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: Name of the object key.
        Value:
          type: string
          description: Value of the tag.
    CoverageTime:
      type: object
      properties:
        Start:
          $ref: '#/components/schemas/HandOffTime'
        End:
          $ref: '#/components/schemas/HandOffTime'
    CreateRotationResult:
      type: object
      properties:
        RotationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the created rotation.
      required:
      - RotationArn
    DeleteRotationRequest:
      type: object
      properties:
        RotationId:
          type: string
          description: The Amazon Resource Name (ARN) of the on-call rotation to delete.
      required:
      - RotationId
    ListRotationsRequest:
      type: object
      properties:
        RotationNamePrefix:
          type: string
          description: A filter to include rotations in list results based on their common prefix. For example, entering prod returns a list of all rotation names that begin with prod, such as production and prod-1.
        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.
    DependentEntity:
      type: object
      properties:
        RelationType:
          type: string
          description: The type of relationship between one resource and the other resource that it is related to or depends on.
        DependentResourceIds:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the dependent resources.
      required:
      - RelationType
      - DependentResourceIds
    Rotation:
      type: object
      properties:
        RotationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the rotation.
        Name:
          type: string
          description: The name of the rotation.
        ContactIds:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the contacts assigned to the rotation team.
        StartTime:
          type: string
          format: date-time
          description: The date and time the rotation becomes active.
        TimeZoneId:
          type: string
          description: 'The time zone the rotation’s activity is based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul".'
        Recurrence:
          $ref: '#/components/schemas/RecurrenceSettings'
      required:
      - RotationArn
      - Name
    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
    UpdateRotationResult:
      type: object
      properties: {}
    DeleteRotationResult:
      type: object
      properties: {}
    WeeklySetting:
      type: object
      properties:
        DayOfWeek:
          type: string
          enum:
          - MON
          - TUE
          - WED
          - THU
          - FRI
          - SAT
          - SUN
          description: The day of the week when weekly recurring on-call shift rotations begins.
        HandOffTime:
          $ref: '#/components/schemas/HandOffTime'
      required:
      - DayOfWeek
      - HandOffTime
    SsmContactsConflictException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
          description: Identifier of the resource in use
        ResourceType:
          type: string
          description: Type of the resource in use
        DependentEntities:
          type: array
          items:
            $ref: '#/components/schemas/DependentEntity'
          description: List of dependent entities containing information on relation type and resourceArns linked to the resource in use
      required:
      - Message
      - ResourceId
      - ResourceType
    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
    RecurrenceSettings:
      type: object
      properties:
        MonthlySettings:
          type: array
          items:
            $ref: '#/components/schemas/MonthlySetting'
          description: Information about on-call rotations that recur monthly.
        WeeklySettings:
          type: array
          items:
            $ref: '#/components/schemas/WeeklySetting'
          description: Information about on-call rotations that recur weekly.
        DailySettings:
          type: array
          items:
            $ref: '#/components/schemas/HandOffTime'
          description: Information about on-call rotations that recur daily.
        NumberOfOnCalls:
          type: integer
          description: The number of contacts, or shift team members designated to be on call concurrently during a shift. For example, in an on-call schedule that contains ten contacts, a value of 2 designates that two of them are on call at any given time.
        ShiftCoverages:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/CoverageTime'
          description: Information about the days of the week that the on-call rotation coverage includes.
        RecurrenceMultiplier:
          type: integer
          description: The number of days, weeks, or months a single rotation lasts.
      required:
      - NumberOfOnCalls
      - RecurrenceMultiplier
    SsmContactsAccessDeniedException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    GetRotationRequest:
      type: object
      properties:
        RotationId:
          type: string
          description: The Amazon Resource Name (ARN) of the on-call rotation to retrieve information about.
      required:
      - RotationId
    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
    GetRotationResult:
      type: object
      properties:
        RotationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the on-call rotation.
        Name:
          type: string
          description: The name of the on-call rotation.
        ContactIds:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the contacts assigned to the on-call rotation team.
        StartTime:
          type: string
          format: date-time
          description: The specified start time for the on-call rotation.
        TimeZoneId:
          type: string
          description: The time zone that the rotation’s activity is based on, in Internet Assigned Numbers Authority (IANA) format.
        Recurrence:
          $ref: '#/components/schemas/RecurrenceSettings'
      required:
      - RotationArn
      - Name
      - ContactIds
      - StartTime
      - TimeZoneId
      - Recurrence
    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
    SsmContactsInternalServerException:
      type: object
      properties:
        Message:
          type: string
        RetryAfterSeconds:
          type: integer
          description: Advice to clients on when the call can be safely retried
      required:
      - Message
    ListRotationsResult:
      type: object
      properties:
        NextToken:
          type: string
          description: The token for the next set of items to return. Use this token to get the next set of results.
        Rotations:
          type: array
          items:
            $ref: '#/components/schemas/Rotation'
          description: Information about rotations that meet the filter criteria.
      required:
      - Rotations
    UpdateRotationRequest:
      type: object
      properties:
        RotationId:
          type: string
          description: The Amazon Resource Name (ARN) of the rotation to update.
        ContactIds:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the contacts to include in the updated rotation. Only the PERSONAL contact type is supported. The contact types ESCALATION and ONCALL_SCHEDULE are not supported for this operation. The order in which you list the contacts is their shift order in the rotation schedule.
        StartTime:
          type: string
          format: date-time
          description: The date and time the rotation goes into effect.
        TimeZoneId:
          type: string
          description: 'The time zone to base the updated rotation’s activity on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website. Designators for time zones that don’t support Daylight Savings Time Rules, such as Pacific Standard Time (PST), aren''t supported.'
        Recurrence:
          $ref: '#/components/schemas/RecurrenceSettings'
      required:
      - RotationId
      - Recurrence
    CreateRotationRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the rotation.
        ContactIds:
          type: array
          items:
            type: string
          description: The Amazon Resource Names (ARNs) of the contacts to add to the rotation. Only the PERSONAL contact type is supported. The contact types ESCALATION and ONCALL_SCHEDULE are not supported for this operation. The order that you list the contacts in is their shift order in the rotation schedule. To change the order of the contact's shifts, use the UpdateRotation operation.
        StartTime:
          type: string
          format: date-time
          description: The date and time that the rotation goes into effect.
        TimeZoneId:
          type: string
          description: 'The time zone to base the rotation’s activity on in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website. Designators for time zones that don’t support Daylight Savings Time rules, such as Pacific Standard Time (PST), are not supported.'
        Recurrence:
          $ref: '#/components/schemas/RecurrenceSettings'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Optional metadata to assign to the rotation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For more information, see Tagging Incident Manager resources in the Incident Manager User Guide.
        IdempotencyToken:
          type: string
          description: A token that ensures that the operation is called only once with the specified details.
      required:
      - Name
      - ContactIds
      - TimeZoneId
      - Recurrence
    MonthlySetting:
      type: object
      properties:
        DayOfMonth:
          type: integer
          description: The day of the month when monthly recurring on-call rotations begin.
        HandOffTime:
          $ref: '#/components/schemas/HandOffTime'
      required:
      - DayOfMonth
      - HandOffTime
    HandOffTime:
      type: object
      properties:
        HourOfDay:
          type: integer
          description: The hour when an on-call rotation shift begins or ends.
        MinuteOfHour:
          type: integer
          description: The minute when an on-call rotation shift begins or ends.
      required:
      - HourOfDay
      - MinuteOfHour
  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)