ListDataTransformationJobs
Lists data transformation jobs for your AWS account. Results can be filtered
by status, job name, and submit time window. Results are paginated. Use the
NextToken parameter to retrieve additional results.
Request Syntax
{
"JobName": "string",
"JobStatus": "string",
"MaxResults": number,
"NextToken": "string",
"SubmittedAfter": number,
"SubmittedBefore": number
}
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.
- JobName
-
Filters the results to include only jobs with the specified name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\p{L}\p{Z}\p{N}_.:/=+\-%@]*Required: No
- JobStatus
-
Filters the results to include only jobs with the specified status.
Type: String
Valid Values:
SUBMITTED | QUEUED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERRORS | FAILEDRequired: No
- MaxResults
-
The maximum number of jobs to return per page. If you don't specify a value, the service returns up to 100 results.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
The pagination token from a previous response. Pass this value to retrieve the next page of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
- SubmittedAfter
-
Filters the results to include only jobs submitted at or after this timestamp.
Type: Timestamp
Required: No
- SubmittedBefore
-
Filters the results to include only jobs submitted at or before this timestamp.
Type: Timestamp
Required: No
Response Syntax
{
"Items": [
{
"EndTime": number,
"JobId": "string",
"JobName": "string",
"JobStatus": "string",
"SourceFormat": "string",
"SubmitTime": number
}
],
"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.
- Items
-
The list of data transformation job summaries.
Type: Array of TransformationJobSummary objects
- NextToken
-
The pagination token to use in the next request. If this value is
null, there are no more results.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
Access is denied. Your account is not authorized to perform this operation.
HTTP Status Code: 400
- InternalServerException
-
An unknown internal error occurred in the service.
HTTP Status Code: 500
- ThrottlingException
-
The user has exceeded their maximum number of allowed calls to the given API.
HTTP Status Code: 400
- ValidationException
-
The user input parameter was invalid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: