Describe Rcs Agents

pinpointsmsvoicev2_describe_rcs_agents

R Documentation

Retrieves the specified RCS agents or all RCS agents associated with your Amazon Web Services account¶

Description¶

Retrieves the specified RCS agents or all RCS agents associated with your Amazon Web Services account.

If you specify RCS agent IDs, the output includes information for only the specified RCS agents. If you specify filters, the output includes information for only those RCS agents that meet the filter criteria. If you don't specify RCS agent IDs or filters, the output includes information for all RCS agents.

Usage¶

pinpointsmsvoicev2_describe_rcs_agents(RcsAgentIds, Owner, Filters,
  NextToken, MaxResults)

Arguments¶

RcsAgentIds

An array of unique identifiers for the RCS agents. This is an array of strings that can be either the RcsAgentId or RcsAgentArn.

Owner

Use SELF to filter the list of RCS agents to ones your account owns or use SHARED to filter on RCS agents shared with your account. The Owner and RcsAgentIds parameters can't be used at the same time.

Filters

An array of RcsAgentFilter objects to filter the results.

NextToken

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

MaxResults

The maximum number of results to return per each request.

Value¶

A list with the following syntax:

list(
  RcsAgents = list(
    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,
      PoolId = "string",
      TestingAgent = list(
        Status = "CREATED"|"PENDING"|"ACTIVE",
        TestingAgentId = "string",
        RegistrationId = "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_rcs_agents(
  RcsAgentIds = list(
    "string"
  ),
  Owner = "SELF"|"SHARED",
  Filters = list(
    list(
      Name = "status"|"two-way-enabled"|"self-managed-opt-outs-enabled"|"opt-out-list-name"|"deletion-protection-enabled"|"two-way-channel-arn",
      Values = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  MaxResults = 123
)