[ aws . ssm-incidents ]

list-incident-records

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-incident-records is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: incidentRecordSummaries

Synopsis

  list-incident-records
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--filters (list)

Filters the list of incident records through which you are searching. You can filter on the following keys:

  • creationTime

  • impact

  • status

  • createdBy

Note the following when deciding how to use Filters:

  • If you don’t specify a Filter, the response includes all incident records.

  • If you specify more than one filter in a single request, the response returns incident records that match all filters.

  • If you specify a filter with more than one value, the response returns incident records that match any of the values provided.

(structure)

Filter the selection by using a condition.

condition -> (structure)

The condition accepts before or after a specified time, equal to a string, or equal to an integer.

after -> (timestamp)

After the specified timestamp.

before -> (timestamp)

Before the specified timestamp

equals -> (structure)

The value is equal to the provided string or integer.

integerValues -> (list)

The list of integer values that the filter matches.

(integer)

stringValues -> (list)

The list of string values that the filter matches.

(string)

key -> (string)

The key that you’re filtering on.

JSON Syntax:

[
  {
    "condition": {
      "after": timestamp,
      "before": timestamp,
      "equals": {
        "integerValues": [integer, ...],
        "stringValues": ["string", ...]
      }
    },
    "key": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To list incident records

The following command-name example lists the incident records in your Amazon Web Services account.

aws ssm-incidents list-incident-records

Output:

{
    "incidentRecordSummaries": [
        {
            "arn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308",
            "creationTime": "2021-05-21T18:16:57.579000+00:00",
            "impact": 5,
            "incidentRecordSource": {
                "createdBy": "arn:aws:iam::111122223333:user/draliatp",
                "invokedBy": "arn:aws:iam::111122223333:user/draliatp",
                "source": "aws.ssm-incidents.custom"
            },
            "status": "OPEN",
            "title": "Example-Incident"
        }
    ]
}

For more information, see Incident list in the Incident Manager User Guide.

Output

incidentRecordSummaries -> (list)

The details of each listed incident record.

(structure)

Details describing an incident record.

arn -> (string)

The Amazon Resource Name (ARN) of the incident.

creationTime -> (timestamp)

The time the incident was created.

impact -> (integer)

Defines the impact to customers and applications.

incidentRecordSource -> (structure)

What caused Incident Manager to create the incident.

createdBy -> (string)

The principal that started the incident.

invokedBy -> (string)

The service principal that assumed the role specified in createdBy . If no service principal assumed the role this will be left blank.

resourceArn -> (string)

The resource that caused the incident to be created.

source -> (string)

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.

resolvedTime -> (timestamp)

The time the incident was resolved.

status -> (string)

The current status of the incident.

title -> (string)

The title of the incident. This value is either provided by the response plan or overwritten on creation.

nextToken -> (string)

The pagination token to continue to the next page of results.