PinpointSMSVoiceV2 / Client / update_rcs_agent

update_rcs_agent

PinpointSMSVoiceV2.Client.update_rcs_agent(**kwargs)

Updates the configuration of an existing RCS agent. You can update the opt-out list, deletion protection, two-way messaging settings, and self-managed opt-outs configuration.

See also: AWS API Documentation

Request Syntax

response = client.update_rcs_agent(
    RcsAgentId='string',
    DeletionProtectionEnabled=True|False,
    OptOutListName='string',
    SelfManagedOptOutsEnabled=True|False,
    TwoWayChannelArn='string',
    TwoWayChannelRole='string',
    TwoWayEnabled=True|False,
    TwoWayMediaS3BucketName='string',
    TwoWayMediaS3KeyPrefix='string',
    TwoWayMediaS3Role='string',
    TwoWayRcsEventsEnabled=[
        'string',
    ]
)
Parameters:

  • RcsAgentId (string) –

    [REQUIRED]

    The unique identifier of the RCS agent to update. You can use either the RcsAgentId or RcsAgentArn.

  • DeletionProtectionEnabled (boolean) – By default this is set to false. When set to true the RCS agent can’t be deleted.

  • OptOutListName (string) – The OptOutList to associate with the RCS agent. Valid values are either OptOutListName or OptOutListArn.

  • SelfManagedOptOutsEnabled (boolean) – 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.

  • TwoWayChannelArn (string) – The Amazon Resource Name (ARN) of the two way channel.

  • TwoWayChannelRole (string) – An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

  • TwoWayEnabled (boolean) – By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

  • TwoWayMediaS3BucketName (string) – The name of the S3 bucket where inbound RCS media files are stored. Two-way messaging must be enabled on the agent. To remove the media configuration, pass the sentinel value UNSET_RCS_MEDIA_CONFIGURATION for both this field and TwoWayMediaS3Role.

  • TwoWayMediaS3KeyPrefix (string) – The key prefix used for inbound RCS media objects in the S3 bucket.

  • TwoWayMediaS3Role (string) – The ARN of the IAM role used to write inbound RCS media files to the S3 bucket. The role must have s3:PutObject permission on the bucket and a trust policy allowing sms-voice.amazonaws.com to assume it. To remove the media configuration, pass the sentinel value UNSET_RCS_MEDIA_CONFIGURATION for both this field and TwoWayMediaS3BucketName.

  • TwoWayRcsEventsEnabled (list) –

    The list of RCS event types to enable for two-way messaging. Pass an empty list to disable all event types. The special value ALL enables all current and future event types and must be the sole element if used.

    • (string) –

      RCS event type identifier. Validated at the service layer.

Return type:

dict

Returns:

Response Syntax

{
    'RcsAgentArn': 'string',
    'RcsAgentId': 'string',
    'Status': 'CREATED'|'PENDING'|'TESTING'|'PARTIAL'|'ACTIVE'|'DELETED',
    'CreatedTimestamp': datetime(2015, 1, 1),
    'DeletionProtectionEnabled': True|False,
    'OptOutListName': 'string',
    'SelfManagedOptOutsEnabled': True|False,
    'TwoWayChannelArn': 'string',
    'TwoWayChannelRole': 'string',
    'TwoWayEnabled': True|False,
    'TwoWayMediaS3BucketName': 'string',
    'TwoWayMediaS3KeyPrefix': 'string',
    'TwoWayMediaS3Role': 'string',
    'TwoWayRcsEventsEnabled': [
        'string',
    ]
}

Response Structure

  • (dict) –

    • RcsAgentArn (string) –

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

    • RcsAgentId (string) –

      The unique identifier for the RCS agent.

    • Status (string) –

      The current status of the RCS agent.

    • CreatedTimestamp (datetime) –

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

    • DeletionProtectionEnabled (boolean) –

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

    • OptOutListName (string) –

      The name of the OptOutList associated with the RCS agent.

    • SelfManagedOptOutsEnabled (boolean) –

      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.

    • TwoWayChannelArn (string) –

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

    • TwoWayChannelRole (string) –

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

    • TwoWayEnabled (boolean) –

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

    • TwoWayMediaS3BucketName (string) –

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

    • TwoWayMediaS3KeyPrefix (string) –

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

    • TwoWayMediaS3Role (string) –

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

    • TwoWayRcsEventsEnabled (list) –

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

      • (string) –

        RCS event type identifier. Validated at the service layer.

Exceptions