PinpointSMSVoiceV2 / Client / describe_registration_field_definitions

describe_registration_field_definitions

PinpointSMSVoiceV2.Client.describe_registration_field_definitions(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_registration_field_definitions(
    RegistrationType='string',
    SectionPath='string',
    FieldPaths=[
        'string',
    ],
    NextToken='string',
    MaxResults=123
)

Parameters:

• RegistrationType (string) –

  [REQUIRED]

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

• SectionPath (string) – The path to the section of the registration.

• FieldPaths (list) –

  An array of paths to the registration form field.

  • (string) –

• NextToken (string) – 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.

• MaxResults (integer) – The maximum number of results to return per each request.

Return type:

dict

Returns:

Response Syntax

{
    'RegistrationType': 'string',
    'RegistrationFieldDefinitions': [
        {
            'SectionPath': 'string',
            'FieldPath': 'string',
            'FieldType': 'SELECT'|'TEXT'|'ATTACHMENT',
            'FieldRequirement': 'REQUIRED'|'CONDITIONAL'|'OPTIONAL',
            'SelectValidation': {
                'MinChoices': 123,
                'MaxChoices': 123,
                'Options': [
                    'string',
                ]
            },
            'TextValidation': {
                'MinLength': 123,
                'MaxLength': 123,
                'Pattern': 'string'
            },
            'DisplayHints': {
                'Title': 'string',
                'ShortDescription': 'string',
                'LongDescription': 'string',
                'DocumentationTitle': 'string',
                'DocumentationLink': 'string',
                'SelectOptionDescriptions': [
                    {
                        'Option': 'string',
                        'Title': 'string',
                        'Description': 'string'
                    },
                ],
                'TextValidationDescription': 'string',
                'ExampleTextValue': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • RegistrationType (string) –

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

  • RegistrationFieldDefinitions (list) –

    An array of RegistrationFieldDefinitions objects that contain the details for the requested fields.

    • (dict) –

      Provides a description of the specified field.

      • SectionPath (string) –

        The section path of the field.

      • FieldPath (string) –

        The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.

      • FieldType (string) –

        The type of field.

      • FieldRequirement (string) –

        Specifies if the field for the registration form is required, conditional or optional.

      • SelectValidation (dict) –

        The validation rules for a select field.

        • MinChoices (integer) –

          The minimum number of choices for the select.

        • MaxChoices (integer) –

          The maximum number of choices for the select.

        • Options (list) –

          An array of strings for the possible selection options.

          • (string) –

      • TextValidation (dict) –

        The validation rules for a text field.

        • MinLength (integer) –

          The minimum number of characters for the text field.

        • MaxLength (integer) –

          The maximum number of characters for the text field.

        • Pattern (string) –

          The regular expression used to validate the text field.

      • DisplayHints (dict) –

        An array of RegistrationFieldDisplayHints objects for the field.

        • Title (string) –

          The title of the display hint.

        • ShortDescription (string) –

          A short description of the display hint.

        • LongDescription (string) –

          A full description of the display hint.

        • DocumentationTitle (string) –

          The title of the document the display hint is associated with.

        • DocumentationLink (string) –

          The link to the document the display hint is associated with.

        • SelectOptionDescriptions (list) –

          An array of SelectOptionDescription objects.

          • (dict) –

            A description of each select option.

            • Option (string) –

              The value of the option.

            • Title (string) –

              The title of the select option.

            • Description (string) –

              A description of the option meaning.

        • TextValidationDescription (string) –

          The validation rules for the text field.

        • ExampleTextValue (string) –

          Example text of what the value of a field should contain.

  • NextToken (string) –

    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.

Exceptions

• PinpointSMSVoiceV2.Client.exceptions.ThrottlingException

• PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException

• PinpointSMSVoiceV2.Client.exceptions.ValidationException

• PinpointSMSVoiceV2.Client.exceptions.InternalServerException