PinpointSMSVoiceV2 / Paginator / DescribeRegistrationFieldValues

DescribeRegistrationFieldValues

class PinpointSMSVoiceV2.Paginator.DescribeRegistrationFieldValues

paginator = client.get_paginator('describe_registration_field_values')

paginate(**kwargs)

Creates an iterator that will paginate through responses from PinpointSMSVoiceV2.Client.describe_registration_field_values().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    RegistrationId='string',
    VersionNumber=123,
    SectionPath='string',
    FieldPaths=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• RegistrationId (string) –

  [REQUIRED]

  The unique identifier for the registration.

• VersionNumber (integer) – The version number of the registration.

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

• FieldPaths (list) –

  An array of paths to the registration form field.

  • (string) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'RegistrationArn': 'string',
    'RegistrationId': 'string',
    'VersionNumber': 123,
    'RegistrationFieldValues': [
        {
            'FieldPath': 'string',
            'SelectChoices': [
                'string',
            ],
            'TextValue': 'string',
            'RegistrationAttachmentId': 'string',
            'DeniedReason': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • RegistrationArn (string) –

    The Amazon Resource Name (ARN) for the registration.

  • RegistrationId (string) –

    The unique identifier for the registration.

  • VersionNumber (integer) –

    The current version of the registration.

  • RegistrationFieldValues (list) –

    An array of RegistrationFieldValues objects that contain the values for the requested registration.

    • (dict) –

      Provides the values of the specified field.

      • FieldPath (string) –

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

      • SelectChoices (list) –

        An array of values for the form field.

        • (string) –

      • TextValue (string) –

        The text data for a free form field.

      • RegistrationAttachmentId (string) –

        The unique identifier for the registration attachment.

      • DeniedReason (string) –

        A description of why the registration was denied.