security_requirements

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

Overview

Name	security_requirements
Type	Resource
Id	aws.securityagent.security_requirements

Fields

The following fields are returned by SELECT queries:

batch_get_security_requirements

Name	Datatype	Description
errors	array	The list of errors for security requirements that failed to be retrieved.
security_requirements	array	The list of security requirements that were successfully retrieved.

list_security_requirements

Name	Datatype	Description
name	string	The name of the security requirement.
created_at	string (date-time)	The date and time the security requirement was created, in UTC format.
description	string	A description of the security requirement.
pack_id	string	The unique identifier of the pack containing the security requirement.
updated_at	string (date-time)	The date and time the security requirement was last updated, in UTC format.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
batch_get_security_requirements	select	region		Batch retrieves security requirements from a pack.
list_security_requirements	select	region		Lists security requirements within a pack.
batch_create_security_requirements	exec	region, packId, securityRequirements		Batch creates security requirements in a customer managed pack.
batch_delete_security_requirements	exec	region, packId, securityRequirementNames		Batch deletes security requirements from a customer managed pack.
batch_update_security_requirements	exec	region, packId, securityRequirements		Batch updates security requirements within a customer managed pack.
import_security_requirements	exec	region, packId, input		Imports security requirements from uploaded documents into a customer managed security requirement pack. The import process asynchronously extracts and generates structured security requirements from the provided source files.

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

batch_get_security_requirements

Batch retrieves security requirements from a pack.

SELECT
errors,
security_requirements
FROM aws.securityagent.security_requirements
WHERE region = '{{ region }}' -- required
;

list_security_requirements

Lists security requirements within a pack.

SELECT
name,
created_at,
description,
pack_id,
updated_at
FROM aws.securityagent.security_requirements
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

batch_create_security_requirements

Batch creates security requirements in a customer managed pack.

EXEC aws.securityagent.security_requirements.batch_create_security_requirements 
@region='{{ region }}' --required 
@@json=
'{
"packId": "{{ packId }}", 
"securityRequirements": "{{ securityRequirements }}"
}'
;

batch_delete_security_requirements

Batch deletes security requirements from a customer managed pack.

EXEC aws.securityagent.security_requirements.batch_delete_security_requirements 
@region='{{ region }}' --required 
@@json=
'{
"packId": "{{ packId }}", 
"securityRequirementNames": "{{ securityRequirementNames }}"
}'
;

batch_update_security_requirements

Batch updates security requirements within a customer managed pack.

EXEC aws.securityagent.security_requirements.batch_update_security_requirements 
@region='{{ region }}' --required 
@@json=
'{
"packId": "{{ packId }}", 
"securityRequirements": "{{ securityRequirements }}"
}'
;

import_security_requirements

Imports security requirements from uploaded documents into a customer managed security requirement pack. The import process asynchronously extracts and generates structured security requirements from the provided source files.

EXEC aws.securityagent.security_requirements.import_security_requirements 
@region='{{ region }}' --required 
@@json=
'{
"packId": "{{ packId }}", 
"input": "{{ input }}"
}'
;