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

Request Syntax

response = client.list_pool_origination_identities(
            'Name': 'iso-country-code'|'number-capability',
            'Values': [
  • PoolId (string) --


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

  • Filters (list) --

    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) --
  • NextToken (string) -- 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.
  • MaxResults (integer) -- The maximum number of results to return per each request.
Return type



Response Syntax

    'PoolArn': 'string',
    'PoolId': 'string',
    'OriginationIdentities': [
            'OriginationIdentityArn': 'string',
            'OriginationIdentity': 'string',
            'IsoCountryCode': 'string',
            'NumberCapabilities': [
    '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) --
    • 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.


  • PinpointSMSVoiceV2.Client.exceptions.ThrottlingException
  • PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException
  • PinpointSMSVoiceV2.Client.exceptions.ResourceNotFoundException
  • PinpointSMSVoiceV2.Client.exceptions.ValidationException
  • PinpointSMSVoiceV2.Client.exceptions.InternalServerException