CancelExportTask - NeptuneAnalyticsAPI
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

CancelExportTask

Cancel the specified export task.

Request Syntax

DELETE /exporttasks/taskIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

taskIdentifier

The unique identifier of the export task.

Pattern: t-[a-z0-9]{10}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "destination": "string",
   "format": "string",
   "graphId": "string",
   "kmsKeyIdentifier": "string",
   "parquetType": "string",
   "roleArn": "string",
   "status": "string",
   "statusReason": "string",
   "taskId": "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.

destination

The Amazon S3 URI of the cancelled export task where data will be exported to.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

format

The format of the cancelled export task.

Type: String

Valid Values: PARQUET | CSV

graphId

The source graph identifier of the cancelled export task.

Type: String

Pattern: g-[a-z0-9]{10}

kmsKeyIdentifier

The KMS key identifier of the cancelled export task.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}

parquetType

The parquet type of the cancelled export task.

Type: String

Valid Values: COLUMNAR

roleArn

The ARN of the IAM role that will allow the exporting of data to the destination.

Type: String

Pattern: arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*

status

The current status of the export task. The status is CANCELLING when the export task is cancelled.

Type: String

Valid Values: INITIALIZING | EXPORTING | SUCCEEDED | FAILED | CANCELLING | CANCELLED | DELETED

statusReason

The reason that the export task has this status value.

Type: String

taskId

The unique identifier of the export task.

Type: String

Pattern: t-[a-z0-9]{10}

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

Raised when a conflict is encountered.

HTTP Status Code: 409

InternalServerException

A failure occurred on the server.

HTTP Status Code: 500

ResourceNotFoundException

A specified resource could not be located.

HTTP Status Code: 404

ThrottlingException

The exception was interrupted by throttling.

HTTP Status Code: 429

ValidationException

A resource could not be validated.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: