[ aws . pinpoint-sms-voice-v2 ]

describe-pools

Description

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

See ‘aws help’ for descriptions of global parameters.

describe-pools is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Pools

Synopsis

  describe-pools
[--pool-ids <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--pool-ids (list)

The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.

(string)

Syntax:

"string" "string" ...

--filters (list)

An array of PoolFilter objects to filter the results.

(structure)

The information for a pool that meets a specified criteria.

Name -> (string)

The name of the attribute to filter on.

Values -> (list)

An array values to filter for.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "status"|"message-type"|"two-way-enabled"|"self-managed-opt-outs-enabled"|"opt-out-list-name"|"shared-routes-enabled"|"deletion-protection-enabled",
    "Values": ["string", ...]
  }
  ...
]

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

Pools -> (list)

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

(structure)

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.

SelfManagedOptOutsEnabled -> (boolean)

When set to false, 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. 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 Amazon Pinpoint 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 -> (timestamp)

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.