openapi: 3.0.0
info:
  version: 2018-05-10
  x-release: v4
  title: AWS Systems Manager Incident Manager CreateReplicationSet ListIncidentRecords API
  description: <p>Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their Amazon Web Services-hosted applications. An incident is any unplanned interruption or reduction in quality of services. </p> <p>Incident Manager increases incident resolution by notifying responders of impact, highlighting relevant troubleshooting data, and providing collaboration tools to get services back up and running. To achieve the primary goal of reducing the time-to-resolution of critical incidents, Incident Manager automates response plans and enables responder team escalation. </p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: ssm-incidents
  x-aws-signingName: ssm-incidents
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/ssm-incidents-2018-05-10.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://ssm-incidents.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The SSM Incidents multi-region endpoint
- url: https://ssm-incidents.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The SSM Incidents multi-region endpoint
- url: http://ssm-incidents.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The SSM Incidents endpoint for China (Beijing) and China (Ningxia)
- url: https://ssm-incidents.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The SSM Incidents endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: ListIncidentRecords
paths:
  /listIncidentRecords:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: ListIncidentRecords
      description: 'Lists all incident records in your account. Use this command to retrieve the Amazon Resource Name (ARN) of the incident record you want to update. '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListIncidentRecordsOutput'
        '480':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '481':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '482':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '483':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
      parameters:
      - name: maxResults
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: nextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                filters:
                  description: <p>Filters the list of incident records you want to search through. You can filter on the following keys:</p> <ul> <li> <p> <code>creationTime</code> </p> </li> <li> <p> <code>impact</code> </p> </li> <li> <p> <code>status</code> </p> </li> <li> <p> <code>createdBy</code> </p> </li> </ul> <p>Note the following when when you use Filters:</p> <ul> <li> <p>If you don't specify a Filter, the response includes all incident records.</p> </li> <li> <p>If you specify more than one filter in a single request, the response returns incident records that match all filters.</p> </li> <li> <p>If you specify a filter with more than one value, the response returns incident records that match any of the values provided.</p> </li> </ul>
                  type: array
                  items:
                    $ref: '#/components/schemas/Filter'
                  minItems: 0
                  maxItems: 5
                maxResults:
                  description: The maximum number of results per page.
                  type: integer
                  minimum: 1
                  maximum: 100
                nextToken:
                  description: The pagination token to continue to the next page of results.
                  type: string
                  minLength: 0
                  maxLength: 2000
      summary: Amazon Incident Manager List Incident Records
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - ListIncidentRecords
components:
  schemas:
    IncidentRecordSummaryList:
      type: array
      items:
        $ref: '#/components/schemas/IncidentRecordSummary'
      minItems: 0
      maxItems: 100
    StringList:
      type: array
      items:
        $ref: '#/components/schemas/StringListMemberString'
      minItems: 0
      maxItems: 100
    AccessDeniedException: {}
    StringListMemberString:
      type: string
      minLength: 0
      maxLength: 1000
    IncidentTitle:
      type: string
      minLength: 0
      maxLength: 200
    Integer:
      type: integer
    IntegerList:
      type: array
      items:
        $ref: '#/components/schemas/Integer'
      minItems: 0
      maxItems: 100
    ThrottlingException: {}
    IncidentRecordSource:
      type: object
      required:
      - createdBy
      - source
      properties:
        createdBy:
          allOf:
          - $ref: '#/components/schemas/Arn'
          - description: The principal that started the incident.
        invokedBy:
          allOf:
          - $ref: '#/components/schemas/ServicePrincipal'
          - description: The service principal that assumed the role specified in <code>createdBy</code>. If no service principal assumed the role this will be left blank.
        resourceArn:
          allOf:
          - $ref: '#/components/schemas/Arn'
          - description: The resource that caused the incident to be created.
        source:
          allOf:
          - $ref: '#/components/schemas/IncidentSource'
          - description: The service that started the incident. This can be manually created from Incident Manager, automatically created using an Amazon CloudWatch alarm, or Amazon EventBridge event.
      description: Details about what created the incident record and when it was created.
    Arn:
      type: string
      pattern: ^arn:aws(-cn|-us-gov)?:[a-z0-9-]*:[a-z0-9-]*:([0-9]{12})?:.+$
      minLength: 0
      maxLength: 1000
    ListIncidentRecordsOutput:
      type: object
      required:
      - incidentRecordSummaries
      properties:
        incidentRecordSummaries:
          allOf:
          - $ref: '#/components/schemas/IncidentRecordSummaryList'
          - description: The details of each listed incident record.
        nextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: The pagination token to continue to the next page of results.
    Timestamp:
      type: string
      format: date-time
    ServicePrincipal:
      type: string
      minLength: 0
      maxLength: 1000
    Condition:
      type: object
      properties:
        after:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: After the specified timestamp.
        before:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: Before the specified timestamp
        equals:
          allOf:
          - $ref: '#/components/schemas/AttributeValueList'
          - description: 'The value is equal to the provided string or integer. '
      description: A conditional statement with which to compare a value, after a timestamp, before a timestamp, or equal to a string or integer. If multiple conditions are specified, the conditionals become an <code>AND</code>ed statement. If multiple values are specified for a conditional, the values are <code>OR</code>d.
    IncidentRecordSummary:
      type: object
      required:
      - arn
      - creationTime
      - impact
      - incidentRecordSource
      - status
      - title
      properties:
        arn:
          allOf:
          - $ref: '#/components/schemas/Arn'
          - description: The Amazon Resource Name (ARN) of the incident.
        creationTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time the incident was created.
        impact:
          allOf:
          - $ref: '#/components/schemas/Impact'
          - description: Defines the impact to customers and applications.
        incidentRecordSource:
          allOf:
          - $ref: '#/components/schemas/IncidentRecordSource'
          - description: What caused Incident Manager to create the incident.
        resolvedTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time the incident was resolved.
        status:
          allOf:
          - $ref: '#/components/schemas/IncidentRecordStatus'
          - description: The current status of the incident.
        title:
          allOf:
          - $ref: '#/components/schemas/IncidentTitle'
          - description: The title of the incident. This value is either provided by the response plan or overwritten on creation.
      description: Details describing an incident record.
    NextToken:
      type: string
      minLength: 0
      maxLength: 2000
    IncidentRecordStatus:
      type: string
      enum:
      - OPEN
      - RESOLVED
    InternalServerException: {}
    Impact:
      type: integer
      minimum: 1
      maximum: 5
    FilterKeyString:
      type: string
      minLength: 0
      maxLength: 50
    IncidentSource:
      type: string
      minLength: 0
      maxLength: 50
    Filter:
      type: object
      required:
      - condition
      - key
      properties:
        condition:
          allOf:
          - $ref: '#/components/schemas/Condition'
          - description: The condition accepts before or after a specified time, equal to a string, or equal to an integer.
        key:
          allOf:
          - $ref: '#/components/schemas/FilterKeyString'
          - description: The key that you're filtering on.
      description: Filter the selection by using a condition.
    ValidationException: {}
    AttributeValueList:
      type: object
      properties:
        integerValues:
          allOf:
          - $ref: '#/components/schemas/IntegerList'
          - description: The list of integer values that the filter matches.
        stringValues:
          allOf:
          - $ref: '#/components/schemas/StringList'
          - description: The list of string values that the filter matches.
      description: Use the AttributeValueList to filter by string or integer values.
  parameters:
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/ssm-incidents/
x-hasEquivalentPaths: true