Returns a list of the AWS DataSync tasks you created.
Request Syntax
{
"Filters": [
{
"Name": "string",
"Operator": "string",
"Values": [ "string" ]
}
],
"MaxResults": number,
"NextToken": "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.
- Filters
-
You can use API filters to narrow down the list of resources returned by
ListTasks. For example, to retrieve all tasks on a specific source location, you can useListTaskswith filter nameLocationIdandOperator Equalswith the ARN for the location.Type: Array of TaskFilter objects
Required: No
- MaxResults
-
The maximum number of tasks to return.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
- NextToken
-
An opaque string that indicates the position at which to begin the next list of tasks.
Type: String
Length Constraints: Maximum length of 65535.
Pattern:
[a-zA-Z0-9=_-]+Required: No
Response Syntax
{
"NextToken": "string",
"Tasks": [
{
"Name": "string",
"Status": "string",
"TaskArn": "string",
"TaskMode": "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.
- NextToken
-
An opaque string that indicates the position at which to begin returning the next list of tasks.
Type: String
Length Constraints: Maximum length of 65535.
Pattern:
[a-zA-Z0-9=_-]+ - Tasks
-
A list of all the tasks that are returned.
Type: Array of TaskListEntry objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalException
-
This exception is thrown when an error occurs in the AWS DataSync service.
HTTP Status Code: 500
- InvalidRequestException
-
This exception is thrown when the client submits a 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:
