Skip to content

Lists all associated origination identities in your pool

Description

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.

Usage

pinpointsmsvoicev2_list_pool_origination_identities(PoolId, Filters,
  NextToken, MaxResults)

Arguments

  • PoolId

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

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

  • Filters

    An array of PoolOriginationIdentitiesFilter objects to filter the results..

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

  • MaxResults

    The maximum number of results to return per each request.

Value

A list with the following syntax:

list(
  PoolArn = "string",
  PoolId = "string",
  OriginationIdentities = list(
    list(
      OriginationIdentityArn = "string",
      OriginationIdentity = "string",
      IsoCountryCode = "string",
      NumberCapabilities = list(
        "SMS"|"VOICE"|"MMS"|"RCS"
      ),
      PhoneNumber = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_pool_origination_identities(
  PoolId = "string",
  Filters = list(
    list(
      Name = "iso-country-code"|"number-capability",
      Values = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  MaxResults = 123
)