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

***********************************
DescribeRegistrationTypeDefinitions
***********************************



.. py:class:: PinpointSMSVoiceV2.Paginator.DescribeRegistrationTypeDefinitions

  ::

    
    paginator = client.get_paginator('describe_registration_type_definitions')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          RegistrationTypes=[
              'string',
          ],
          Filters=[
              {
                  'Name': 'supported-association-resource-type'|'supported-association-iso-country-code',
                  'Values': [
                      'string',
                  ]
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type RegistrationTypes: list
    :param RegistrationTypes: 

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

      

    
      - *(string) --* 

      
  
    :type Filters: list
    :param Filters: 

      An array of RegistrationFilter objects to filter the results.

      

    
      - *(dict) --* 

        The filter definition for filtering registration types that meets a specified criteria.

        

      
        - **Name** *(string) --* **[REQUIRED]** 

          The name of the attribute to filter on.

          

        
        - **Values** *(list) --* **[REQUIRED]** 

          An array of values to filter on.

          

        
          - *(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**

      
      ::

        {
            'RegistrationTypeDefinitions': [
                {
                    'RegistrationType': 'string',
                    'SupportedAssociations': [
                        {
                            'ResourceType': 'string',
                            'IsoCountryCode': 'string',
                            'AssociationBehavior': 'ASSOCIATE_BEFORE_SUBMIT'|'ASSOCIATE_ON_APPROVAL'|'ASSOCIATE_AFTER_COMPLETE',
                            'DisassociationBehavior': 'DISASSOCIATE_ALL_CLOSES_REGISTRATION'|'DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION'|'DELETE_REGISTRATION_DISASSOCIATES'
                        },
                    ],
                    'DisplayHints': {
                        'Title': 'string',
                        'ShortDescription': 'string',
                        'LongDescription': 'string',
                        'DocumentationTitle': 'string',
                        'DocumentationLink': 'string'
                    }
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **RegistrationTypeDefinitions** *(list) --* 

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

          
          

          - *(dict) --* 

            Provides information on the supported registration type.

            
            

            - **RegistrationType** *(string) --* 

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

              
            

            - **SupportedAssociations** *(list) --* 

              The supported association behavior for the registration type.

              
              

              - *(dict) --* 

                The processing rules for when a registration can be associated with an origination identity and disassociated from an origination identity.

                
                

                - **ResourceType** *(string) --* 

                  Defines the behavior of when an origination identity and registration can be associated with each other.

                  
                

                - **IsoCountryCode** *(string) --* 

                  The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

                  
                

                - **AssociationBehavior** *(string) --* 

                  The association behavior.

                   

                  
                  * ``ASSOCIATE_BEFORE_SUBMIT`` The origination identity has to be supplied when creating a registration.
                   
                  * ``ASSOCIATE_ON_APPROVAL`` This applies to all sender ID registrations. The sender ID will be automatically provisioned once the registration is approved.
                   
                  * ``ASSOCIATE_AFTER_COMPLETE`` This applies to phone number registrations when you must complete a registration first, then associate one or more phone numbers later. For example 10DLC campaigns and long codes.
                  

                  
                

                - **DisassociationBehavior** *(string) --* 

                  The disassociation behavior.

                   

                  
                  * ``DISASSOCIATE_ALL_CLOSES_REGISTRATION`` All origination identities must be disassociated from the registration before the registration can be closed.
                   
                  * ``DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION`` All origination identities must be disassociated from the registration before the registration can be deleted.
                   
                  * ``DELETE_REGISTRATION_DISASSOCIATES`` The registration can be deleted and all origination identities will be disasscoiated.
                  

                  
            
          
            

            - **DisplayHints** *(dict) --* 

              Provides help information on 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.

                
          
        
      
    