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` string, required — The version of the application.
- `assessmentName` string, required — The name for the assessment.
- `clientToken` string — 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` object — 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.
## Response `200`
Success
- StartAppAssessmentResponse
- `assessment` object, required — The assessment created.
- `appArn` string — 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` string — Version of an application.
- `assessmentArn` string, required — 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.
- `assessmentName` string — Name of the assessment.
- `assessmentStatus` 'Pending' | 'InProgress' | 'Failed' | 'Success', required — Current status of the assessment for the resiliency policy.
- `compliance` object — Application compliance against the resiliency policy.
- `complianceStatus` 'PolicyBreached' | 'PolicyMet' | 'NotApplicable' | 'MissingPolicy' — Current status of the compliance for the resiliency policy.
- `cost` object — Cost for the application.
- `amount` number, double, required — The cost amount.
- `currency` string, required — The cost currency, for example USD.
- `frequency` 'Hourly' | 'Daily' | 'Monthly' | 'Yearly', required — The cost frequency.
- `driftStatus` 'NotChecked' | 'NotDetected' | 'Detected' — Indicates if compliance drifts (deviations) were detected while running an assessment for your application.
- `endTime` string, date-time — End time for the action.
- `invoker` 'User' | 'System', required — The entity that invoked the assessment.
- `message` string — Error or warning message from the assessment execution
- `policy` object — Resiliency policy of an application.
- `creationTime` string, date-time — Date and time when the resiliency policy was created.
- `dataLocationConstraint` 'AnyLocation' | 'SameContinent' | 'SameCountry' — Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
- `estimatedCostTier` 'L1' | 'L2' | 'L3' | 'L4' — Specifies the estimated cost tier of the resiliency policy.
- `policy` object — The resiliency policy.
- `policyArn` string — 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.
- `policyDescription` string — Description of the resiliency policy.
- `policyName` string — The name of the policy
- `tags` object — 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.
- `tier` 'MissionCritical' | 'Critical' | 'Important' | 'CoreServices' | 'NonCritical' | 'NotApplicable' — The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).
- `resiliencyScore` object — Current resiliency score for an application.
- `componentScore` object — 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.
resourceErrors list.
- `resourceErrors` ResourceError[] — A list of errors retrieving an application's resources.
- `logicalResourceId` string — Identifier of the logical resource.
- `physicalResourceId` string — Identifier of the physical resource.
- `reason` string — This is the error message.
- `startTime` string, date-time — Starting time for the action.
- `summary` object — Indicates the AI-generated summary for the Resilience Hub assessment, providing a concise overview that highlights the top risks and recommendations.
This property is available only in the US East (N. Virginia) Region.
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.
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.
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.
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.
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.