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 . pinpoint-sms-voice-v2 ]

update-pool

Description

Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn , enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-pool
--pool-id <value>
[--two-way-enabled | --no-two-way-enabled]
[--two-way-channel-arn <value>]
[--self-managed-opt-outs-enabled | --no-self-managed-opt-outs-enabled]
[--opt-out-list-name <value>]
[--shared-routes-enabled | --no-shared-routes-enabled]
[--deletion-protection-enabled | --no-deletion-protection-enabled]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--pool-id (string)

The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.

--two-way-enabled | --no-two-way-enabled (boolean)

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

--two-way-channel-arn (string)

The Amazon Resource Name (ARN) of the two way channel.

--self-managed-opt-outs-enabled | --no-self-managed-opt-outs-enabled (boolean)

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

--opt-out-list-name (string)

The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.

--shared-routes-enabled | --no-shared-routes-enabled (boolean)

Indicates whether shared routes are enabled for the pool.

--deletion-protection-enabled | --no-deletion-protection-enabled (boolean)

When set to true the pool can't be deleted.

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

Output

PoolArn -> (string)

The ARN of the pool.

PoolId -> (string)

The unique identifier of the pool.

Status -> (string)

The current status of the pool update request.

MessageType -> (string)

The type of message for the pool to use.

TwoWayEnabled -> (boolean)

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

TwoWayChannelArn -> (string)

The Amazon Resource Name (ARN) of the two way channel.

SelfManagedOptOutsEnabled -> (boolean)

When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

OptOutListName -> (string)

The name of the OptOutList associated with the pool.

SharedRoutesEnabled -> (boolean)

Indicates whether shared routes are enabled for the pool.

DeletionProtectionEnabled -> (boolean)

When set to true the pool can't be deleted.

CreatedTimestamp -> (timestamp)

The time when the pool was created, in UNIX epoch time format.