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

UpdateAgentRecommendationStatus

Note

AWS Well-Architected Agent is in preview release and is subject to change.

Updates the status of a recommendation to track its progress through the implementation lifecycle.

Request Syntax


PATCH /api/v1/agent-recommendations/recommendationArn/status HTTP/1.1
Content-type: application/json

{
   "status": "string",
   "updateReason": "string"
}

URI Request Parameters

The request uses the following URI parameters.

recommendationArn

The Amazon Resource Name (ARN) of the recommendation to update.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\d{12}:agent-recommendation/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

Request Body

The request accepts the following data in JSON format.

status

The new status to assign to the recommendation.

Type: String

Valid Values: ACTIVE | SUPPRESSED | COMPLETED

Required: Yes

updateReason

A free-text reason explaining this status update.

Type: String

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

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 Error Types.

AccessDeniedException

User does not have sufficient access to perform this action.

Message: Description of the error.

HTTP Status Code: 403

InternalServerException

There is a problem with the AWS Well-Architected Tool API service.

Message: Description of the error.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource was not found.

Message: Description of the error.
ResourceId: Identifier of the resource affected.
ResourceType: Type of the resource affected.

HTTP Status Code: 404

ThrottlingException

Request was denied due to request throttling.

Message: Description of the error.
QuotaCode: Service Quotas requirement to identify originating quota.
ServiceCode: Service Quotas requirement to identify originating service.

HTTP Status Code: 429

ValidationException

The user input is not valid.

Fields: The fields that caused the error, if applicable.
Message: Description of the error.
Reason: The reason why the request failed validation.

HTTP Status Code: 400