Skip to content

Updates the configuration of an existing pool

Description

Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.

Usage

pinpointsmsvoicev2_update_pool(PoolId, TwoWayEnabled, TwoWayChannelArn,
  TwoWayChannelRole, SelfManagedOptOutsEnabled, OptOutListName,
  SharedRoutesEnabled, DeletionProtectionEnabled)

Arguments

  • PoolId

    [required] The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.

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

  • TwoWayEnabled

    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

  • TwoWayChannelArn

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

  • TwoWayChannelRole

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

  • SelfManagedOptOutsEnabled

    By default this is set to false. When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS 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

    The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.

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

  • SharedRoutesEnabled

    Indicates whether shared routes are enabled for the pool.

  • DeletionProtectionEnabled

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

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

Request syntax

svc$update_pool(
  PoolId = "string",
  TwoWayEnabled = TRUE|FALSE,
  TwoWayChannelArn = "string",
  TwoWayChannelRole = "string",
  SelfManagedOptOutsEnabled = TRUE|FALSE,
  OptOutListName = "string",
  SharedRoutesEnabled = TRUE|FALSE,
  DeletionProtectionEnabled = TRUE|FALSE
)