MainframeModernization / Paginator / ListDataSetExportHistory

ListDataSetExportHistory¶

class MainframeModernization.Paginator.ListDataSetExportHistory¶

paginator = client.get_paginator('list_data_set_export_history')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from MainframeModernization.Client.list_data_set_export_history().

Request Syntax

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

Parameters:

applicationId (string) –
[REQUIRED]

The unique identifier of the application.
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

{
    'dataSetExportTasks': [
        {
            'status': 'Creating'|'Running'|'Completed'|'Failed',
            'statusReason': 'string',
            'summary': {
                'failed': 123,
                'inProgress': 123,
                'pending': 123,
                'succeeded': 123,
                'total': 123
            },
            'taskId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- dataSetExportTasks (list) –
  
  The data set export tasks.
  - (dict) –
    
    Contains information about a data set export task.
    - status (string) –
      
      The status of the data set export task.
    - statusReason (string) –
      
      If dataset exports failed, the failure reason will show here.
    - summary (dict) –
      
      A summary of the data set export task.
      - failed (integer) –
        
        The number of data set exports that have failed.
      - inProgress (integer) –
        
        The number of data set exports that are in progress.
      - pending (integer) –
        
        The number of data set exports that are pending.
      - succeeded (integer) –
        
        The number of data set exports that have succeeded.
      - total (integer) –
        
        The total number of data set exports.
    - taskId (string) –
      
      The identifier of the data set export task.
- NextToken (string) –
  
  A token to resume pagination.