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

*****************************
ListPoolOriginationIdentities
*****************************



.. py:class:: PinpointSMSVoiceV2.Paginator.ListPoolOriginationIdentities

  ::

    
    paginator = client.get_paginator('list_pool_origination_identities')

  
  

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

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

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


    **Request Syntax**
    ::

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

      The unique identifier for the pool. This value can be either the PoolId or PoolArn.

       

      .. warning::

         

        If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).

        

      

    
    :type Filters: list
    :param Filters: 

      An array of PoolOriginationIdentitiesFilter objects to filter the results..

      

    
      - *(dict) --* 

        Information about origination identities associated with a pool that meets a specified criteria.

        

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

          The name of the attribute to filter on.

          

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

          An array 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**

      
      ::

        {
            'PoolArn': 'string',
            'PoolId': 'string',
            'OriginationIdentities': [
                {
                    'OriginationIdentityArn': 'string',
                    'OriginationIdentity': 'string',
                    'IsoCountryCode': 'string',
                    'NumberCapabilities': [
                        'SMS'|'VOICE'|'MMS',
                    ],
                    'PhoneNumber': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **PoolArn** *(string) --* 

          The Amazon Resource Name (ARN) for the pool.

          
        

        - **PoolId** *(string) --* 

          The unique PoolId of the pool.

          
        

        - **OriginationIdentities** *(list) --* 

          An array of any OriginationIdentityMetadata objects.

          
          

          - *(dict) --* 

            The metadata for an origination identity associated with a pool.

            
            

            - **OriginationIdentityArn** *(string) --* 

              The Amazon Resource Name (ARN) associated with the origination identity.

              
            

            - **OriginationIdentity** *(string) --* 

              The unique identifier of the origination identity.

              
            

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

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

              
            

            - **NumberCapabilities** *(list) --* 

              Describes if the origination identity can be used for text messages, voice calls or both.

              
              

              - *(string) --* 
          
            

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

              The phone number in E.164 format.

              
        
      
    