Skip to content

RcsAgentInformation

Source code in docs_src/capo_pinpoint_sms_voice_v2/types/rcs_agent_information.py
class RcsAgentInformation(TypedDict, closed=True):
    rcs_agent_arn: "str"
    """<p>The Amazon Resource Name (ARN) of the RCS agent.</p>"""
    rcs_agent_id: "str"
    """<p>The unique identifier for the 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 the RCS agent can't be deleted.</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 RCS agent.</p>"""
    self_managed_opt_outs_enabled: "bool"
    """<p>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>When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.</p>"""
    pool_id: NotRequired["str"]
    """<p>The unique identifier of the pool associated with the RCS agent.</p>"""
    two_way_media_s3_bucket_name: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.two_way_media_s3_bucket_name.TwoWayMediaS3BucketName"
    ]
    """<p>The name of the S3 bucket where inbound RCS media files are stored.</p>"""
    two_way_media_s3_key_prefix: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.two_way_media_s3_key_prefix.TwoWayMediaS3KeyPrefix"
    ]
    """<p>The key prefix used for inbound RCS media objects in the S3 bucket.</p>"""
    two_way_media_s3_role: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.iam_role_arn.IamRoleArn"
    ]
    """<p>The ARN of the IAM role used to write inbound RCS media files to the S3 bucket.</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 enabled for two-way messaging on the agent.</p>"""
    testing_agent: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.testing_agent_information.TestingAgentInformation"
    ]
    """<p>The testing agent information associated with the RCS agent.</p>"""
    messaging_limits: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.messaging_limits.MessagingLimits"
    ]
    """<p>The messaging limits that apply to the RCS agent, including the per-capability send rates.</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 the RCS agent can't be deleted.

messaging_limits instance-attribute

messaging_limits: NotRequired[MessagingLimits]

The messaging limits that apply to the RCS agent, including the per-capability send rates.

opt_out_list_name instance-attribute

opt_out_list_name: NotRequired[OptOutListName]

The name of the OptOutList associated with the RCS agent.

pool_id instance-attribute

pool_id: NotRequired[str]

The unique identifier of the pool associated with the RCS agent.

rcs_agent_arn instance-attribute

rcs_agent_arn: str

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

rcs_agent_id instance-attribute

rcs_agent_id: str

The unique identifier for the RCS agent.

self_managed_opt_outs_enabled instance-attribute

self_managed_opt_outs_enabled: bool

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.

testing_agent instance-attribute

testing_agent: NotRequired[TestingAgentInformation]

The testing agent information associated with 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

When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.

two_way_media_s3_bucket_name instance-attribute

two_way_media_s3_bucket_name: NotRequired[TwoWayMediaS3BucketName]

The name of the S3 bucket where inbound RCS media files are stored.

two_way_media_s3_key_prefix instance-attribute

two_way_media_s3_key_prefix: NotRequired[TwoWayMediaS3KeyPrefix]

The key prefix used for inbound RCS media objects in the S3 bucket.

two_way_media_s3_role instance-attribute

two_way_media_s3_role: NotRequired[IamRoleArn]

The ARN of the IAM role used to write inbound RCS media files to the S3 bucket.

two_way_rcs_events_enabled instance-attribute

two_way_rcs_events_enabled: NotRequired[RcsEventTypeList]

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