:doc:`PinpointSMSVoiceV2 <../../pinpoint-sms-voice-v2>` / Paginator / DescribeRegistrationFieldDefinitions

************************************
DescribeRegistrationFieldDefinitions
************************************



.. py:class:: PinpointSMSVoiceV2.Paginator.DescribeRegistrationFieldDefinitions

  ::

    
    paginator = client.get_paginator('describe_registration_field_definitions')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`PinpointSMSVoiceV2.Client.describe_registration_field_definitions`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeRegistrationFieldDefinitions>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          RegistrationType='string',
          SectionPath='string',
          FieldPaths=[
              'string',
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type RegistrationType: string
    :param RegistrationType: **[REQUIRED]** 

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

      

    
    :type SectionPath: string
    :param SectionPath: 

      The path to the section of the registration.

      

    
    :type FieldPaths: list
    :param FieldPaths: 

      An array of paths to the registration form field.

      

    
      - *(string) --* 

      
  
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: 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'
                    }
                },
            ],
            
        }
        
      **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.

                
          
        
      
    