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

*********************
DescribeRegistrations
*********************



.. py:class:: PinpointSMSVoiceV2.Paginator.DescribeRegistrations

  ::

    
    paginator = client.get_paginator('describe_registrations')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          RegistrationIds=[
              'string',
          ],
          Filters=[
              {
                  'Name': 'registration-type'|'registration-status',
                  'Values': [
                      'string',
                  ]
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type RegistrationIds: list
    :param RegistrationIds: 

      An array of unique identifiers for each registration.

      

    
      - *(string) --* 

      
  
    :type Filters: list
    :param Filters: 

      An array of RegistrationFilter objects to filter the results.

      

    
      - *(dict) --* 

        The filter definition for filtering registrations 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**

      
      ::

        {
            'Registrations': [
                {
                    'RegistrationArn': 'string',
                    'RegistrationId': 'string',
                    'RegistrationType': 'string',
                    'RegistrationStatus': 'CREATED'|'SUBMITTED'|'AWS_REVIEWING'|'REVIEWING'|'REQUIRES_AUTHENTICATION'|'PROVISIONING'|'COMPLETE'|'REQUIRES_UPDATES'|'CLOSED'|'DELETED',
                    'CurrentVersionNumber': 123,
                    'ApprovedVersionNumber': 123,
                    'LatestDeniedVersionNumber': 123,
                    'AdditionalAttributes': {
                        'string': 'string'
                    },
                    'CreatedTimestamp': datetime(2015, 1, 1)
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Registrations** *(list) --* 

          An array of RegistrationInformation objects.

          
          

          - *(dict) --* 

            Provides information about the requested registration.

            
            

            - **RegistrationArn** *(string) --* 

              The Amazon Resource Name (ARN) for the registration.

              
            

            - **RegistrationId** *(string) --* 

              The unique identifier for the registration.

              
            

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

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

              
            

            - **RegistrationStatus** *(string) --* 

              The status of the registration.

               

              
              * ``CLOSED``: The phone number or sender ID has been deleted and you must also delete the registration for the number.
               
              * ``CREATED``: Your registration is created but not submitted.
               
              * ``COMPLETE``: Your registration has been approved and your origination identity has been created.
               
              * ``DELETED``: The registration has been deleted.
               
              * ``PROVISIONING``: Your registration has been approved and your origination identity is being created.
               
              * ``REQUIRES_AUTHENTICATION``: You need to complete email authentication.
               
              * ``REQUIRES_UPDATES``: You must fix your registration and resubmit it.
               
              * ``REVIEWING``: Your registration has been accepted and is being reviewed.
               
              * ``SUBMITTED``: Your registration has been submitted and is awaiting review.
              

              
            

            - **CurrentVersionNumber** *(integer) --* 

              The current version number of the registration.

              
            

            - **ApprovedVersionNumber** *(integer) --* 

              The version number of the registration that was approved.

              
            

            - **LatestDeniedVersionNumber** *(integer) --* 

              The latest version number of the registration that was denied.

              
            

            - **AdditionalAttributes** *(dict) --* 

              Metadata about a given registration which is specific to that registration type.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
            

            - **CreatedTimestamp** *(datetime) --* 

              The time when the registration was created, in `UNIX epoch time <https://www.epochconverter.com/>`__ format.

              
        
      
    