Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListRecommendations

Lists the recommendations present in your Amazon SES account in the current AWS Region.

You can execute this operation no more than once per second.

Request Syntax


POST /v2/email/vdm/recommendations HTTP/1.1
Content-type: application/json

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

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Filter

Filters applied when retrieving recommendations. Can eiter be an individual filter, or combinations of STATUS and IMPACT or STATUS and TYPE

Type: String to string map

Map Entries: Maximum number of 2 items.

Valid Keys: TYPE | IMPACT | STATUS | RESOURCE_ARN

Value Length Constraints: Minimum length of 1. Maximum length of 512.

Required: No

NextToken

A token returned from a previous call to ListRecommendations to indicate the position in the list of recommendations.

Type: String

Required: No

PageSize

The number of results to show in a single call to ListRecommendations. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

The value you specify has to be at least 1, and can be no more than 100.

Type: Integer

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Recommendations": [ 
      { 
         "CreatedTimestamp": number,
         "Description": "string",
         "Impact": "string",
         "LastUpdatedTimestamp": number,
         "ResourceArn": "string",
         "Status": "string",
         "Type": "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

A string token indicating that there might be additional recommendations available to be listed. Use the token provided in the ListRecommendationsResponse to use in the subsequent call to ListRecommendations with the same parameters to retrieve the next page of recommendations.

Type: String

Recommendations

The recommendations applicable to your account.

Type: Array of Recommendation objects

Errors

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

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429