describeRegistrationFieldDefinitions method

Future<DescribeRegistrationFieldDefinitionsResult> describeRegistrationFieldDefinitions({
  1. required String registrationType,
  2. List<String>? fieldPaths,
  3. int? maxResults,
  4. String? nextToken,
  5. String? sectionPath,
})

Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.

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

Parameter registrationType : The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

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.

Implementation

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

  return DescribeRegistrationFieldDefinitionsResult.fromJson(
      jsonResponse.body);
}