CreateRcsAgentResult ¶

class CreateRcsAgentResult(TypedDict, closed=True):
    rcs_agent_arn: "str"
    """<p>The Amazon Resource Name (ARN) of the newly created 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>"""
    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 associated with 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>"""
    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_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. The role must have <code>s3:PutObject</code> permission on the bucket and a trust policy allowing <code>sms-voice.amazonaws.com</code> to assume it.</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>"""
    tags: NotRequired["capo_pinpoint_sms_voice_v2.types.tag_list.TagList"]
    """<p>An array of tags (key and value pairs) associated with the RCS agent.</p>"""