Skip to content

Describe Rcs Agent Country Launch Status

pinpointsmsvoicev2_describe_rcs_agent_country_launch_status R Documentation

Retrieves the per-country launch status of an RCS agent, including carrier-level details for each country

Description

Retrieves the per-country launch status of an RCS agent, including carrier-level details for each country.

Usage

pinpointsmsvoicev2_describe_rcs_agent_country_launch_status(RcsAgentId,
  IsoCountryCodes, Filters, MaxResults, NextToken)

Arguments

RcsAgentId

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

IsoCountryCodes

An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, to filter the results.

Filters

An array of CountryLaunchStatusFilter objects to filter the results.

MaxResults

The maximum number of results to return per each request.

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.

Value

A list with the following syntax:

list(
  RcsAgentId = "string",
  RcsAgentArn = "string",
  CountryLaunchStatus = list(
    list(
      IsoCountryCode = "string",
      Status = "CREATED"|"PENDING"|"PARTIAL"|"ACTIVE"|"REJECTED",
      RcsPlatformId = "string",
      RegistrationId = "string",
      CarrierStatus = list(
        list(
          CarrierName = "string",
          Status = "PENDING"|"ACTIVE"|"REJECTED"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_rcs_agent_country_launch_status(
  RcsAgentId = "string",
  IsoCountryCodes = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "country-launch-status",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string"
)