PinpointSMSVoiceV2 / Client / describe_registration_section_definitions

describe_registration_section_definitions#

PinpointSMSVoiceV2.Client.describe_registration_section_definitions(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.describe_registration_section_definitions(
    RegistrationType='string',
    SectionPaths=[
        '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.

  • SectionPaths (list) –

    An array of paths for the registration form section.

    • (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',
    'RegistrationSectionDefinitions': [
        {
            'SectionPath': 'string',
            'DisplayHints': {
                'Title': 'string',
                'ShortDescription': 'string',
                'LongDescription': 'string',
                'DocumentationTitle': 'string',
                'DocumentationLink': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • RegistrationType (string) –

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

    • RegistrationSectionDefinitions (list) –

      An array of RegistrationSectionDefinition objects.

      • (dict) –

        Provides information on the specified section definition.

        • SectionPath (string) –

          The path to the section of the registration.

        • DisplayHints (dict) –

          The path to the section of the registration.

          • 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.

    • 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