ListPoolOriginationIdentities - Amazon Pinpoint SMS and Voice v2 API

ListPoolOriginationIdentities

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.

Request Syntax

{ "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "PoolId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Filters

An array of PoolOriginationIdentitiesFilter objects to filter the results..

Type: Array of PoolOriginationIdentitiesFilter objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Required: No

MaxResults

The maximum number of results to return per each request.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

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: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .+

Required: No

PoolId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [A-Za-z0-9_:/-]+

Required: Yes

Response Syntax

{ "NextToken": "string", "OriginationIdentities": [ { "IsoCountryCode": "string", "NumberCapabilities": [ "string" ], "OriginationIdentity": "string", "OriginationIdentityArn": "string" } ], "PoolArn": "string", "PoolId": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .+

OriginationIdentities

An array of any OriginationIdentityMetadata objects.

Type: Array of OriginationIdentityMetadata objects

PoolArn

The Amazon Resource Name (ARN) for the pool.

Type: String

PoolId

The unique PoolId of the pool.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The request was denied because you don't have sufficient permissions to access the resource.

HTTP Status Code: 400

InternalServerException

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

HTTP Status Code: 500

ResourceNotFoundException

A requested resource couldn't be found.

HTTP Status Code: 400

ThrottlingException

An error that occurred because too many requests were sent during a certain amount of time.

HTTP Status Code: 400

ValidationException

A validation exception for a field.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: