MainframeModernization / Client / get_data_set_export_task

get_data_set_export_task¶

MainframeModernization.Client.get_data_set_export_task(**kwargs)¶

Gets the status of a data set import task initiated with the CreateDataSetExportTask operation.

Request Syntax

response = client.get_data_set_export_task(
    applicationId='string',
    taskId='string'
)

Parameters:

applicationId (string) –
[REQUIRED]

The application identifier.
taskId (string) –
[REQUIRED]

The task identifier returned by the CreateDataSetExportTask operation.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- kmsKeyArn (string) –
  
  The identifier of a customer managed key used for exported data set encryption.
- status (string) –
  
  The status of the task.
- statusReason (string) –
  
  If dataset export failed, the failure reason will show here.
- summary (dict) –
  
  A summary of the status of the 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 task identifier.

Exceptions

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