Skip to content

RDS  >  Structures  >  ExportTask

ExportTask

Structure Class

ExportTask 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

export_only class-attribute instance-attribute 
export_only: list[str] | None = ...

The data exported from the snapshot or cluster.

Valid Values:

  • database - Export all the data from a specified database.

  • database.table table-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.schema schema-name - Export a database schema of the snapshot or cluster. 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.

export_task_identifier 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.

failure_cause class-attribute instance-attribute 
failure_cause: str | None = ...

The reason the export failed, if it failed.

iam_role_arn 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.

kms_key_id 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.

percent_progress class-attribute instance-attribute 
percent_progress: int | None = ...

The progress of the snapshot or cluster export task as a percentage.

s3_bucket class-attribute instance-attribute 
s3_bucket: str | None = ...

The Amazon S3 bucket where the snapshot or cluster is exported to.

s3_prefix class-attribute instance-attribute 
s3_prefix: str | None = ...

The Amazon S3 bucket prefix that is the file name and path of the exported data.

snapshot_time class-attribute instance-attribute 
snapshot_time: datetime | None = ...

The time when the snapshot was created.

source_arn class-attribute instance-attribute 
source_arn: str | None = ...

The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.

source_type class-attribute instance-attribute 
source_type: str | None = ...

The type of source for the export.

status 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

task_end_time class-attribute instance-attribute 
task_end_time: datetime | None = ...

The time when the snapshot or cluster export task ended.

task_start_time class-attribute instance-attribute 
task_start_time: datetime | None = ...

The time when the snapshot or cluster export task started.

total_extracted_data_in_gb class-attribute instance-attribute 
total_extracted_data_in_gb: int | None = ...

The total amount of data exported, in gigabytes.

warning_message class-attribute instance-attribute 
warning_message: str | None = ...

A warning about the snapshot or cluster export task.