ListAppComponentRecommendations
Lists the recommendations for an AWS Resilience Hub Application Component.
Request Syntax
POST /list-app-component-recommendations HTTP/1.1
Content-type: application/json
{
"assessmentArn": "string
",
"maxResults": number
,
"nextToken": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- assessmentArn
-
Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:
partition
:resiliencehub:region
:account
:app-assessment/app-id
. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.Type: String
Pattern:
^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}$
Required: Yes
- maxResults
-
Maximum number of results to include in the response. If more results exist than the specified
MaxResults
value, a token is included in the response so that the remaining results can be retrieved.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- nextToken
-
Null, or the token from a previous call to get the next set of results.
Type: String
Pattern:
^\S{1,2000}$
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"componentRecommendations": [
{
"appComponentName": "string",
"configRecommendations": [
{
"appComponentName": "string",
"compliance": {
"string" : {
"achievableRpoInSecs": number,
"achievableRtoInSecs": number,
"complianceStatus": "string",
"currentRpoInSecs": number,
"currentRtoInSecs": number,
"message": "string",
"rpoDescription": "string",
"rpoReferenceId": "string",
"rtoDescription": "string",
"rtoReferenceId": "string"
}
},
"cost": {
"amount": number,
"currency": "string",
"frequency": "string"
},
"description": "string",
"haArchitecture": "string",
"name": "string",
"optimizationType": "string",
"recommendationCompliance": {
"string" : {
"expectedComplianceStatus": "string",
"expectedRpoDescription": "string",
"expectedRpoInSecs": number,
"expectedRtoDescription": "string",
"expectedRtoInSecs": number
}
},
"referenceId": "string",
"suggestedChanges": [ "string" ]
}
],
"recommendationStatus": "string"
}
],
"nextToken": "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.
- componentRecommendations
-
The recommendations for an AWS Resilience Hub Application Component, returned as an object. This object contains the names of the Application Components, configuration recommendations, and recommendation statuses.
Type: Array of ComponentRecommendation objects
- nextToken
-
Token for the next set of results, or null if there are no more results.
Type: String
Pattern:
^\S{1,2000}$
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.
HTTP Status Code: 403
- InternalServerException
-
This exception occurs when there is an internal failure in the AWS Resilience Hub service.
HTTP Status Code: 500
- ResourceNotFoundException
-
This exception occurs when the specified resource could not be found.
HTTP Status Code: 404
- ThrottlingException
-
This exception occurs when you have exceeded the limit on the number of requests per second.
HTTP Status Code: 429
- ValidationException
-
This exception occurs when a request is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: