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

ListAlarmRecommendations

Lists the alarm recommendations for an AWS Resilience Hub application.

Request Syntax


POST /list-alarm-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

{
   "alarmRecommendations": [ 
      { 
         "appComponentName": "string",
         "appComponentNames": [ "string" ],
         "description": "string",
         "items": [ 
            { 
               "alreadyImplemented": boolean,
               "excluded": boolean,
               "excludeReason": "string",
               "resourceId": "string",
               "targetAccountId": "string",
               "targetRegion": "string"
            }
         ],
         "name": "string",
         "prerequisite": "string",
         "recommendationId": "string",
         "recommendationStatus": "string",
         "referenceId": "string",
         "type": "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.

alarmRecommendations

The alarm recommendations for an AWS Resilience Hub application, returned as an object. This object includes Application Component names, descriptions, information about whether a recommendation has already been implemented or not, prerequisites, and more.

Type: Array of AlarmRecommendation 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