cancel_export_task¶
Operation¶
async
¶
cancel_export_task(input: CancelExportTaskInput, plugins: list[Plugin] | None = None) -> CancelExportTaskOutput
Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3. Any data that has already been written to the S3 bucket isn't removed.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CancelExportTaskInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CancelExportTaskOutput
|
An instance of |
Input¶
dataclass
¶
Output¶
dataclass
¶
Bases: _SerdeShape
Contains the details of a snapshot or cluster export to Amazon S3.
This data type is used as a response element in the
DescribeExportTasks operation.
Attributes¶
class-attribute
instance-attribute
¶
The data exported from the snapshot or cluster.
Valid Values:
-
database- Export all the data from a specified database. -
database.tabletable-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL. -
database.schemaschema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. -
database.schema.tabletable-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
class-attribute
instance-attribute
¶
export_task_identifier: str | None = ...
A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported.
class-attribute
instance-attribute
¶
failure_cause: str | None = ...
The reason the export failed, if it failed.
class-attribute
instance-attribute
¶
iam_role_arn: str | None = ...
The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.
class-attribute
instance-attribute
¶
kms_key_id: str | None = ...
The key identifier of the Amazon Web Services KMS key that is used to encrypt the data 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 export must have encryption and decryption permissions to use this KMS key.
class-attribute
instance-attribute
¶
percent_progress: int | None = ...
The progress of the snapshot or cluster export task as a percentage.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
class-attribute
instance-attribute
¶
s3_bucket: str | None = ...
The Amazon S3 bucket where the snapshot or cluster is exported to.
class-attribute
instance-attribute
¶
s3_prefix: str | None = ...
The Amazon S3 bucket prefix that is the file name and path of the exported data.
class-attribute
instance-attribute
¶
snapshot_time: datetime | None = ...
The time when the snapshot was created.
class-attribute
instance-attribute
¶
source_arn: str | None = ...
The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
class-attribute
instance-attribute
¶
source_type: str | None = ...
The type of source for the export.
class-attribute
instance-attribute
¶
status: str | None = ...
The progress status of the export task. The status can be one of the following:
-
CANCELED -
CANCELING -
COMPLETE -
FAILED -
IN_PROGRESS -
STARTING
class-attribute
instance-attribute
¶
task_end_time: datetime | None = ...
The time when the snapshot or cluster export task ended.
class-attribute
instance-attribute
¶
task_start_time: datetime | None = ...
The time when the snapshot or cluster export task started.