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 ]

get-contact

Description

Retrieves information about the specified contact or escalation plan.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-contact
--contact-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--contact-id (string)

The Amazon Resource Name (ARN) of the contact or escalation plan.

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

Example 1: To describe a contact plan

The following get-contact example describes a contact.

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

Output:

{
    "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
    "Alias": "akuam",
    "DisplayName": "Akua Mansa",
    "Type": "PERSONAL",
    "Plan": {
        "Stages": [
            {
                "DurationInMinutes": 5,
                "Targets": [
                    {
                        "ChannelTargetInfo": {
                            "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65",
                            "RetryIntervalInMinutes": 1
                        }
                    }
                ]
            },
            {
                "DurationInMinutes": 5,
                "Targets": [
                    {
                        "ChannelTargetInfo": {
                            "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad",
                            "RetryIntervalInMinutes": 1
                        }
                    }
                ]
            },
            {
                "DurationInMinutes": 5,
                "Targets": [
                    {
                        "ChannelTargetInfo": {
                            "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a",
                            "RetryIntervalInMinutes": 1
                        }
                    }
                ]
            }
        ]
    }
}

Example 2: To describe an escalation plan

The following get-contact example describes an escalation plan.

aws ssm-contacts get-contact \
--contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation"

Output:

{
    "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
    "Alias": "example_escalation",
    "DisplayName": "Example Escalation",
    "Type": "ESCALATION",
    "Plan": {
        "Stages": [
            {
                "DurationInMinutes": 5,
                "Targets": [
                    {
                        "ContactTargetInfo": {
                            "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
                            "IsEssential": true
                        }
                    }
                ]
            },
            {
                "DurationInMinutes": 5,
                "Targets": [
                    {
                        "ContactTargetInfo": {
                            "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr",
                            "IsEssential": false
                        }
                    }
                ]
            },
            {
                "DurationInMinutes": 0,
                "Targets": [
                    {
                        "ContactTargetInfo": {
                            "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi",
                            "IsEssential": false
                        }
                    }
                ]
            }
        ]
    }
}

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

Output

ContactArn -> (string)

The ARN of the contact or escalation plan.

Alias -> (string)

The alias of the contact or escalation plan. The alias is unique and identifiable.

DisplayName -> (string)

The full name of the contact or escalation plan.

Type -> (string)

The type of contact, either PERSONAL or ESCALATION .

Plan -> (structure)

Details about the specific timing or stages and targets of the escalation plan or engagement plan.

Stages -> (list)

A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.

(structure)

A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.

DurationInMinutes -> (integer)

The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.

Targets -> (list)

The contacts or contact methods that the escalation plan or engagement plan is engaging.

(structure)

The contact or contact channel that's being engaged.

ChannelTargetInfo -> (structure)

Information about the contact channel Incident Manager is engaging.

ContactChannelId -> (string)

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

RetryIntervalInMinutes -> (integer)

The number of minutes to wait to retry sending engagement in the case the engagement initially fails.

ContactTargetInfo -> (structure)

Information about the contact that Incident Manager is engaging.

ContactId -> (string)

The Amazon Resource Name (ARN) of the contact.

IsEssential -> (boolean)

A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.