Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListRecommendedActions

Returns a list of recommended actions that match the filter criteria.

Request Syntax


{
   "filter": { 
      "actions": [ 
         { 
            "key": "string",
            "matchOption": "string",
            "values": [ "string" ]
         }
      ]
   },
   "maxResults": number,
   "nextToken": "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.

filter

The criteria that you want all returned recommended actions to match.

Type: RequestFilter object

Required: No

maxResults

The maximum number of results to return in the response.

Type: Integer

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

Required: No

nextToken

The pagination token that indicates the next set of results that you want to retrieve.

Type: String

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

Pattern: [\S\s]*

Required: No

Response Syntax


{
   "nextToken": "string",
   "recommendedActions": [ 
      { 
         "accountId": "string",
         "context": { 
            "string" : "string" 
         },
         "feature": "string",
         "id": "string",
         "lastUpdatedTimeStamp": "string",
         "nextSteps": [ "string" ],
         "severity": "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

The pagination token that indicates the next set of results that you want to retrieve.

Type: String

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

Pattern: [\S\s]*

recommendedActions

The list of recommended actions that satisfy the filter criteria.

Type: Array of RecommendedAction objects

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

InternalServerException

An unexpected error occurred during the processing of your request.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an Amazon service.

fieldList: Lists each problematic field and why it failed validation.
reason: Provides a single, overarching explanation for the validation failure.

HTTP Status Code: 400