Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeRcsAgentCountryLaunchStatus

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

Request Syntax


{
   "Filters": [ 
      { 
         "Name": "string",
         "Values": [ "string" ]
      }
   ],
   "IsoCountryCodes": [ "string" ],
   "MaxResults": number,
   "NextToken": "string",
   "RcsAgentId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Filters

An array of CountryLaunchStatusFilter objects to filter the results.

Type: Array of CountryLaunchStatusFilter objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Required: No

IsoCountryCodes

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

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 300 items.

Length Constraints: Fixed length of 2.

Pattern: [A-Z]{2}

Required: No

MaxResults

The maximum number of results to return per each request.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .+

Required: No

RcsAgentId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [A-Za-z0-9_:/-]+

Required: Yes

Response Syntax


{
   "CountryLaunchStatus": [ 
      { 
         "CarrierStatus": [ 
            { 
               "CarrierName": "string",
               "Status": "string"
            }
         ],
         "IsoCountryCode": "string",
         "RcsPlatformId": "string",
         "RegistrationId": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string",
   "RcsAgentArn": "string",
   "RcsAgentId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CountryLaunchStatus

An array of CountryLaunchStatusInformation objects that contain the per-country launch status details.

Type: Array of CountryLaunchStatusInformation objects

NextToken

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .+

RcsAgentArn

The Amazon Resource Name (ARN) of the RCS agent.

Type: String

RcsAgentId

The unique identifier for the RCS agent.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

The request was denied because you don't have sufficient permissions to access the resource.

Reason: The reason for the exception.

HTTP Status Code: 400

InternalServerException

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

RequestId: The unique identifier of the request.

HTTP Status Code: 500

ResourceNotFoundException

A requested resource couldn't be found.

ResourceId: The unique identifier of the resource.
ResourceType: The type of resource that caused the exception.

HTTP Status Code: 400

ThrottlingException

An error that occurred because too many requests were sent during a certain amount of time.

HTTP Status Code: 400

ValidationException

A validation exception for a field.

Fields: The field that failed validation.
Reason: The reason for the exception.

HTTP Status Code: 400