v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

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.

post/#X-Amz-Target=PinpointSMSVoiceV2.UpdateRcsAgent

Headers

X-Amz-Target'PinpointSMSVoiceV2.UpdateRcsAgent' required

Request body

RcsAgentIdstring required

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

DeletionProtectionEnabledboolean

By default this is set to false. When set to true the RCS agent can't be deleted.

OptOutListNamestring

The OptOutList to associate with the RCS agent. Valid values are either OptOutListName or OptOutListArn.

SelfManagedOptOutsEnabledboolean

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.

TwoWayChannelArnstring

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

TwoWayChannelRolestring

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

TwoWayEnabledboolean

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

TwoWayMediaS3BucketNamestring

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 <code>UNSET_RCS_MEDIA_CONFIGURATION</code> for both this field and TwoWayMediaS3Role.

TwoWayMediaS3KeyPrefixstring

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

TwoWayMediaS3Rolestring

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. To remove the media configuration, pass the sentinel value <code>UNSET_RCS_MEDIA_CONFIGURATION</code> for both this field and TwoWayMediaS3BucketName.

TwoWayRcsEventsEnabledRcsEventType[]

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

Response

Success

RcsAgentArnstring required

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

RcsAgentIdstring required

The unique identifier for the RCS agent.

Status'CREATED' | 'PENDING' | 'TESTING' | 'PARTIAL' | 'ACTIVE' | 'DELETED' required

The current status of the RCS agent.

CreatedTimestampstring date-time required

The time when the RCS agent was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.

DeletionProtectionEnabledboolean required

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

OptOutListNamestring

The name of the OptOutList associated with the RCS agent.

SelfManagedOptOutsEnabledboolean required

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.

TwoWayChannelArnstring

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

TwoWayChannelRolestring

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

TwoWayEnabledboolean required

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

TwoWayMediaS3BucketNamestring

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

TwoWayMediaS3KeyPrefixstring

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

TwoWayMediaS3Rolestring

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

TwoWayRcsEventsEnabledRcsEventType[]

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