Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ssm-contacts ]

describe-page

Description

Lists details of the engagement to a contact channel.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-page
--page-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--page-id (string)

The ID of the engagement to a contact channel.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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 the details of a page to a contact channel

The following describe-page example lists details of a page to a contact channel. The page will include the subject and content provided.

aws ssm-contacts describe-page \
    --page-id "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93"

Output:

{
    "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",
    "Subject": "cli-test",
    "Content": "Testing engagements via CLI",
    "PublicSubject": "cli-test",
    "PublicContent": "Testing engagements va CLI",
    "SentTime": "2021-05-18T18:43:29.301000+00:00",
    "ReadTime": "2021-05-18T18:43:55.708000+00:00",
    "DeliveryTime": "2021-05-18T18:43:55.265000+00:00"
}

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

Output

PageArn -> (string)

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

EngagementArn -> (string)

The ARN of the engagement that engaged the contact channel.

ContactArn -> (string)

The ARN of the contact that was engaged.

Sender -> (string)

The user that started the engagement.

Subject -> (string)

The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL .

Content -> (string)

The secure content of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL .

PublicSubject -> (string)

The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS .

PublicContent -> (string)

The insecure content of the message that was sent to the contact. Use this field for engagements to SMS .

IncidentId -> (string)

The ARN of the incident that engaged the contact channel.

SentTime -> (timestamp)

The time the engagement was sent to the contact channel.

ReadTime -> (timestamp)

The time that the contact channel acknowledged the engagement.

DeliveryTime -> (timestamp)

The time that the contact channel received the engagement.