:doc:`PinpointSMSVoiceV2 <../../pinpoint-sms-voice-v2>` / Client / describe_registration_section_definitions

*****************************************
describe_registration_section_definitions
*****************************************



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeRegistrationSectionDefinitions>`_  


  **Request Syntax**
  ::

    response = client.describe_registration_section_definitions(
        RegistrationType='string',
        SectionPaths=[
            'string',
        ],
        NextToken='string',
        MaxResults=123
    )
    
  :type RegistrationType: string
  :param RegistrationType: **[REQUIRED]** 

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

    

  
  :type SectionPaths: list
  :param SectionPaths: 

    An array of paths for the registration form section.

    

  
    - *(string) --* 

    

  :type NextToken: string
  :param NextToken: 

    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.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return per each request.

    

  
  
  :rtype: 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**
  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.ThrottlingException`

  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.ValidationException`

  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.InternalServerException`

  