Retrieve alarm, SOP, and test recommendations.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/amazon-resilience-hub:amazon-resilience-hub-recommendations-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.1.0
info:
title: AWS Resilience Hub Recommendations API
version: '2020-04-30'
description: Generated from AWS's published Smithy model for AWS Resilience Hub. 3 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://resiliencehub.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
paths:
/list-alarm-recommendations:
post:
operationId: ListAlarmRecommendations
summary: List Alarm Recommendations
description: Lists the alarm recommendations for an Resilience Hub application.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListAlarmRecommendationsResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListAlarmRecommendationsRequest'
tags:
- Recommendations
/list-sop-recommendations:
post:
operationId: ListSopRecommendations
summary: List Sop Recommendations
description: Lists the standard operating procedure (SOP) recommendations for the Resilience Hub applications.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListSopRecommendationsResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListSopRecommendationsRequest'
tags:
- Recommendations
/list-test-recommendations:
post:
operationId: ListTestRecommendations
summary: List Test Recommendations
description: Lists the test recommendations for the Resilience Hub application.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListTestRecommendationsResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListTestRecommendationsRequest'
tags:
- Recommendations
components:
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: resiliencehub
schemas:
AccessDeniedException:
type: object
properties:
message:
type: string
Alarm:
type: object
properties:
alarmArn:
type: string
description: Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.
source:
type: string
description: Indicates the source of the Amazon CloudWatch alarm. That is, it indicates if the alarm was created
using Resilience Hub recommendation (AwsResilienceHub), or if you had created the alarm in Amazon CloudWatch (Customer).
AlarmRecommendation:
type: object
properties:
recommendationId:
type: string
description: Identifier of the alarm recommendation.
referenceId:
type: string
description: Reference identifier of the alarm recommendation.
name:
type: string
description: Name of the alarm recommendation.
description:
type: string
description: Description of the alarm recommendation.
type:
type: string
enum:
- Metric
- Composite
- Canary
- Logs
- Event
description: Type of alarm recommendation.
appComponentName:
type: string
description: Application Component name for the CloudWatch alarm recommendation. This name is saved as the first
item in the appComponentNames list.
items:
type: array
items:
$ref: '#/components/schemas/RecommendationItem'
description: List of CloudWatch alarm recommendations.
prerequisite:
type: string
description: The prerequisite for the alarm recommendation.
appComponentNames:
type: array
items:
type: string
description: List of Application Component names for the CloudWatch alarm recommendation.
recommendationStatus:
type: string
enum:
- Implemented
- Inactive
- NotImplemented
- Excluded
description: Status of the recommended Amazon CloudWatch alarm.
required:
- recommendationId
- referenceId
- name
- type
ConflictException:
type: object
properties:
message:
type: string
resourceId:
type: string
description: The identifier of the resource that the exception applies to.
resourceType:
type: string
description: The type of the resource that the exception applies to.
Experiment:
type: object
properties:
experimentArn:
type: string
description: Amazon Resource Name (ARN) of the FIS experiment.
experimentTemplateId:
type: string
description: Identifier of the FIS experiment template.
InternalServerException:
type: object
properties:
message:
type: string
ListAlarmRecommendationsRequest:
type: object
properties:
assessmentArn:
type: string
description: '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 Amazon Web Services General Reference
guide.'
nextToken:
type: string
description: Null, or the token from a previous call to get the next set of results.
maxResults:
type: integer
description: 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.
required:
- assessmentArn
ListAlarmRecommendationsResponse:
type: object
properties:
alarmRecommendations:
type: array
items:
$ref: '#/components/schemas/AlarmRecommendation'
description: The alarm recommendations for an 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.
nextToken:
type: string
description: Token for the next set of results, or null if there are no more results.
required:
- alarmRecommendations
ListSopRecommendationsRequest:
type: object
properties:
nextToken:
type: string
description: Null, or the token from a previous call to get the next set of results.
maxResults:
type: integer
description: 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.
assessmentArn:
type: string
description: '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 Amazon Web Services General Reference
guide.'
required:
- assessmentArn
ListSopRecommendationsResponse:
type: object
properties:
nextToken:
type: string
description: Token for the next set of results, or null if there are no more results.
sopRecommendations:
type: array
items:
$ref: '#/components/schemas/SopRecommendation'
description: The standard operating procedure (SOP) recommendations for the Resilience Hub applications.
required:
- sopRecommendations
ListTestRecommendationsRequest:
type: object
properties:
nextToken:
type: string
description: Null, or the token from a previous call to get the next set of results.
maxResults:
type: integer
description: 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.
assessmentArn:
type: string
description: '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 Amazon Web Services General Reference
guide.'
required:
- assessmentArn
ListTestRecommendationsResponse:
type: object
properties:
nextToken:
type: string
description: Token for the next set of results, or null if there are no more results.
testRecommendations:
type: array
items:
$ref: '#/components/schemas/TestRecommendation'
description: The test recommendations for the Resilience Hub application.
required:
- testRecommendations
RecommendationItem:
type: object
properties:
resourceId:
type: string
description: Identifier of the resource.
targetAccountId:
type: string
description: Identifier of the target account.
targetRegion:
type: string
description: The target region.
alreadyImplemented:
type: boolean
description: Specifies if the recommendation has already been implemented.
excluded:
type: boolean
description: Indicates if an operational recommendation item is excluded.
excludeReason:
type: string
enum:
- AlreadyImplemented
- NotRelevant
- ComplexityOfImplementation
description: Indicates the reason for excluding an operational recommendation.
latestDiscoveredExperiment:
$ref: '#/components/schemas/Experiment'
discoveredAlarm:
$ref: '#/components/schemas/Alarm'
ResourceNotFoundException:
type: object
properties:
message:
type: string
resourceId:
type: string
description: The identifier of the resource that the exception applies to.
resourceType:
type: string
description: The type of the resource that the exception applies to.
SopRecommendation:
type: object
properties:
serviceType:
type: string
enum:
- SSM
description: The service type.
appComponentName:
type: string
description: Name of the Application Component.
description:
type: string
description: Description of the SOP recommendation.
recommendationId:
type: string
description: Identifier for the SOP recommendation.
name:
type: string
description: Name of the SOP recommendation.
items:
type: array
items:
$ref: '#/components/schemas/RecommendationItem'
description: The recommendation items.
referenceId:
type: string
description: Reference identifier for the SOP recommendation.
prerequisite:
type: string
description: Prerequisite for the SOP recommendation.
recommendationStatus:
type: string
enum:
- Implemented
- Inactive
- NotImplemented
- Excluded
description: Status of the recommended standard operating procedure.
required:
- serviceType
- recommendationId
- referenceId
TestRecommendation:
type: object
properties:
recommendationId:
type: string
description: Identifier for the test recommendation.
referenceId:
type: string
description: Reference identifier for the test recommendation.
appComponentId:
type: string
description: Indicates the identifier of the AppComponent.
appComponentName:
type: string
description: Name of the Application Component.
name:
type: string
description: Name of the test recommendation.
intent:
type: string
description: Intent of the test recommendation.
risk:
type: string
enum:
- Small
- Medium
- High
description: Level of risk for this test recommendation.
type:
type: string
enum:
- Software
- Hardware
- AZ
- Region
description: Type of test recommendation.
description:
type: string
description: Description for the test recommendation.
items:
type: array
items:
$ref: '#/components/schemas/RecommendationItem'
description: The test recommendation items.
prerequisite:
type: string
description: Prerequisite of the test recommendation.
dependsOnAlarms:
type: array
items:
type: string
description: A list of recommended alarms that are used in the test and must be exported before or with the test.
recommendationStatus:
type: string
enum:
- Implemented
- Inactive
- NotImplemented
- Excluded
description: Status of the recommended test.
required:
- referenceId
ThrottlingException:
type: object
properties:
message:
type: string
retryAfterSeconds:
type: integer
description: The number of seconds to wait before retrying the operation.
ValidationException:
type: object
properties:
message:
type: string
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/resiliencehub/service/2020-04-30/resiliencehub-2020-04-30.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)