Skip to content

UpdatePoolResult

Source code in docs_src/capo_pinpoint_sms_voice_v2/types/update_pool_result.py
class UpdatePoolResult(TypedDict, closed=True):
    pool_arn: NotRequired["str"]
    """<p>The ARN of the pool.</p>"""
    pool_id: NotRequired["str"]
    """<p>The unique identifier of the pool.</p>"""
    status: NotRequired["capo_pinpoint_sms_voice_v2.types.pool_status.PoolStatus"]
    """<p>The current status of the pool update request.</p>"""
    message_type: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.message_type.MessageType"
    ]
    """<p>The type of message for the pool to use.</p>"""
    two_way_enabled: "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: "bool"
    """<p>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.OptOutListName"
    ]
    """<p>The name of the OptOutList associated with the pool.</p>"""
    shared_routes_enabled: "bool"
    """<p>Indicates whether shared routes are enabled for the pool.</p>"""
    deletion_protection_enabled: "bool"
    """<p>When set to true the pool can't be deleted.</p>"""
    created_timestamp: NotRequired["datetime.datetime"]
    """<p>The time when the pool was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>"""

created_timestamp instance-attribute

created_timestamp: NotRequired[datetime]

The time when the pool was created, in UNIX epoch time format.

deletion_protection_enabled instance-attribute

deletion_protection_enabled: bool

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

message_type instance-attribute

message_type: NotRequired[MessageType]

The type of message for the pool to use.

opt_out_list_name instance-attribute

opt_out_list_name: NotRequired[OptOutListName]

The name of the OptOutList associated with the pool.

pool_arn instance-attribute

pool_arn: NotRequired[str]

The ARN of the pool.

pool_id instance-attribute

pool_id: NotRequired[str]

The unique identifier of the pool.

self_managed_opt_outs_enabled instance-attribute

self_managed_opt_outs_enabled: bool

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: bool

Indicates whether shared routes are enabled for the pool.

status instance-attribute

status: NotRequired[PoolStatus]

The current status of the pool update request.

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: bool

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