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

********************************
list_pool_origination_identities
********************************



.. py:method:: PinpointSMSVoiceV2.Client.list_pool_origination_identities(**kwargs)

  

  Lists all associated origination identities in your pool.

   

  If you specify filters, the output includes information for only those origination identities that meet the filter criteria.

  

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


  **Request Syntax**
  ::

    response = client.list_pool_origination_identities(
        PoolId='string',
        Filters=[
            {
                'Name': 'iso-country-code'|'number-capability',
                'Values': [
                    'string',
                ]
            },
        ],
        NextToken='string',
        MaxResults=123
    )
    
  :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 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**

    
    ::

      {
          'PoolArn': 'string',
          'PoolId': 'string',
          'OriginationIdentities': [
              {
                  'OriginationIdentityArn': 'string',
                  'OriginationIdentity': 'string',
                  'IsoCountryCode': 'string',
                  'NumberCapabilities': [
                      'SMS'|'VOICE'|'MMS',
                  ],
                  'PhoneNumber': 'string'
              },
          ],
          'NextToken': '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.

            
      
    
      

      - **NextToken** *(string) --* 

        The token to be used for the next set of paginated results. If this field is empty then there are no more results.

        
  
  **Exceptions**
  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.ThrottlingException`

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

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

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

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

  