PinpointSMSVoiceV2 / Client / update_pool

update_pool#

PinpointSMSVoiceV2.Client.update_pool(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.update_pool(
    PoolId='string',
    TwoWayEnabled=True|False,
    TwoWayChannelArn='string',
    TwoWayChannelRole='string',
    SelfManagedOptOutsEnabled=True|False,
    OptOutListName='string',
    SharedRoutesEnabled=True|False,
    DeletionProtectionEnabled=True|False
)
Parameters:

  • PoolId (string) –

    [REQUIRED]

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

  • TwoWayEnabled (boolean) – By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

  • 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) – By default this is set to false. When 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.

  • OptOutListName (string) – The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.

  • SharedRoutesEnabled (boolean) – Indicates whether shared routes are enabled for the pool.

  • DeletionProtectionEnabled (boolean) – When set to true the pool can’t be deleted.

Return type:

dict

Returns:

Response Syntax

{
    '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)
}

Response Structure

  • (dict) –

    • PoolArn (string) –

      The ARN of the pool.

    • PoolId (string) –

      The unique identifier of the pool.

    • Status (string) –

      The current status of the pool update request.

    • MessageType (string) –

      The type of message for the pool to use.

    • TwoWayEnabled (boolean) –

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

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

    • OptOutListName (string) –

      The name of the OptOutList associated with the pool.

    • SharedRoutesEnabled (boolean) –

      Indicates whether shared routes are enabled for the pool.

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

Exceptions

  • PinpointSMSVoiceV2.Client.exceptions.ThrottlingException

  • PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException

  • PinpointSMSVoiceV2.Client.exceptions.ResourceNotFoundException

  • PinpointSMSVoiceV2.Client.exceptions.ValidationException

  • PinpointSMSVoiceV2.Client.exceptions.ConflictException

  • PinpointSMSVoiceV2.Client.exceptions.InternalServerException