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

UpdateRecommendationLifecycle

Update the lifecyle of a Recommendation. This API only supports prioritized recommendations and updates global priority recommendations, eliminating the need to call the API in each AWS Region.

Request Syntax


PUT /v1/recommendations/recommendationIdentifier/lifecycle HTTP/1.1
Content-type: application/json

{
   "lifecycleStage": "string",
   "updateReason": "string",
   "updateReasonCode": "string"
}

URI Request Parameters

The request uses the following URI parameters.

recommendationIdentifier

The Recommendation identifier for AWS Trusted Advisor Priority recommendations

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

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

lifecycleStage

The new lifecycle stage

Type: String

Valid Values: pending_response | in_progress | dismissed | resolved

Required: Yes

updateReason

Reason for the lifecycle stage change

Type: String

Length Constraints: Minimum length of 10. Maximum length of 4096.

Pattern: ^[\s\S]*$

Required: No

updateReasonCode

Reason code for the lifecycle state change

Type: String

Required: No

Response Syntax


HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

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

ConflictException

Exception that the request was denied due to conflictions in state

HTTP Status Code: 409

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

Update the Lifecycle of a Recommendation

Update the lifecycle stage of a recommendation managed by AWS Trusted Advisor Priority.

Sample Request


{
    "recommendationIdentifier": "arn:aws:trustedadvisor::000000000000:recommendation/861c9c6e-f169-405a-8b59-537a8caccd7a",
    "lifecycleStage": "resolved",
    "updateReasonCode": "valid_business_case",
    "updateReason": "Resolved the recommendation"
}