describeRegistrationFieldValues method

Future<DescribeRegistrationFieldValuesResult> describeRegistrationFieldValues({
  1. required String registrationId,
  2. List<String>? fieldPaths,
  3. int? maxResults,
  4. String? nextToken,
  5. String? sectionPath,
  6. int? versionNumber,
})

Retrieves the specified registration field values.

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

Parameter registrationId : The unique identifier for the registration.

Parameter fieldPaths : An array of paths to the registration form field.

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 sectionPath : The path to the section of the registration.

Parameter versionNumber : The version number of the registration.

Implementation

Future<DescribeRegistrationFieldValuesResult>
    describeRegistrationFieldValues({
  required String registrationId,
  List<String>? fieldPaths,
  int? maxResults,
  String? nextToken,
  String? sectionPath,
  int? versionNumber,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  _s.validateNumRange(
    'versionNumber',
    versionNumber,
    1,
    100000,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target': 'PinpointSMSVoiceV2.DescribeRegistrationFieldValues'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'RegistrationId': registrationId,
      if (fieldPaths != null) 'FieldPaths': fieldPaths,
      if (maxResults != null) 'MaxResults': maxResults,
      if (nextToken != null) 'NextToken': nextToken,
      if (sectionPath != null) 'SectionPath': sectionPath,
      if (versionNumber != null) 'VersionNumber': versionNumber,
    },
  );

  return DescribeRegistrationFieldValuesResult.fromJson(jsonResponse.body);
}