[ aws . pinpoint-sms-voice-v2 ]

disassociate-origination-identity

Description

Removes the specified origination identity from an existing pool.

If the origination identity isn’t associated with the specified pool, an Error is returned.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--pool-id (string)

The unique identifier for the pool to disassociate with the origination identity. This value can be either the PoolId or PoolArn.

--origination-identity (string)

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

--iso-country-code (string)

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

--client-token (string)

Unique, case-sensitive identifier 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 | --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.

Output

PoolArn -> (string)

The Amazon Resource Name (ARN) of the pool.

PoolId -> (string)

The PoolId of the pool no longer 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.