Update Rcs Agent

pinpointsmsvoicev2_update_rcs_agent

R Documentation

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)

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.

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
)

Request syntax¶

svc$update_rcs_agent(
  RcsAgentId = "string",
  DeletionProtectionEnabled = TRUE|FALSE,
  OptOutListName = "string",
  SelfManagedOptOutsEnabled = TRUE|FALSE,
  TwoWayChannelArn = "string",
  TwoWayChannelRole = "string",
  TwoWayEnabled = TRUE|FALSE
)