[ aws . ssm-contacts ]

describe-engagement

Description

Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-engagement
--engagement-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--engagement-id (string)

The Amazon Resource Name (ARN) of the engagement you want the details of.

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

--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 describe the details of an engagement

The following describe-engagement example lists the details of an engagement to a contact or escalation plan. The subject and content are sent to the contact channels.

aws ssm-contacts describe-engagement \
    --engagement-id "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"

Output:

{
    "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
    "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356",
    "Sender": "cli",
    "Subject": "cli-test",
    "Content": "Testing engagements via CLI",
    "PublicSubject": "cli-test",
    "PublicContent": "Testing engagements va CLI",
    "StartTime": "2021-05-18T18:25:41.151000+00:00"
}

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

Output

ContactArn -> (string)

The ARN of the escalation plan or contacts involved in the engagement.

EngagementArn -> (string)

The ARN of the engagement.

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 in which the engagement occurred.

StartTime -> (timestamp)

The time that the engagement started.

StopTime -> (timestamp)

The time that the engagement ended.