artifacts

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

Overview

Name	artifacts
Type	Resource
Id	aws.securityagent.artifacts

Fields

The following fields are returned by SELECT queries:

get_artifact

Name	Datatype	Description
agent_space_id	string	Unique identifier of the agent space.
artifact	object	The artifact content and type.
artifact_id	string	The id of the artifact.
file_name	string	The file name of the artifact.
updated_at	string (date-time)	The date and time the artifact was last updated, in UTC format.

list_artifacts

Name	Datatype	Description
artifact_id	string	The id of the artifact.
artifact_type	string	Supported file extension types for artifacts. (TXT, PNG, JPEG, MD, PDF, DOCX, DOC, JSON, YAML)
file_name	string	The file name of the artifact.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_artifact	select	region		Retrieves an artifact from an agent space.
list_artifacts	select	region		Returns a paginated list of artifact summaries for the specified agent space.
add_artifact	update	region, agentSpaceId, artifactContent, artifactType, fileName		Uploads an artifact to an agent space. Artifacts provide additional context for security testing, such as architecture diagrams, API specifications, or configuration files.
delete_artifact	delete	region		Deletes an artifact from an agent space.

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

get_artifact

Retrieves an artifact from an agent space.

SELECT
agent_space_id,
artifact,
artifact_id,
file_name,
updated_at
FROM aws.securityagent.artifacts
WHERE region = '{{ region }}' -- required
;

list_artifacts

Returns a paginated list of artifact summaries for the specified agent space.

SELECT
artifact_id,
artifact_type,
file_name
FROM aws.securityagent.artifacts
WHERE region = '{{ region }}' -- required
;

UPDATE examples

add_artifact

Uploads an artifact to an agent space. Artifacts provide additional context for security testing, such as architecture diagrams, API specifications, or configuration files.

UPDATE aws.securityagent.artifacts
SET 
agentSpaceId = '{{ agentSpaceId }}',
artifactContent = '{{ artifactContent }}',
artifactType = '{{ artifactType }}',
fileName = '{{ fileName }}'
WHERE 
region = '{{ region }}' --required
AND agentSpaceId = '{{ agentSpaceId }}' --required
AND artifactContent = '{{ artifactContent }}' --required
AND artifactType = '{{ artifactType }}' --required
AND fileName = '{{ fileName }}' --required
RETURNING
artifact_id;

DELETE examples

delete_artifact

Deletes an artifact from an agent space.

DELETE FROM aws.securityagent.artifacts
WHERE region = '{{ region }}' --required
;