SecurityAgent / Client / list_artifacts

list_artifacts¶

SecurityAgent.Client.list_artifacts(**kwargs)¶

Lists the artifacts for the associated agent space

Request Syntax

response = client.list_artifacts(
    agentSpaceId='string',
    nextToken='string',
    maxResults=123
)

Parameters:

agentSpaceId (string) –
[REQUIRED]

Unique identifier of the agent space
nextToken (string) – Token for pagination
maxResults (integer) – Maximum number of results to return

Return type:

dict

Returns:

Response Syntax

{
    'artifactSummaries': [
        {
            'artifactId': 'string',
            'fileName': 'string',
            'artifactType': 'TXT'|'PNG'|'JPEG'|'MD'|'PDF'|'DOCX'|'DOC'|'JSON'|'YAML'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- artifactSummaries (list) –
  
  List of artifact summaries
  - (dict) –
    
    Summary information about an artifact
    - artifactId (string) –
      
      Unique identifier of the artifact
    - fileName (string) –
      
      Name of the artifact file
    - artifactType (string) –
      
      Type of the artifact file
- nextToken (string) –
  
  Token for pagination to retrieve the next set of results

Exceptions

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