SecurityAgent / Client / add_artifact

add_artifact

SecurityAgent.Client.add_artifact(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.add_artifact(
    agentSpaceId='string',
    artifactContent=b'bytes',
    artifactType='TXT'|'PNG'|'JPEG'|'MD'|'PDF'|'DOCX'|'DOC'|'JSON'|'YAML',
    fileName='string'
)

Parameters:

• agentSpaceId (string) –

  [REQUIRED]

  The unique identifier of the agent space to add the artifact to.

• artifactContent (bytes) –

  [REQUIRED]

  The binary content of the artifact to upload.

• artifactType (string) –

  [REQUIRED]

  The file type of the artifact. Valid values include TXT, PNG, JPEG, MD, PDF, DOCX, DOC, JSON, and YAML.

• fileName (string) –

  [REQUIRED]

  The file name of the artifact.

Return type:

dict

Returns:

Response Syntax

{
    'artifactId': 'string'
}

Response Structure

• (dict) –

  • artifactId (string) –

    The unique identifier assigned to the uploaded artifact.

Exceptions

• SecurityAgent.Client.exceptions.ValidationException

• SecurityAgent.Client.exceptions.InternalServerException

• SecurityAgent.Client.exceptions.ResourceNotFoundException

• SecurityAgent.Client.exceptions.ThrottlingException

• SecurityAgent.Client.exceptions.AccessDeniedException