failure_mode_assessments

Creates, updates, deletes, gets or lists a failure_mode_assessments resource.

Overview

Name	failure_mode_assessments
Type	Resource
Id	aws.resiliencehubv2.failure_mode_assessments

Fields

The following fields are returned by SELECT queries:

list_failure_mode_assessments

Name	Datatype	Description
achievability	object	The achievability results from the assessment.
assessment_cost	object	The cost of the assessment.
assessment_id	string	The unique identifier of the assessment. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}</code>)
assessment_status	string	The current status of the assessment. (NOT_STARTED, PENDING, IN_PROGRESS, FAILED, SUCCESS)
assessment_step	string	The current step of the assessment process. (TOPOLOGY_GENERATION, INPUT_VALIDATION, DESIGN_ANALYSIS, TOPOLOGY_ENHANCEMENT, SERVICE_FUNCTION_GENERATION, POLICY_VALIDATION, RESILIENCE_ASSESSMENT, FAILURE_MODE_FINDINGS_CONSOLIDATION, FAILURE_MODE_FINDINGS_ENRICHMENT)
billable_assessment_unit_count	integer	The number of billable assessment units consumed by the assessment.
ended_at	string (date-time)	The timestamp when the assessment ended.
error_code	string	The error code if the assessment failed. (INVALID_PERMISSIONS, CMK_ACCESS_DENIED, AGENT_ERROR, INTERNAL_ERROR, DESIGN_FILE_ACCESS_DENIED)
error_message	string	A message describing the error if the assessment failed.
service_arn	string	ARN identifier. (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>)
started_at	string (date-time)	The timestamp when the assessment started.
total_findings	integer	The total number of findings generated by the assessment.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_failure_mode_assessments	select	serviceArn, region	assessmentStatuses, startedAfter, endedBefore, sortBy, sortOrder, maxResults, nextToken	Lists failure mode assessments.

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)
serviceArn	string
assessmentStatuses	array	Specifies the assessment statuses to include in the results.
endedBefore	string (date-time)	Specifies that only assessments that ended at or before this timestamp appear in the results.
maxResults	integer
nextToken	string
sortBy	string	The field to use for sorting failure mode assessments.
sortOrder	string	The sort order for results.
startedAfter	string (date-time)	Specifies that only assessments that started at or after this timestamp appear in the results.

SELECT examples

list_failure_mode_assessments

Lists failure mode assessments.

SELECT
achievability,
assessment_cost,
assessment_id,
assessment_status,
assessment_step,
billable_assessment_unit_count,
ended_at,
error_code,
error_message,
service_arn,
started_at,
total_findings
FROM aws.resiliencehubv2.failure_mode_assessments
WHERE serviceArn = '{{ serviceArn }}' -- required
AND region = '{{ region }}' -- required
AND assessmentStatuses = '{{ assessmentStatuses }}'
AND startedAfter = '{{ startedAfter }}'
AND endedBefore = '{{ endedBefore }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;