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

Description

List details about a specific contact channel.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

--contact-channel-id (string)

The Amazon Resource Name (ARN) of the contact channel you want information about.

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

The following get-contact-channel example lists the details of a contact channel.

aws ssm-contacts get-contact-channel \
    --contact-channel-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d"

Output:

{
    "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
    "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d",
    "Name": "akuas sms",
    "Type": "SMS",
    "DeliveryAddress": {
        "SimpleAddress": "+15005550199"
    },
    "ActivationStatus": "ACTIVATED"
}

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

Output

ContactArn -> (string)

The ARN of the contact that the channel belongs to.

ContactChannelArn -> (string)

The ARN of the contact channel.

Name -> (string)

The name of the contact channel

Type -> (string)

The type of contact channel. The type is SMS , VOICE , or EMAIL .

DeliveryAddress -> (structure)

The details that Incident Manager uses when trying to engage the contact channel.

SimpleAddress -> (string)

The format is dependent on the type of the contact channel. The following are the expected formats:

  • SMS - '+' followed by the country code and phone number
  • VOICE - '+' followed by the country code and phone number
  • EMAIL - any standard email format

ActivationStatus -> (string)

A Boolean value indicating if the contact channel has been activated or not.