Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListTaskExecutions

Returns a list of executions for an Amazon DataSync transfer task.

Request Syntax


{
   "MaxResults": number,
   "NextToken": "string",
   "TaskArn": "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

Specifies how many results you want in the response.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100.

Required: No

NextToken

Specifies an opaque string that indicates the position at which to begin the next list of results in the response.

Type: String

Length Constraints: Maximum length of 65535.

Pattern: [a-zA-Z0-9=_-]+

Required: No

TaskArn

Specifies the Amazon Resource Name (ARN) of the task that you want execution information about.

Type: String

Length Constraints: Maximum length of 128.

Pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}$

Required: No

Response Syntax


{
   "NextToken": "string",
   "TaskExecutions": [ 
      { 
         "Status": "string",
         "TaskExecutionArn": "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

The opaque string that indicates the position to begin the next list of results in the response.

Type: String

Length Constraints: Maximum length of 65535.

Pattern: [a-zA-Z0-9=_-]+

TaskExecutions

A list of the task's executions.

Type: Array of TaskExecutionListEntry 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 Amazon DataSync service.

HTTP Status Code: 500

InvalidRequestException

This exception is thrown when the client submits a malformed request.

HTTP Status Code: 400