SecurityAgent / Client / get_artifact

get_artifact¶

SecurityAgent.Client.get_artifact(**kwargs)¶

Retrieves an artifact from an agent space.

Request Syntax

response = client.get_artifact(
    agentSpaceId='string',
    artifactId='string'
)

Parameters:

agentSpaceId (string) –
[REQUIRED]

The unique identifier of the agent space that contains the artifact.
artifactId (string) –
[REQUIRED]

The unique identifier of the artifact to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'agentSpaceId': 'string',
    'artifactId': 'string',
    'artifact': {
        'contents': 'string',
        'type': 'TXT'|'PNG'|'JPEG'|'MD'|'PDF'|'DOCX'|'DOC'|'JSON'|'YAML'
    },
    'fileName': 'string',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- agentSpaceId (string) –
  
  The unique identifier of the agent space that contains the artifact.
- artifactId (string) –
  
  The unique identifier of the artifact.
- artifact (dict) –
  
  The artifact content and type.
  - contents (string) –
    
    The content of the artifact.
  - type (string) –
    
    The file type of the artifact.
- fileName (string) –
  
  The file name of the artifact.
- updatedAt (datetime) –
  
  The date and time the artifact was last updated, in UTC format.

Exceptions

SecurityAgent.Client.exceptions.ValidationException
SecurityAgent.Client.exceptions.InternalServerException
SecurityAgent.Client.exceptions.ResourceNotFoundException
SecurityAgent.Client.exceptions.ThrottlingException
SecurityAgent.Client.exceptions.AccessDeniedException