ListBatchLoadTasks
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.
Request Syntax
{
"MaxResults": number
,
"NextToken": "string
",
"TaskStatus": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- MaxResults
-
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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
Type: String
Required: No
- TaskStatus
-
Status of the batch load task.
Type: String
Valid Values:
CREATED | IN_PROGRESS | FAILED | SUCCEEDED | PROGRESS_STOPPED | PENDING_RESUME
Required: No
Response Syntax
{
"BatchLoadTasks": [
{
"CreationTime": number,
"DatabaseName": "string",
"LastUpdatedTime": number,
"ResumableUntil": number,
"TableName": "string",
"TaskId": "string",
"TaskStatus": "string"
}
],
"NextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- BatchLoadTasks
-
A list of batch load task details.
Type: Array of BatchLoadTask objects
- NextToken
-
A token to specify where to start paginating. Provide the next ListBatchLoadTasksRequest.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You are not authorized to perform this action.
HTTP Status Code: 400
- InternalServerException
-
Timestream was unable to fully process this request because of an internal server error.
HTTP Status Code: 500
- InvalidEndpointException
-
The requested endpoint was not valid.
HTTP Status Code: 400
- ThrottlingException
-
Too many requests were made by a user and they exceeded the service quotas. The request was throttled.
HTTP Status Code: 400
- ValidationException
-
An invalid or malformed request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: