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

ListRecommendations

Returns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics and a list of related events.

Request Syntax


POST /recommendations HTTP/1.1
Content-type: application/json

{
   "AccountId": "string",
   "InsightId": "string",
   "Locale": "string",
   "NextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AccountId

The ID of the AWS account.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^\d{12}$

Required: No

InsightId

The ID of the requested insight.

Type: String

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

Pattern: ^[\w-]*$

Required: Yes

Locale

A locale that specifies the language to use for recommendations.

Type: String

Required: No

NextToken

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Recommendations": [ 
      { 
         "Category": "string",
         "Description": "string",
         "Link": "string",
         "Name": "string",
         "Reason": "string",
         "RelatedAnomalies": [ 
            { 
               "AnomalyId": "string",
               "Resources": [ 
                  { 
                     "Name": "string",
                     "Type": "string"
                  }
               ],
               "SourceDetails": [ 
                  { 
                     "CloudWatchMetrics": [ 
                        { 
                           "MetricName": "string",
                           "Namespace": "string"
                        }
                     ]
                  }
               ]
            }
         ],
         "RelatedEvents": [ 
            { 
               "Name": "string",
               "Resources": [ 
                  { 
                     "Name": "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 to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Recommendations

An array of the requested recommendations.

Type: Array of Recommendation objects

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

Errors

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

AccessDeniedException

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

HTTP Status Code: 403

InternalServerException

An internal failure in an Amazon service occurred.

HTTP Status Code: 500

ResourceNotFoundException

A requested resource could not be found

HTTP Status Code: 404

ThrottlingException

The request was denied due to a request throttling.

HTTP Status Code: 429

ValidationException

Contains information about data passed in to a field during a request that is not valid.

HTTP Status Code: 400