TimestreamWrite / Client / list_batch_load_tasks

list_batch_load_tasks#

TimestreamWrite.Client.list_batch_load_tasks(**kwargs)#

Provides a list of batch load tasks, along with the name, status, when the task is resumable until, and other details. See code sample for details.

See also: AWS API Documentation

Request Syntax

response = client.list_batch_load_tasks(
    NextToken='string',
    MaxResults=123,
    TaskStatus='CREATED'|'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'PROGRESS_STOPPED'|'PENDING_RESUME'
)
Parameters:

  • NextToken (string) – A token to specify where to start paginating. This is the NextToken from a previously truncated response.

  • MaxResults (integer) – The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

  • TaskStatus (string) – Status of the batch load task.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'BatchLoadTasks': [
        {
            'TaskId': 'string',
            'TaskStatus': 'CREATED'|'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'PROGRESS_STOPPED'|'PENDING_RESUME',
            'DatabaseName': 'string',
            'TableName': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1),
            'ResumableUntil': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      A token to specify where to start paginating. Provide the next ListBatchLoadTasksRequest.

    • BatchLoadTasks (list) –

      A list of batch load task details.

      • (dict) –

        Details about a batch load task.

        • TaskId (string) –

          The ID of the batch load task.

        • TaskStatus (string) –

          Status of the batch load task.

        • DatabaseName (string) –

          Database name for the database into which a batch load task loads data.

        • TableName (string) –

          Table name for the table into which a batch load task loads data.

        • CreationTime (datetime) –

          The time when the Timestream batch load task was created.

        • LastUpdatedTime (datetime) –

          The time when the Timestream batch load task was last updated.

        • ResumableUntil (datetime) –

Exceptions

  • TimestreamWrite.Client.exceptions.InternalServerException

  • TimestreamWrite.Client.exceptions.AccessDeniedException

  • TimestreamWrite.Client.exceptions.ThrottlingException

  • TimestreamWrite.Client.exceptions.ValidationException

  • TimestreamWrite.Client.exceptions.InvalidEndpointException