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

GetRecommendation

Get a specific Recommendation

Request Syntax


GET /v1/recommendations/recommendationIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

recommendationIdentifier

The Recommendation identifier

Length Constraints: Minimum length of 20. Maximum length of 200.

Pattern: ^arn:[\w-]+:trustedadvisor::\d{12}:recommendation\/[\w-]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "recommendation": { 
      "arn": "string",
      "awsServices": [ "string" ],
      "checkArn": "string",
      "createdAt": "string",
      "createdBy": "string",
      "description": "string",
      "id": "string",
      "lastUpdatedAt": "string",
      "lifecycleStage": "string",
      "name": "string",
      "pillars": [ "string" ],
      "pillarSpecificAggregates": { 
         "costOptimizing": { 
            "estimatedMonthlySavings": number,
            "estimatedPercentMonthlySavings": number
         }
      },
      "resolvedAt": "string",
      "resourcesAggregates": { 
         "errorCount": number,
         "okCount": number,
         "warningCount": number
      },
      "source": "string",
      "status": "string",
      "type": "string",
      "updatedOnBehalfOf": "string",
      "updatedOnBehalfOfJobTitle": "string",
      "updateReason": "string",
      "updateReasonCode": "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.

recommendation

The Recommendation

Type: Recommendation object

Errors

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

AccessDeniedException

Exception that access has been denied due to insufficient access

HTTP Status Code: 403

InternalServerException

Exception to notify that an unexpected internal error occurred during processing of the request

HTTP Status Code: 500

ResourceNotFoundException

Exception that the requested resource has not been found

HTTP Status Code: 404

ThrottlingException

Exception to notify that requests are being throttled

HTTP Status Code: 429

ValidationException

Exception that the request failed to satisfy service constraints

HTTP Status Code: 400

Examples

Get A Recommendation

Get a recommendation by identifier.

Sample Request


{
    "recommendationIdentifier": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578",
}

Sample Response


{
    "recommendation": {
        "arn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578",
        "name": "MFA Recommendation",
        "description": "Enable multi-factor authentication",
        "awsServices": [
            "iam"
        ],
        "checkArn": "arn:aws:trustedadvisor:::check/7DAFEmoDos",
        "id": "55fa4d2e-bbb7-491a-833b-5773e9589578",
        "lastUpdatedAt": "2023-11-01T15:57:58.673Z",
        "pillarSpecificAggregates": {
            "costOptimizing": {
                "estimatedMonthlySavings": 0.0,
                "estimatedPercentMonthlySavings": 0.0
            }
        },
        "pillars": [
            "security"
        ],
        "resourcesAggregates": {
            "errorCount": 1,
            "okCount": 0,
            "warningCount": 0
        },
        "source": "ta_check",
        "status": "error",
        "type": "standard"
    }
}