Skip to content

Updates the configuration of an existing RCS agent

Description

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.

Usage

pinpointsmsvoicev2_update_rcs_agent(RcsAgentId,
  DeletionProtectionEnabled, OptOutListName, SelfManagedOptOutsEnabled,
  TwoWayChannelArn, TwoWayChannelRole, TwoWayEnabled,
  TwoWayMediaS3BucketName, TwoWayMediaS3KeyPrefix, TwoWayMediaS3Role,
  TwoWayRcsEventsEnabled)

Arguments

  • RcsAgentId

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

  • DeletionProtectionEnabled

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

  • OptOutListName

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

  • SelfManagedOptOutsEnabled

    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

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

  • TwoWayChannelRole

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

  • TwoWayEnabled

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

  • TwoWayMediaS3BucketName

    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

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

  • TwoWayMediaS3Role

    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

    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.

Value

A list with the following syntax:

list(
  RcsAgentArn = "string",
  RcsAgentId = "string",
  Status = "CREATED"|"PENDING"|"TESTING"|"PARTIAL"|"ACTIVE"|"DELETED",
  CreatedTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  DeletionProtectionEnabled = TRUE|FALSE,
  OptOutListName = "string",
  SelfManagedOptOutsEnabled = TRUE|FALSE,
  TwoWayChannelArn = "string",
  TwoWayChannelRole = "string",
  TwoWayEnabled = TRUE|FALSE,
  TwoWayMediaS3BucketName = "string",
  TwoWayMediaS3KeyPrefix = "string",
  TwoWayMediaS3Role = "string",
  TwoWayRcsEventsEnabled = list(
    "string"
  )
)

Request syntax

svc$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 = list(
    "string"
  )
)