Skip to content

UpdatePoolRequest

Source code in docs_src/capo_pinpoint_sms_voice_v2/types/update_pool_request.py
class UpdatePoolRequest(TypedDict, closed=True):
    pool_id: "capo_pinpoint_sms_voice_v2.types.pool_id_or_arn.PoolIdOrArn"
    """<p>The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.</p> <important> <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p> </important>"""
    two_way_enabled: NotRequired["bool"]
    """<p>By default this is set to false. When set to true you can receive incoming text messages from your end recipients.</p>"""
    two_way_channel_arn: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.two_way_channel_arn.TwoWayChannelArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the two way channel.</p>"""
    two_way_channel_role: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.iam_role_arn.IamRoleArn"
    ]
    """<p>An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.</p>"""
    self_managed_opt_outs_enabled: NotRequired["bool"]
    """<p>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.</p>"""
    opt_out_list_name: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.opt_out_list_name_or_arn.OptOutListNameOrArn"
    ]
    """<p>The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.</p> <important> <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p> </important>"""
    shared_routes_enabled: NotRequired["bool"]
    """<p>Indicates whether shared routes are enabled for the pool.</p>"""
    deletion_protection_enabled: NotRequired["bool"]
    """<p>When set to true the pool can't be deleted.</p>"""

deletion_protection_enabled instance-attribute

deletion_protection_enabled: NotRequired[bool]

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

opt_out_list_name instance-attribute

opt_out_list_name: NotRequired[OptOutListNameOrArn]

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

pool_id instance-attribute

pool_id: PoolIdOrArn

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

self_managed_opt_outs_enabled instance-attribute

self_managed_opt_outs_enabled: NotRequired[bool]

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.

shared_routes_enabled instance-attribute

shared_routes_enabled: NotRequired[bool]

Indicates whether shared routes are enabled for the pool.

two_way_channel_arn instance-attribute

two_way_channel_arn: NotRequired[TwoWayChannelArn]

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

two_way_channel_role instance-attribute

two_way_channel_role: NotRequired[IamRoleArn]

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

two_way_enabled instance-attribute

two_way_enabled: NotRequired[bool]

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