assessments

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

Overview

Name	assessments
Type	Resource
Id	aws.marketplace_catalog.assessments

Fields

The following fields are returned by SELECT queries:

describe_assessment

Name	Datatype	Description
control_assessment_result	string	The result of the control evaluation. (PASS, FAIL, NOT_EXECUTED, EXEMPTION_PASS)
control_id	string	The unique ID of the control that was evaluated. (pattern: <code>^[\w-]+$</code>)
errors	array	An array of ControlError objects associated with the control evaluation.

list_assessments

Name	Datatype	Description
assessment_arn	string	The ARN associated with the assessment. (pattern: <code>^[a-zA-Z0-9:*/-]+$</code>)
assessment_id	string	The unique ID of the assessment. (pattern: <code>^[\w-]+$</code>)
assessment_result	string	The overall result of the assessment. (PASS, FAIL)
assessment_target_summary	object	Identifies the entity or change set that was assessed.
created_at	string	The date and time the assessment was created, in ISO 8601 format (2018-02-27T13:45:22Z). (pattern: <code>^([\d]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12][\d])T(2[0-3]|[01][\d]):([0-5][\d]):([0-5][\d])Z$</code>)
expires_at	string	The date and time the assessment expires, in ISO 8601 format (2018-02-27T13:45:22Z). (pattern: <code>^([\d]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12][\d])T(2[0-3]|[01][\d]):([0-5][\d]):([0-5][\d])Z$</code>)
framework_id	string	The identifier of the framework that was evaluated by this assessment, in the format frameworkId@version (for example, AMISecurity@1.0). (pattern: <code>^[\w-@.]+$</code>)
framework_summary	object	The framework-specific details of the assessed resource. The set member corresponds to the framework identified by FrameworkId.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_assessment	select	region		Returns the metadata and detailed results of a single assessment, including the framework that was evaluated, the overall assessment result, and a paginated list of individual control evaluation results. To list available assessments before describing one, use the ListAssessments action.
list_assessments	select	region		Returns a paginated list of assessments associated with an entity or change set in AWS Marketplace. An assessment is the result of evaluating a product or change set against a framework, such as AMI Security or Container Security. Use the AssessmentTargetFilter to scope results to a specific entity or change set, and use FrameworkFilters to scope results to a single framework. To retrieve detailed control-level results for an individual assessment, use the DescribeAssessment action. Results are sorted by assessment creation time in descending order.

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)

SELECT examples

describe_assessment

Returns the metadata and detailed results of a single assessment, including the framework that was evaluated, the overall assessment result, and a paginated list of individual control evaluation results. To list available assessments before describing one, use the ListAssessments action.

SELECT
control_assessment_result,
control_id,
errors
FROM aws.marketplace_catalog.assessments
WHERE region = '{{ region }}' -- required
;

list_assessments

Returns a paginated list of assessments associated with an entity or change set in AWS Marketplace. An assessment is the result of evaluating a product or change set against a framework, such as AMI Security or Container Security. Use the AssessmentTargetFilter to scope results to a specific entity or change set, and use FrameworkFilters to scope results to a single framework. To retrieve detailed control-level results for an individual assessment, use the DescribeAssessment action. Results are sorted by assessment creation time in descending order.

SELECT
assessment_arn,
assessment_id,
assessment_result,
assessment_target_summary,
created_at,
expires_at,
framework_id,
framework_summary
FROM aws.marketplace_catalog.assessments
WHERE region = '{{ region }}' -- required
;