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 ]

associate-origination-identity

Description

Associates the specified origination identity with a pool.

If the origination identity is a phone number and is already associated with another pool, an Error is returned. A sender ID can be associated with multiple pools.

If the origination identity configuration doesn't match the pool's configuration, an Error is returned.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  associate-origination-identity
--pool-id <value>
--origination-identity <value>
--iso-country-code <value>
[--client-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--pool-id (string)

The pool to update with the new Identity. This value can be either the PoolId or PoolArn, and you can find these values using DescribePools .

--origination-identity (string)

The origination identity to use, such as PhoneNumberId, PhoneNumberArn, SenderId, or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn, while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

--iso-country-code (string)

The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the origination identity.

--client-token (string)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

--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 Amazon Resource Name (ARN) of the pool that is now associated with the origination identity.

PoolId -> (string)

The PoolId of the pool that is now associated with the origination identity.

OriginationIdentityArn -> (string)

The PhoneNumberArn or SenderIdArn of the origination identity.

OriginationIdentity -> (string)

The PhoneNumberId or SenderId of the origination identity.

IsoCountryCode -> (string)

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.