app_assessments

Creates, updates, deletes, gets or lists an app_assessments resource.

Overview

Name	app_assessments
Type	Resource
Id	aws.resiliencehub.app_assessments

Fields

The following fields are returned by SELECT queries:

describe_app_assessment

Name	Datatype	Description
app_arn	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. (pattern: <code>^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}$</code>)
app_version	string	Version of an application. (pattern: <code>^\S{1,50}$</code>)
assessment_arn	string	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. (pattern: <code>^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}$</code>)
assessment_name	string	Name of the assessment. (pattern: <code>^[A-Za-z0-9][A-Za-z0-9_-]{1,59}$</code>)
assessment_status	string	Current status of the assessment for the resiliency policy. (Pending, InProgress, Failed, Success)
compliance	object	Application compliance against the resiliency policy.
compliance_status	string	Current status of the compliance for the resiliency policy. (PolicyBreached, PolicyMet, NotApplicable, MissingPolicy)
cost	object	Cost for the application.
drift_status	string	Indicates if compliance drifts (deviations) were detected while running an assessment for your application. (NotChecked, NotDetected, Detected)
end_time	string (date-time)	End time for the action.
invoker	string	The entity that invoked the assessment. (User, System)
message	string	Error or warning message from the assessment execution
policy	object	Resiliency policy of an application.
resiliency_score	object	Current resiliency score for an application.
resource_errors_details	object	A resource error object containing a list of errors retrieving an application's resources.
start_time	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.
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.
version_name	string	Version name of the published application. (pattern: <code>^\S{1,50}$</code>)

list_app_assessments

Name	Datatype	Description
assessment_summaries	array	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.
next_token	string	Token for the next set of results, or null if there are no more results. (pattern: <code>^\S{1,2000}$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_app_assessment	select	region		Describes an assessment for an Resilience Hub application.
list_app_assessments	select	region	appArn, assessmentName, assessmentStatus, complianceStatus, invoker, maxResults, nextToken, reverseOrder	Lists the assessments for an Resilience Hub application. You can use request parameters to refine the results for the response object.
delete_app_assessment	delete	region		Deletes an Resilience Hub application assessment. This is a destructive action that can't be undone.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
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.
assessmentName	string	The name for the assessment.
assessmentStatus	array	The current status of the assessment for the resiliency policy.
complianceStatus	string	The current status of compliance for the resiliency policy.
invoker	string	Specifies the entity that invoked a specific assessment, either a User or the System.
maxResults	integer	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.
nextToken	string	Null, or the token from a previous call to get the next set of results.
reverseOrder	boolean	The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to true.

SELECT examples

describe_app_assessment

Describes an assessment for an Resilience Hub application.

SELECT
app_arn,
app_version,
assessment_arn,
assessment_name,
assessment_status,
compliance,
compliance_status,
cost,
drift_status,
end_time,
invoker,
message,
policy,
resiliency_score,
resource_errors_details,
start_time,
summary,
tags,
version_name
FROM aws.resiliencehub.app_assessments
WHERE region = '{{ region }}' -- required
;

list_app_assessments

Lists the assessments for an Resilience Hub application. You can use request parameters to refine the results for the response object.

SELECT
assessment_summaries,
next_token
FROM aws.resiliencehub.app_assessments
WHERE region = '{{ region }}' -- required
AND appArn = '{{ appArn }}'
AND assessmentName = '{{ assessmentName }}'
AND assessmentStatus = '{{ assessmentStatus }}'
AND complianceStatus = '{{ complianceStatus }}'
AND invoker = '{{ invoker }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND reverseOrder = '{{ reverseOrder }}'
;

DELETE examples

delete_app_assessment

Deletes an Resilience Hub application assessment. This is a destructive action that can't be undone.

DELETE FROM aws.resiliencehub.app_assessments
WHERE region = '{{ region }}' --required
;