PinpointSMSVoiceV2 / Paginator / ListPoolOriginationIdentities


class PinpointSMSVoiceV2.Paginator.ListPoolOriginationIdentities#
paginator = client.get_paginator('list_pool_origination_identities')

Creates an iterator that will paginate through responses from PinpointSMSVoiceV2.Client.list_pool_origination_identities().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
            'Name': 'iso-country-code'|'number-capability',
            'Values': [
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • 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) –

  • PaginationConfig (dict) –

    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.

Return type:



Response Syntax

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