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

ListResourceGroupingRecommendations

Lists the resource grouping recommendations suggested by AWS Resilience Hub for your application.

Request Syntax


GET /list-resource-grouping-recommendations?appArn=appArn&maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appArn

Amazon Resource Name (ARN) of the AWS Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

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}$

maxResults

Maximum number of grouping recommendations to be displayed per AWS Resilience Hub application.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

Null, or the token from a previous call to get the next set of results.

Pattern: ^\S{1,2000}$

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "groupingRecommendations": [ 
      { 
         "confidenceLevel": "string",
         "creationTime": number,
         "groupingAppComponent": { 
            "appComponentId": "string",
            "appComponentName": "string",
            "appComponentType": "string"
         },
         "groupingRecommendationId": "string",
         "recommendationReasons": [ "string" ],
         "rejectionReason": "string",
         "resources": [ 
            { 
               "logicalResourceId": { 
                  "eksSourceName": "string",
                  "identifier": "string",
                  "logicalStackName": "string",
                  "resourceGroupName": "string",
                  "terraformSourceName": "string"
               },
               "physicalResourceId": { 
                  "awsAccountId": "string",
                  "awsRegion": "string",
                  "identifier": "string",
                  "type": "string"
               },
               "resourceName": "string",
               "resourceType": "string",
               "sourceAppComponentIds": [ "string" ]
            }
         ],
         "score": number,
         "status": "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.

groupingRecommendations

List of resource grouping recommendations generated by AWS Resilience Hub.

Type: Array of GroupingRecommendation objects

nextToken

Null, or the token from a previous call to get the next set of 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