Delete Pool

pinpointsmsvoicev2_delete_pool

R Documentation

Deletes an existing pool¶

Description¶

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.

Usage¶

pinpointsmsvoicev2_delete_pool(PoolId)

Arguments¶

PoolId

[required] The PoolId or PoolArn of the pool to delete. You can use describe_pools to find the values for PoolId and PoolArn .

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

Value¶

A list with the following syntax:

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,
  CreatedTimestamp = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax¶

svc$delete_pool(
  PoolId = "string"
)