ExportTask - Amazon Relational Database Service
AWS services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with AWS services in China.

ExportTask

Contains the details of a snapshot export to Amazon S3.

This data type is used as a response element in the DescribeExportTasks action.

Contents

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

Required: No

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

Required: No

FailureCause

The reason the export failed, if it failed.

Type: String

Required: No

IamRoleArn

The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.

Type: String

Required: No

KmsKeyId

The ID of the AWS KMS key that is used to encrypt the snapshot when it's exported to Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key.

Type: String

Required: No

PercentProgress

The progress of the snapshot export task as a percentage.

Type: Integer

Required: No

S3Bucket

The Amazon S3 bucket that the snapshot is exported to.

Type: String

Required: No

S3Prefix

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

Type: String

Required: No

SnapshotTime

The time that the snapshot was created.

Type: Timestamp

Required: No

SourceArn

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

Type: String

Required: No

Status

The progress status of the export task.

Type: String

Required: No

TaskEndTime

The time that the snapshot export task completed.

Type: Timestamp

Required: No

TaskStartTime

The time that the snapshot export task started.

Type: Timestamp

Required: No

TotalExtractedDataInGB

The total amount of data exported, in gigabytes.

Type: Integer

Required: No

WarningMessage

A warning about the snapshot export task.

Type: String

Required: No

See Also

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