describeRegistrations method

Future<DescribeRegistrationsResult> describeRegistrations({
  1. List<RegistrationFilter>? filters,
  2. int? maxResults,
  3. String? nextToken,
  4. List<String>? registrationIds,
})

Retrieves the specified registrations.

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

Parameter filters : An array of RegistrationFilter objects 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.

Parameter registrationIds : An array of unique identifiers for each registration.

Implementation

Future<DescribeRegistrationsResult> describeRegistrations({
  List<RegistrationFilter>? filters,
  int? maxResults,
  String? nextToken,
  List<String>? registrationIds,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target': 'PinpointSMSVoiceV2.DescribeRegistrations'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (filters != null) 'Filters': filters,
      if (maxResults != null) 'MaxResults': maxResults,
      if (nextToken != null) 'NextToken': nextToken,
      if (registrationIds != null) 'RegistrationIds': registrationIds,
    },
  );

  return DescribeRegistrationsResult.fromJson(jsonResponse.body);
}