assessment_frameworks

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

Overview

Name	assessment_frameworks
Type	Resource
Id	aws.auditmanager.assessment_frameworks

Fields

The following fields are returned by SELECT queries:

list_assessment_frameworks

Name	Datatype	Description
framework_metadata_list	array	A list of metadata that the ListAssessmentFrameworks API returns for each framework.
next_token	string	The pagination token that's used to fetch the next set of results. (pattern: <code>^[A-Za-z0-9+/=]*$</code>)

get_assessment_framework

Name	Datatype	Description
id	string	The unique identifier for the framework. (pattern: <code>^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$</code>)
name	string	The name of the framework. (pattern: <code>^[^\]*$</code>)
arn	string	The Amazon Resource Name (ARN) of the framework. (pattern: <code>^arn:.:auditmanager:.</code>)
compliance_type	string	The compliance type that the framework supports, such as CIS or HIPAA. (pattern: <code>^[\w\W\s\S]*$</code>)
control_sets	array	The control sets that are associated with the framework. The Controls object returns a partial response when called through Framework APIs. For a complete Controls object, use GetControl.
control_sources	string	The control data sources where Audit Manager collects evidence from. This API parameter is no longer supported. (pattern: <code>^[a-zA-Z_0-9-\s.,]+$</code>)
created_at	string (date-time)	The time when the framework was created.
created_by	string	The user or role that created the framework. (pattern: <code>^[a-zA-Z0-9\s-_()&#91;&#93;]+$</code>)
description	string	The description of the framework. (pattern: <code>^[\w\W\s\S]*$</code>)
last_updated_at	string (date-time)	The time when the framework was most recently updated.
last_updated_by	string	The user or role that most recently updated the framework. (pattern: <code>^[a-zA-Z0-9\s-_()&#91;&#93;]+$</code>)
logo	string	The logo that's associated with the framework. (pattern: <code>^[\w,\s-]+.[A-Za-z]+$</code>)
tags	object	The tags that are associated with the framework.
type_	string	Specifies whether the framework is a standard framework or a custom framework. (Standard, Custom)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_assessment_frameworks	select	frameworkType, region	nextToken, maxResults	Returns a list of the frameworks that are available in the Audit Manager framework library.
get_assessment_framework	select	framework_id, region		Gets information about a specified framework.
create_assessment_framework	insert	region, name, controlSets		Creates a custom framework in Audit Manager.
update_assessment_framework	update	framework_id, region, name, controlSets		Updates a custom framework in Audit Manager.
update_assessment_framework_share	update	request_id, region, requestType, action		Updates a share request for a custom framework in Audit Manager.
delete_assessment_framework_share	delete	request_id, requestType, region		Deletes a share request for a custom framework in Audit Manager.
delete_assessment_framework	delete	framework_id, region		Deletes a custom framework in Audit Manager.
start_assessment_framework_share	exec	framework_id, region, destinationAccount, destinationRegion		Creates a share request for a custom framework in Audit Manager. The share request specifies a recipient and notifies them that a custom framework is available. Recipients have 120 days to accept or decline the request. If no action is taken, the share request expires. When you create a share request, Audit Manager stores a snapshot of your custom framework in the US East (N. Virginia) Amazon Web Services Region. Audit Manager also stores a backup of the same snapshot in the US West (Oregon) Amazon Web Services Region. Audit Manager deletes the snapshot and the backup snapshot when one of the following events occurs: The sender revokes the share request. The recipient declines the share request. The recipient encounters an error and doesn't successfully accept the share request. The share request expires before the recipient responds to the request. When a sender resends a share request, the snapshot is replaced with an updated version that corresponds with the latest version of the custom framework. When a recipient accepts a share request, the snapshot is replicated into their Amazon Web Services account under the Amazon Web Services Region that was specified in the share request. When you invoke the StartAssessmentFrameworkShare API, you are about to share a custom framework with another Amazon Web Services account. You may not share a custom framework that is derived from a standard framework if the standard framework is designated as not eligible for sharing by Amazon Web Services, unless you have obtained permission to do so from the owner of the standard framework. To learn more about which standard frameworks are eligible for sharing, see Framework sharing eligibility in the Audit Manager User Guide.

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
frameworkType	string	The type of framework, such as a standard framework or a custom framework.
framework_id	string	The unique identifier for the custom framework to be shared.
region	string	AWS region (default: us-east-1)
requestType	string	Specifies whether the share request is a sent request or a received request.
request_id	string	The unique identifier for the share request to be deleted.
maxResults	integer	Represents the maximum number of results on a page or for an API request call.
nextToken	string	The pagination token that's used to fetch the next set of results.

SELECT examples

list_assessment_frameworks

Returns a list of the frameworks that are available in the Audit Manager framework library.

SELECT
framework_metadata_list,
next_token
FROM aws.auditmanager.assessment_frameworks
WHERE frameworkType = '{{ frameworkType }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

get_assessment_framework

Gets information about a specified framework.

SELECT
id,
name,
arn,
compliance_type,
control_sets,
control_sources,
created_at,
created_by,
description,
last_updated_at,
last_updated_by,
logo,
tags,
type_
FROM aws.auditmanager.assessment_frameworks
WHERE framework_id = '{{ framework_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_assessment_framework

Creates a custom framework in Audit Manager.

INSERT INTO aws.auditmanager.assessment_frameworks (
name,
description,
complianceType,
controlSets,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ complianceType }}',
'{{ controlSets }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
framework
;

Manifest

# Description fields are for documentation purposes
- name: assessment_frameworks
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the assessment_frameworks resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: complianceType
    value: "{{ complianceType }}"
  - name: controlSets
    value:
      - name: "{{ name }}"
        controls: "{{ controls }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_assessment_framework

Updates a custom framework in Audit Manager.

UPDATE aws.auditmanager.assessment_frameworks
SET 
name = '{{ name }}',
description = '{{ description }}',
complianceType = '{{ complianceType }}',
controlSets = '{{ controlSets }}'
WHERE 
framework_id = '{{ framework_id }}' --required
AND region = '{{ region }}' --required
AND name = '{{ name }}' --required
AND controlSets = '{{ controlSets }}' --required
RETURNING
framework;

update_assessment_framework_share

Updates a share request for a custom framework in Audit Manager.

UPDATE aws.auditmanager.assessment_frameworks
SET 
requestType = '{{ requestType }}',
action = '{{ action }}'
WHERE 
request_id = '{{ request_id }}' --required
AND region = '{{ region }}' --required
AND requestType = '{{ requestType }}' --required
AND action = '{{ action }}' --required
RETURNING
assessment_framework_share_request;

DELETE examples

delete_assessment_framework_share

Deletes a share request for a custom framework in Audit Manager.

DELETE FROM aws.auditmanager.assessment_frameworks
WHERE request_id = '{{ request_id }}' --required
AND requestType = '{{ requestType }}' --required
AND region = '{{ region }}' --required
;

delete_assessment_framework

Deletes a custom framework in Audit Manager.

DELETE FROM aws.auditmanager.assessment_frameworks
WHERE framework_id = '{{ framework_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

start_assessment_framework_share

Creates a share request for a custom framework in Audit Manager. The share request specifies a recipient and notifies them that a custom framework is available. Recipients have 120 days to accept or decline the request. If no action is taken, the share request expires. When you create a share request, Audit Manager stores a snapshot of your custom framework in the US East (N. Virginia) Amazon Web Services Region. Audit Manager also stores a backup of the same snapshot in the US West (Oregon) Amazon Web Services Region. Audit Manager deletes the snapshot and the backup snapshot when one of the following events occurs: The sender revokes the share request. The recipient declines the share request. The recipient encounters an error and doesn't successfully accept the share request. The share request expires before the recipient responds to the request. When a sender resends a share request, the snapshot is replaced with an updated version that corresponds with the latest version of the custom framework. When a recipient accepts a share request, the snapshot is replicated into their Amazon Web Services account under the Amazon Web Services Region that was specified in the share request. When you invoke the StartAssessmentFrameworkShare API, you are about to share a custom framework with another Amazon Web Services account. You may not share a custom framework that is derived from a standard framework if the standard framework is designated as not eligible for sharing by Amazon Web Services, unless you have obtained permission to do so from the owner of the standard framework. To learn more about which standard frameworks are eligible for sharing, see Framework sharing eligibility in the Audit Manager User Guide.

EXEC aws.auditmanager.assessment_frameworks.start_assessment_framework_share 
@framework_id='{{ framework_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"destinationAccount": "{{ destinationAccount }}", 
"destinationRegion": "{{ destinationRegion }}", 
"comment": "{{ comment }}"
}'
;