Run and retrieve resilience assessments.
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-assessments-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 Assessments 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:
/describe-app-assessment:
post:
operationId: DescribeAppAssessment
summary: Describe App Assessment
description: Describes an assessment for an Resilience Hub application.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeAppAssessmentResponse'
'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/DescribeAppAssessmentRequest'
tags:
- Assessments
/list-app-assessments:
get:
operationId: ListAppAssessments
summary: List App Assessments
description: Lists the assessments for an Resilience Hub application. You can use request parameters to refine the results
for the response object.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListAppAssessmentsResponse'
'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/ListAppAssessmentsRequest'
tags:
- Assessments
/start-app-assessment:
post:
operationId: StartAppAssessment
summary: Start App Assessment
description: Creates a new application assessment for an application.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartAppAssessmentResponse'
'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'
'402':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'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/StartAppAssessmentRequest'
tags:
- Assessments
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
AppAssessment:
type: object
properties:
appArn:
type: string
description: 'Amazon Resource Name (ARN) of the 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 Amazon Web Services General Reference
guide.'
appVersion:
type: string
description: Version of an application.
invoker:
type: string
enum:
- User
- System
description: The entity that invoked the assessment.
cost:
$ref: '#/components/schemas/Cost'
resiliencyScore:
$ref: '#/components/schemas/ResiliencyScore'
compliance:
type: object
additionalProperties:
$ref: '#/components/schemas/DisruptionCompliance'
description: Application compliance against the resiliency policy.
complianceStatus:
type: string
enum:
- PolicyBreached
- PolicyMet
- NotApplicable
- MissingPolicy
description: Current status of the compliance for the resiliency policy.
assessmentStatus:
type: string
enum:
- Pending
- InProgress
- Failed
- Success
description: Current status of the assessment for the resiliency policy.
startTime:
type: string
format: date-time
description: Starting time for the action.
endTime:
type: string
format: date-time
description: End time for the action.
message:
type: string
description: Error or warning message from the assessment execution
assessmentName:
type: string
description: Name of the assessment.
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.'
policy:
$ref: '#/components/schemas/ResiliencyPolicy'
tags:
type: object
additionalProperties:
type: string
description: Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource.
Each tag consists of a key/value pair.
resourceErrorsDetails:
$ref: '#/components/schemas/ResourceErrorsDetails'
versionName:
type: string
description: Version name of the published application.
driftStatus:
type: string
enum:
- NotChecked
- NotDetected
- Detected
description: Indicates if compliance drifts (deviations) were detected while running an assessment for your application.
summary:
$ref: '#/components/schemas/AssessmentSummary'
required:
- invoker
- assessmentStatus
- assessmentArn
AppAssessmentSummary:
type: object
properties:
appArn:
type: string
description: 'Amazon Resource Name (ARN) of the 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 Amazon Web Services General Reference
guide.'
appVersion:
type: string
description: Version of an application.
assessmentStatus:
type: string
enum:
- Pending
- InProgress
- Failed
- Success
description: Current status of the assessment for the resiliency policy.
invoker:
type: string
enum:
- User
- System
description: Entity that invoked the assessment.
startTime:
type: string
format: date-time
description: Starting time for the action.
endTime:
type: string
format: date-time
description: End time for the action.
message:
type: string
description: Message from the assessment run.
assessmentName:
type: string
description: Name of the assessment.
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.'
complianceStatus:
type: string
enum:
- PolicyBreached
- PolicyMet
- NotApplicable
- MissingPolicy
description: Current status of compliance for the resiliency policy.
cost:
$ref: '#/components/schemas/Cost'
resiliencyScore:
type: number
description: Current resiliency score for the application.
versionName:
type: string
description: Name of an application version.
driftStatus:
type: string
enum:
- NotChecked
- NotDetected
- Detected
description: Indicates if compliance drifts (deviations) were detected while running an assessment for your application.
required:
- assessmentStatus
- assessmentArn
AssessmentRiskRecommendation:
type: object
properties:
risk:
type: string
description: Indicates the description of the potential risk identified in the application as part of the Resilience
Hub assessment. This property is available only in the US East (N. Virginia) Region.
recommendation:
type: string
description: Indicates the recommendation provided by the Resilience Hub to address the identified risks in the
application. This property is available only in the US East (N. Virginia) Region.
appComponents:
type: array
items:
type: string
description: Indicates the Application Components (AppComponents) that were assessed as part of the assessment and
are associated with the identified risk and recommendation. This property is available only in the US East (N.
Virginia) Region.
AssessmentSummary:
type: object
properties:
summary:
type: string
description: Indicates a concise summary that provides an overview of the Resilience Hub assessment. This property
is available only in the US East (N. Virginia) Region.
riskRecommendations:
type: array
items:
$ref: '#/components/schemas/AssessmentRiskRecommendation'
description: Indicates the top risks and recommendations identified by the Resilience Hub assessment, each representing
a specific risk and the corresponding recommendation to address it. This property is available only in the US
East (N. Virginia) Region.
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.
Cost:
type: object
properties:
amount:
type: number
description: The cost amount.
currency:
type: string
description: The cost currency, for example USD.
frequency:
type: string
enum:
- Hourly
- Daily
- Monthly
- Yearly
description: The cost frequency.
required:
- amount
- currency
- frequency
DescribeAppAssessmentRequest:
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.'
required:
- assessmentArn
DescribeAppAssessmentResponse:
type: object
properties:
assessment:
$ref: '#/components/schemas/AppAssessment'
required:
- assessment
DisruptionCompliance:
type: object
properties:
achievableRtoInSecs:
type: integer
description: The Recovery Time Objective (RTO) that is achievable, in seconds
currentRtoInSecs:
type: integer
description: The current RTO, in seconds.
rtoReferenceId:
type: string
description: Reference identifier of the RTO.
rtoDescription:
type: string
description: The RTO description.
currentRpoInSecs:
type: integer
description: The current RPO, in seconds.
rpoReferenceId:
type: string
description: Reference identifier of the RPO .
rpoDescription:
type: string
description: The RPO description.
complianceStatus:
type: string
enum:
- PolicyBreached
- PolicyMet
- NotApplicable
- MissingPolicy
description: The current status of compliance for the resiliency policy.
achievableRpoInSecs:
type: integer
description: The Recovery Point Objective (RPO) that is achievable, in seconds.
message:
type: string
description: The disruption compliance message.
required:
- complianceStatus
FailurePolicy:
type: object
properties:
rtoInSecs:
type: integer
description: Recovery Time Objective (RTO) in seconds.
rpoInSecs:
type: integer
description: Recovery Point Objective (RPO) in seconds.
required:
- rtoInSecs
- rpoInSecs
InternalServerException:
type: object
properties:
message:
type: string
ListAppAssessmentsRequest:
type: object
properties:
appArn:
type: string
description: 'Amazon Resource Name (ARN) of the 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 Amazon Web Services General Reference
guide.'
assessmentName:
type: string
description: The name for the assessment.
assessmentStatus:
type: array
items:
type: string
enum:
- Pending
- InProgress
- Failed
- Success
description: The current status of the assessment for the resiliency policy.
complianceStatus:
type: string
enum:
- PolicyBreached
- PolicyMet
- NotApplicable
- MissingPolicy
description: The current status of compliance for the resiliency policy.
invoker:
type: string
enum:
- User
- System
description: Specifies the entity that invoked a specific assessment, either a User or the System.
reverseOrder:
type: boolean
description: The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to
true.
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.
ListAppAssessmentsResponse:
type: object
properties:
nextToken:
type: string
description: Token for the next set of results, or null if there are no more results.
assessmentSummaries:
type: array
items:
$ref: '#/components/schemas/AppAssessmentSummary'
description: The summaries for the specified assessments, returned as an object. This object includes application
versions, associated Amazon Resource Numbers (ARNs), cost, messages, resiliency scores, and more.
required:
- assessmentSummaries
ResiliencyPolicy:
type: object
properties:
policyArn:
type: string
description: 'Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition:resiliencehub:region:account:resiliency-policy/policy-id.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference
guide.'
policyName:
type: string
description: The name of the policy
policyDescription:
type: string
description: Description of the resiliency policy.
dataLocationConstraint:
type: string
enum:
- AnyLocation
- SameContinent
- SameCountry
description: Specifies a high-level geographical location constraint for where your resilience policy data can be
stored.
tier:
type: string
enum:
- MissionCritical
- Critical
- Important
- CoreServices
- NonCritical
- NotApplicable
description: The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest
(NonCritical).
estimatedCostTier:
type: string
enum:
- L1
- L2
- L3
- L4
description: Specifies the estimated cost tier of the resiliency policy.
policy:
type: object
additionalProperties:
$ref: '#/components/schemas/FailurePolicy'
description: The resiliency policy.
creationTime:
type: string
format: date-time
description: Date and time when the resiliency policy was created.
tags:
type: object
additionalProperties:
type: string
description: Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource.
Each tag consists of a key/value pair.
ResiliencyScore:
type: object
properties:
score:
type: number
description: The outage score for a valid key.
disruptionScore:
type: object
additionalProperties:
type: number
description: The disruption score for a valid key.
componentScore:
type: object
additionalProperties:
$ref: '#/components/schemas/ScoringComponentResiliencyScore'
description: The score generated by Resilience Hub for the scoring component after running an assessment. For example,
if the score is 25 points, it indicates the overall score of your application generated by Resilience Hub after
running an assessment.
required:
- score
- disruptionScore
ResourceError:
type: object
properties:
logicalResourceId:
type: string
description: Identifier of the logical resource.
physicalResourceId:
type: string
description: Identifier of the physical resource.
reason:
type: string
description: This is the error message.
ResourceErrorsDetails:
type: object
properties:
resourceErrors:
type: array
items:
$ref: '#/components/schemas/ResourceError'
description: A list of errors retrieving an application's resources.
hasMoreErrors:
type: boolean
description: This indicates if there are more errors not listed in the resourceErrors list.
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.
ScoringComponentResiliencyScore:
type: object
properties:
score:
type: number
description: Resiliency score points given for the scoring component. The score is always less than or equal to
the possibleScore.
possibleScore:
type: number
description: Maximum possible score that can be obtained for the scoring component. For example, if the possibleScore
is 20 points, it indicates the maximum possible score you can achieve for the scoring component when you run a
new assessment after implementing all the Resilience Hub recommendations.
outstandingCount:
type: integer
description: Number of recommendations that must be implemented to obtain the maximum possible score for the scoring
component. For SOPs, alarms, and tests, these are the number of recommendations that must be implemented. For
compliance, these are the number of Application Components that have breached the resiliency policy. For example,
if the outstandingCount for Alarms coverage scoring component is 5, it indicates that 5 Amazon CloudWatch alarms
need to be implemented to achieve the maximum possible score.
excludedCount:
type: integer
description: Number of recommendations that were excluded from the assessment. For example, if the excludedCount
for Alarms coverage scoring component is 7, it indicates that 7 Amazon CloudWatch alarms are excluded from the
assessment.
ServiceQuotaExceededException:
type: object
properties:
message:
type: string
StartAppAssessmentRequest:
type: object
properties:
appArn:
type: string
description: 'Amazon Resource Name (ARN) of the 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 Amazon Web Services General Reference
guide.'
appVersion:
type: string
description: The version of the application.
assessmentName:
type: string
description: The name for the assessment.
clientToken:
type: string
description: Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII
characters. You should not reuse the same client token for other API requests.
tags:
type: object
additionalProperties:
type: string
description: Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource.
Each tag consists of a key/value pair.
required:
- appArn
- appVersion
- assessmentName
StartAppAssessmentResponse:
type: object
properties:
assessment:
$ref: '#/components/schemas/AppAssessment'
required:
- assessment
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)