describeRcsAgentCountryLaunchStatus method

Future<DescribeRcsAgentCountryLaunchStatusResult> describeRcsAgentCountryLaunchStatus({
  1. required String rcsAgentId,
  2. List<CountryLaunchStatusFilter>? filters,
  3. List<String>? isoCountryCodes,
  4. int? maxResults,
  5. String? nextToken,
})

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

May throw AccessDeniedException. May throw InternalServerException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw ValidationException.

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

Parameter filters : An array of CountryLaunchStatusFilter objects to filter the results.

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

Parameter maxResults : The maximum number of results to return per each request.

Parameter 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.

Implementation

Future<DescribeRcsAgentCountryLaunchStatusResult>
    describeRcsAgentCountryLaunchStatus({
  required String rcsAgentId,
  List<CountryLaunchStatusFilter>? filters,
  List<String>? isoCountryCodes,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target': 'PinpointSMSVoiceV2.DescribeRcsAgentCountryLaunchStatus'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'RcsAgentId': rcsAgentId,
      if (filters != null) 'Filters': filters,
      if (isoCountryCodes != null) 'IsoCountryCodes': isoCountryCodes,
      if (maxResults != null) 'MaxResults': maxResults,
      if (nextToken != null) 'NextToken': nextToken,
    },
  );

  return DescribeRcsAgentCountryLaunchStatusResult.fromJson(
      jsonResponse.body);
}