ListTrafficPolicies - Amazon SES Mail Manager API

ListTrafficPolicies

List traffic policy resources.

Request Syntax

{ "NextToken": "string", "PageSize": number }

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.

NextToken

If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

Type: String

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

Required: No

PageSize

The maximum number of traffic policy resources that are returned per call. You can use NextToken to obtain further traffic policies.

Type: Integer

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

Required: No

Response Syntax

{ "NextToken": "string", "TrafficPolicies": [ { "DefaultAction": "string", "TrafficPolicyId": "string", "TrafficPolicyName": "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

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Type: String

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

TrafficPolicies

The list of traffic policies.

Type: Array of TrafficPolicy objects

Errors

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

ValidationException

The request validation has failed. For details, see the accompanying error message.

HTTP Status Code: 400

See Also

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