[ aws . ssm-contacts ]

list-pages-by-contact

Description

Lists the engagements to a contact’s contact channels.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-pages-by-contact 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: Pages

Synopsis

  list-pages-by-contact
--contact-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--contact-id (string)

The Amazon Resource Name (ARN) of the contact you are retrieving engagements for.

--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

To list pages by contact

The following list-pages-by-contact example lists all pages to the specified contact.

aws ssm-contacts list-pages-by-contact \
    --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"

Output:

{
    "Pages": [
        {
            "PageArn": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93",
            "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0",
            "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
            "Sender": "cli",
            "SentTime": "2021-05-18T18:43:29.301000+00:00",
            "DeliveryTime": "2021-05-18T18:43:55.265000+00:00",
            "ReadTime": "2021-05-18T18:43:55.708000+00:00"
        }
    ]
}

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

Output

NextToken -> (string)

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

Pages -> (list)

The list of engagements to a contact’s contact channel.

(structure)

Incident Manager engaging a contact’s contact channel.

PageArn -> (string)

The Amazon Resource Name (ARN) of the page to the contact channel.

EngagementArn -> (string)

The ARN of the engagement that this page is part of.

ContactArn -> (string)

The ARN of the contact that Incident Manager is engaging.

Sender -> (string)

The user that started the engagement.

IncidentId -> (string)

The ARN of the incident that’s engaging the contact channel.

SentTime -> (timestamp)

The time that Incident Manager engaged the contact channel.

DeliveryTime -> (timestamp)

The time the message was delivered to the contact channel.

ReadTime -> (timestamp)

The time that the contact channel acknowledged engagement.