CancelExportTask
Cancels an export task in progress that is exporting a snapshot to Amazon S3. Any data that has already been written to the S3 bucket isn't removed.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- ExportTaskIdentifier
-
The identifier of the snapshot export task to cancel.
Type: String
Required: Yes
Response Elements
The following elements are returned by the service.
- ExportOnly.member.N
-
The data exported from the snapshot. Valid values are the following:
-
database
- Export all the data from a specified database. -
database.table
table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL. -
database.schema
schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. -
database.schema.table
table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
Type: Array of strings
-
- ExportTaskIdentifier
-
A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is exported to.
Type: String
- FailureCause
-
The reason the export failed, if it failed.
Type: String
- IamRoleArn
-
The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
Type: String
- KmsKeyId
-
The key identifier of the AWS KMS key that is used to encrypt the snapshot when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key.
Type: String
- PercentProgress
-
The progress of the snapshot export task as a percentage.
Type: Integer
- S3Bucket
-
The Amazon S3 bucket that the snapshot is exported to.
Type: String
- S3Prefix
-
The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
Type: String
- SnapshotTime
-
The time that the snapshot was created.
Type: Timestamp
- SourceArn
-
The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
Type: String
- Status
-
The progress status of the export task.
Type: String
- TaskEndTime
-
The time that the snapshot export task completed.
Type: Timestamp
- TaskStartTime
-
The time that the snapshot export task started.
Type: Timestamp
- TotalExtractedDataInGB
-
The total amount of data exported, in gigabytes.
Type: Integer
- WarningMessage
-
A warning about the snapshot export task.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- ExportTaskNotFound
-
The export task doesn't exist.
HTTP Status Code: 404
- InvalidExportTaskStateFault
-
You can't cancel an export task that has completed.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: