Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

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

post/#X-Amz-Target=PinpointSMSVoiceV2.DescribeRegistrationFieldDefinitions

Headers

X-Amz-Target'PinpointSMSVoiceV2.DescribeRegistrationFieldDefinitions' required

Request body

RegistrationTypestring required

The type of registration form. The list of <b>RegistrationTypes</b> can be found using the <a>DescribeRegistrationTypeDefinitions</a> action.

SectionPathstring

The path to the section of the registration.

FieldPathsFieldPath[]

An array of paths to the registration form field.

NextTokenstring

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.

MaxResultsinteger

The maximum number of results to return per each request.

Response

Success

RegistrationTypestring required

The type of registration form. The list of <b>RegistrationTypes</b> can be found using the <a>DescribeRegistrationTypeDefinitions</a> action.

NextTokenstring

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.