SecurityAgent / Client / list_artifacts

list_artifacts¶

SecurityAgent.Client.list_artifacts(**kwargs)¶

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

Request Syntax

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

Parameters:

agentSpaceId (string) –
[REQUIRED]

The unique identifier of the agent space to list artifacts for.
nextToken (string) – A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.
maxResults (integer) – The maximum number of results to return in a single call.

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) –
  
  The list of artifact summaries.
  - (dict) –
    
    Contains summary information about an artifact.
    - artifactId (string) –
      
      The unique identifier of the artifact.
    - fileName (string) –
      
      The file name of the artifact.
    - artifactType (string) –
      
      The file type of the artifact.
- nextToken (string) –
  
  A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

Exceptions

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