SecurityAgent / Paginator / ListArtifacts

ListArtifacts¶

class SecurityAgent.Paginator.ListArtifacts¶

paginator = client.get_paginator('list_artifacts')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from SecurityAgent.Client.list_artifacts().

Request Syntax

response_iterator = paginator.paginate(
    agentSpaceId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

agentSpaceId (string) –
[REQUIRED]

Unique identifier of the agent space
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

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) –
  
  A token to resume pagination.