Artifact / Client / list_reports

list_reports#

Artifact.Client.list_reports(**kwargs)#

List available reports.

Request Syntax

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

Parameters:

maxResults (integer) – Maximum number of resources to return in the paginated response.
nextToken (string) – Pagination token to request the next page of resources.

Return type:

dict

Returns:

Response Syntax

{
    'reports': [
        {
            'id': 'string',
            'name': 'string',
            'state': 'PUBLISHED'|'UNPUBLISHED',
            'arn': 'string',
            'version': 123,
            'uploadState': 'PROCESSING'|'COMPLETE'|'FAILED'|'FAULT',
            'description': 'string',
            'periodStart': datetime(2015, 1, 1),
            'periodEnd': datetime(2015, 1, 1),
            'series': 'string',
            'category': 'string',
            'companyName': 'string',
            'productName': 'string',
            'statusMessage': 'string',
            'acceptanceType': 'PASSTHROUGH'|'EXPLICIT'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- reports (list) –
  
  List of report resources.
  - (dict) –
    
    Summary for report resource.
    - id (string) –
      
      Unique resource ID for the report resource.
    - name (string) –
      
      Name for the report resource.
    - state (string) –
      
      Current state of the report resource.
    - arn (string) –
      
      ARN for the report resource.
    - version (integer) –
      
      Version for the report resource.
    - uploadState (string) –
      
      The current state of the document upload.
    - description (string) –
      
      Description for the report resource.
    - periodStart (datetime) –
      
      Timestamp indicating the report resource effective start.
    - periodEnd (datetime) –
      
      Timestamp indicating the report resource effective end.
    - series (string) –
      
      Series for the report resource.
    - category (string) –
      
      Category for the report resource.
    - companyName (string) –
      
      Associated company name for the report resource.
    - productName (string) –
      
      Associated product name for the report resource.
    - statusMessage (string) –
      
      The message associated with the current upload state.
    - acceptanceType (string) –
      
      Acceptance type for report.
- nextToken (string) –
  
  Pagination token to request the next page of resources.

Exceptions

Artifact.Client.exceptions.ResourceNotFoundException
Artifact.Client.exceptions.ThrottlingException
Artifact.Client.exceptions.AccessDeniedException
Artifact.Client.exceptions.InternalServerException
Artifact.Client.exceptions.ValidationException
Artifact.Client.exceptions.ServiceQuotaExceededException