PinpointSMSVoiceV2 / Client / delete_pool

delete_pool#

PinpointSMSVoiceV2.Client.delete_pool(**kwargs)#

Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool.

If the pool status isn’t active or if deletion protection is enabled, an error is returned.

A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.delete_pool(
    PoolId='string'
)
Parameters:

PoolId (string) –

[REQUIRED]

The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .

Warning

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

Return type:

dict

Returns:

Response Syntax

{
    'PoolArn': 'string',
    'PoolId': 'string',
    'Status': 'CREATING'|'ACTIVE'|'DELETING',
    'MessageType': 'TRANSACTIONAL'|'PROMOTIONAL',
    'TwoWayEnabled': True|False,
    'TwoWayChannelArn': 'string',
    'TwoWayChannelRole': 'string',
    'SelfManagedOptOutsEnabled': True|False,
    'OptOutListName': 'string',
    'SharedRoutesEnabled': True|False,
    'CreatedTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • PoolArn (string) –

      The Amazon Resource Name (ARN) of the pool that was deleted.

    • PoolId (string) –

      The PoolId of the pool that was deleted.

    • Status (string) –

      The current status of the pool.

      • CREATING: The pool is currently being created and isn’t yet available for use.

      • ACTIVE: The pool is active and available for use.

      • DELETING: The pool is being deleted.

    • MessageType (string) –

      The message type that was associated with the deleted pool.

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

    • TwoWayChannelRole (string) –

      An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

    • SelfManagedOptOutsEnabled (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, AWS End User Messaging SMS and Voice 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 that was associated with the deleted pool.

    • SharedRoutesEnabled (boolean) –

      Indicates whether shared routes are enabled for the pool.

    • CreatedTimestamp (datetime) –

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

Exceptions