PinpointSMSVoiceV2 / Client / describe_pools

describe_pools#

PinpointSMSVoiceV2.Client.describe_pools(**kwargs)#

Retrieves the specified pools or all pools associated with your Amazon Web Services account.

If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don’t specify pool IDs or filters, the output includes information for all pools.

If you specify a pool ID that isn’t valid, 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.describe_pools(
    PoolIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'status'|'message-type'|'two-way-enabled'|'self-managed-opt-outs-enabled'|'opt-out-list-name'|'shared-routes-enabled'|'deletion-protection-enabled'|'two-way-channel-arn',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123,
    Owner='SELF'|'SHARED'
)
Parameters:

  • PoolIds (list) –

    The unique identifier of pools to find. This is an array of strings that can be either the PoolId or 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).

    • (string) –

  • Filters (list) –

    An array of PoolFilter objects to filter the results.

    • (dict) –

      The information for a pool that meets a specified criteria.

      • Name (string) – [REQUIRED]

        The name of the attribute to filter on.

      • Values (list) – [REQUIRED]

        An array values to filter for.

        • (string) –

  • NextToken (string) – The token to be used for the next set of paginated results. You don’t need to supply a value for this field in the initial request.

  • MaxResults (integer) – The maximum number of results to return per each request.

  • Owner (string) – Use SELF to filter the list of Pools to ones your account owns or use SHARED to filter on Pools shared with your account. The Owner and PoolIds parameters can’t be used at the same time.

Return type:

dict

Returns:

Response Syntax

{
    'Pools': [
        {
            '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,
            'DeletionProtectionEnabled': True|False,
            'CreatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Pools (list) –

      An array of PoolInformation objects that contain the details for the requested pools.

      • (dict) –

        The information for a pool in an Amazon Web Services account.

        • PoolArn (string) –

          The Amazon Resource Name (ARN) for the pool.

        • PoolId (string) –

          The unique identifier for the pool.

        • Status (string) –

          The current status of the pool.

        • MessageType (string) –

          The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren’t critical or time-sensitive.

        • TwoWayEnabled (boolean) –

          When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.

        • TwoWayChannelArn (string) –

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

        • TwoWayChannelRole (string) –

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

        • SelfManagedOptOutsEnabled (boolean) –

          When set to false, 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. For more information see Self-managed opt-outs

        • OptOutListName (string) –

          The name of the OptOutList associated with the pool.

        • SharedRoutesEnabled (boolean) –

          Allows you to enable shared routes on your pool.

          By default, this is set to False. If you set this value to True, your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other users. In some countries, such as the United States, senders aren’t allowed to use shared routes and must use a dedicated phone number or short code.

        • DeletionProtectionEnabled (boolean) –

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

        • CreatedTimestamp (datetime) –

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

    • NextToken (string) –

      The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Exceptions