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

****************************
ListRegistrationAssociations
****************************



.. py:class:: PinpointSMSVoiceV2.Paginator.ListRegistrationAssociations

  ::

    
    paginator = client.get_paginator('list_registration_associations')

  
  

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

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

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


    **Request Syntax**
    ::

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

      The unique identifier for the registration.

      

    
    :type Filters: list
    :param Filters: 

      An array of RegistrationAssociationFilter to apply to the results that are returned.

      

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

          

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

      
      ::

        {
            'RegistrationArn': 'string',
            'RegistrationId': 'string',
            'RegistrationType': 'string',
            'RegistrationAssociations': [
                {
                    'ResourceArn': 'string',
                    'ResourceId': 'string',
                    'ResourceType': 'string',
                    'IsoCountryCode': 'string',
                    'PhoneNumber': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

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

          
        

        - **RegistrationAssociations** *(list) --* 

          An array of RegistrationAssociationMetadata objects.

          
          

          - *(dict) --* 

            Metadata for the origination identity that is associated with the registration.

            
            

            - **ResourceArn** *(string) --* 

              The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.

              
            

            - **ResourceId** *(string) --* 

              The unique identifier for the origination identity. For example this could be a **PhoneNumberId** or **SenderId**.

              
            

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

              The origination identity type.

              
            

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

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

              
            

            - **PhoneNumber** *(string) --* 

              The phone number associated with the registration in E.164 format.

              
        
      
    