Describe Pools

pinpointsmsvoicev2_describe_pools

R Documentation

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

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.

Usage

pinpointsmsvoicev2_describe_pools(PoolIds, Filters, NextToken,
  MaxResults)

Arguments

PoolIds

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

Filters

An array of PoolFilter objects to filter the results.

NextToken

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

The maximum number of results to return per each request.

Value

A list with the following syntax:

list(
  Pools = list(
    list(
      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 = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_pools(
  PoolIds = list(
    "string"
  ),
  Filters = list(
    list(
      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 = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  MaxResults = 123
)