Skip to content

Delete Rcs Agent

pinpointsmsvoicev2_delete_rcs_agent R Documentation

Deletes an existing RCS agent

Description

Deletes an existing RCS agent. If deletion protection is enabled, an error is returned.

Usage

pinpointsmsvoicev2_delete_rcs_agent(RcsAgentId)

Arguments

RcsAgentId

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

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$delete_rcs_agent(
  RcsAgentId = "string"
)