Continuum / Paginator / ListCodeIssueArtifacts

ListCodeIssueArtifacts¶

class Continuum.Paginator.ListCodeIssueArtifacts¶

paginator = client.get_paginator('list_code_issue_artifacts')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Continuum.Client.list_code_issue_artifacts().

Request Syntax

response_iterator = paginator.paginate(
    environmentId='string',
    issueId='string',
    artifactType='EVIDENCE'|'AGENT_COMMUNICATION'|'VALIDATION_EVIDENCE'|'REMEDIATION_PROPOSAL'|'DECISION'|'PATCH',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

environmentId (string) –
[REQUIRED]

The environment that owns the issue.
issueId (string) –
[REQUIRED]

The issue whose artifacts to list.
artifactType (string) – Optional filter for a semantic artifact category. Omit to list all artifacts attached to the issue.
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

{
    'items': [
        {
            'artifactId': 'string',
            'artifactType': 'EVIDENCE'|'AGENT_COMMUNICATION'|'VALIDATION_EVIDENCE'|'REMEDIATION_PROPOSAL'|'DECISION'|'PATCH',
            'mediaType': 'string',
            'producer': {
                'agent': 'string'
            },
            'contentSizeBytes': 123,
            'createdAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –

Contains the list of artifact summaries and an optional pagination token.
- items (list) –
  
  The artifacts attached to the issue, ordered by artifactId descending.
  - (dict) –
    
    A summary of an artifact returned in list responses.
    - artifactId (string) –
      
      The unique identifier of the artifact.
    - artifactType (string) –
      
      Semantic category of the artifact.
    - mediaType (string) –
      
      MIME type of the artifact content.
    - producer (dict) –
      
      The agent that produced the artifact.
      - agent (string) –
        
        Stable producer name, such as ContinuumValidation.
    - contentSizeBytes (integer) –
      
      Size of the artifact content in bytes. The content itself is returned by GetCodeIssueArtifact.
    - createdAt (datetime) –
      
      The timestamp when the artifact was created.
- NextToken (string) –
  
  A token to resume pagination.