update-contact-channel¶

Description¶

Updates a contact’s contact channel.

Synopsis¶

  update-contact-channel
--contact-channel-id <value>
[--name <value>]
[--delivery-address <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--contact-channel-id (string)

The Amazon Resource Name (ARN) of the contact channel you want to update.

--name (string)

The name of the contact channel.

--delivery-address (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

Shorthand Syntax:

SimpleAddress=string

JSON Syntax:

{
  "SimpleAddress": "string"
}

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

The following update-contact-channel example updates the name and delivery address of a contact channel.

aws ssm-contacts update-contact-channel \
    --contact-channel-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad" \
    --name "akuas voice channel" \
    --delivery-address '{"SimpleAddress": "+15005550198"}'

This command produces no output.

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

Output¶

None

Table of Contents

Feedback

User Guide