Skip to content

RDS  >  Operations  >  start_export_task

start_export_task

Operation

start_export_task async 

start_export_task(input: StartExportTaskInput, plugins: list[Plugin] | None = None) -> StartExportTaskOutput

Starts an export of DB snapshot or DB cluster data to Amazon S3. The provided IAM role must have access to the S3 bucket.

You can't export snapshot data from RDS Custom DB instances. For more information, see Supported Regions and DB engines for exporting snapshots to S3 in Amazon RDS.

For more information on exporting DB snapshot data, see Exporting DB snapshot data to Amazon S3 in the Amazon RDS User Guide or Exporting DB cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.

For more information on exporting DB cluster data, see Exporting DB cluster data to Amazon S3 in the Amazon Aurora User Guide.

Parameters:

Name Type Description Default
input StartExportTaskInput

An instance of StartExportTaskInput.

 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
StartExportTaskOutput

An instance of StartExportTaskOutput.

Input

StartExportTaskInput dataclass

Bases: _SerdeShape

Dataclass for StartExportTaskInput structure.

Attributes

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

The data to be exported from the snapshot or cluster. If this parameter isn't provided, all of the data is exported.

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 export task. This ID isn't an identifier for the Amazon S3 bucket where the data is to be exported.

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

The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.

In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon RDS or Amazon Aurora to an S3 bucket:

  • s3:PutObject*

  • s3:GetObject*

  • s3:ListBucket

  • s3:DeleteObject*

  • s3:GetBucketLocation

In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows the Amazon Resource Name (ARN) format for accessing S3:

  • arn:aws:s3:::your-s3-bucket

  • arn:aws:s3:::your-s3-bucket/*

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

The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the Amazon Web Services KMS key policy:

  • kms:CreateGrant

  • kms:DescribeKey

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

The name of the Amazon S3 bucket to export the snapshot or cluster data to.

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

The Amazon S3 bucket prefix to use as the file name and path of the exported data.

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

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

Output

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

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

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.

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.