create-contact-channel¶

Description¶

A contact channel is the method that Incident Manager uses to engage your contact.

Synopsis¶

  create-contact-channel
--contact-id <value>
--name <value>
--type <value>
--delivery-address <value>
[--defer-activation | --no-defer-activation]
[--idempotency-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--contact-id (string)

The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.

--name (string)

The name of the contact channel.

--type (string)

Incident Manager supports three types of contact channels:

SMS

VOICE

EMAIL

Possible values:

SMS

VOICE

EMAIL

--delivery-address (structure)

The details that Incident Manager uses when trying to engage the contact channel. 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

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

Shorthand Syntax:

SimpleAddress=string

JSON Syntax:

{
  "SimpleAddress": "string"
}

--defer-activation | --no-defer-activation (boolean)

If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can’t engage your contact channel until it has been activated.

--idempotency-token (string)

A token ensuring that the operation is called only once with the specified details.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To create a contact channel

Creates a contact channel of type SMS for the contact Akua Mansa. Contact channels can be created of type SMS, EMAIL, or VOICE.

aws ssm-contacts create-contact-channel \
    --contact-id "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" \
    --name "akuas sms-test" \
    --type SMS \
    --delivery-address '{"SimpleAddress": "+15005550199"}'

Output:

{
    "ContactChannelArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/02f506b9-ea5d-4764-af89-2daa793ff024"
}

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

Output¶

ContactChannelArn -> (string)

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

Table of Contents

Feedback

User Guide