Skip to content

DeleteRcsAgentResult

Source code in docs_src/capo_pinpoint_sms_voice_v2/types/delete_rcs_agent_result.py
class DeleteRcsAgentResult(TypedDict, closed=True):
    rcs_agent_arn: "str"
    """<p>The Amazon Resource Name (ARN) of the deleted RCS agent.</p>"""
    rcs_agent_id: "str"
    """<p>The unique identifier for the deleted RCS agent.</p>"""
    status: "capo_pinpoint_sms_voice_v2.types.rcs_agent_status.RcsAgentStatus"
    """<p>The current status of the RCS agent.</p>"""
    created_timestamp: "datetime.datetime"
    """<p>The time when the RCS agent was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>"""
    deletion_protection_enabled: "bool"
    """<p>When set to true deletion protection is enabled. By default this is set to false.</p>"""
    opt_out_list_name: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.opt_out_list_name.OptOutListName"
    ]
    """<p>The name of the OptOutList that was associated with the deleted RCS agent.</p>"""
    self_managed_opt_outs_enabled: "bool"
    """<p>By default this is set to false. 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>"""
    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>"""
    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_rcs_events_enabled: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.rcs_event_type_list.RcsEventTypeList"
    ]
    """<p>The list of RCS event types that were enabled for two-way messaging on the deleted agent.</p>"""

created_timestamp instance-attribute

created_timestamp: datetime

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

deletion_protection_enabled instance-attribute

deletion_protection_enabled: bool

When set to true deletion protection is enabled. By default this is set to false.

opt_out_list_name instance-attribute

opt_out_list_name: NotRequired[OptOutListName]

The name of the OptOutList that was associated with the deleted RCS agent.

rcs_agent_arn instance-attribute

rcs_agent_arn: str

The Amazon Resource Name (ARN) of the deleted RCS agent.

rcs_agent_id instance-attribute

rcs_agent_id: str

The unique identifier for the deleted RCS agent.

self_managed_opt_outs_enabled instance-attribute

self_managed_opt_outs_enabled: bool

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

status instance-attribute

The current status of the RCS agent.

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.

two_way_rcs_events_enabled instance-attribute

two_way_rcs_events_enabled: NotRequired[RcsEventTypeList]

The list of RCS event types that were enabled for two-way messaging on the deleted agent.