StartExportTask - Amazon Relational Database Service

StartExportTask

Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ExportOnly.member.N

The data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. 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 to be exported to.

Type: String

Required: Yes

IamRoleArn

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

Type: String

Required: Yes

KmsKeyId

The ID of the AWS KMS key to use to encrypt the snapshot 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 caller of this operation must be authorized to execute the following operations. These can be set in the KMS key policy:

  • GrantOperation.Encrypt

  • GrantOperation.Decrypt

  • GrantOperation.GenerateDataKey

  • GrantOperation.GenerateDataKeyWithoutPlaintext

  • GrantOperation.ReEncryptFrom

  • GrantOperation.ReEncryptTo

  • GrantOperation.CreateGrant

  • GrantOperation.DescribeKey

  • GrantOperation.RetireGrant

Type: String

Required: Yes

S3BucketName

The name of the Amazon S3 bucket to export the snapshot to.

Type: String

Required: Yes

S3Prefix

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

Type: String

Required: No

SourceArn

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

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

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.

DBClusterSnapshotNotFoundFault

DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.

HTTP Status Code: 404

DBSnapshotNotFound

DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

HTTP Status Code: 404

ExportTaskAlreadyExists

You can't start an export task that's already running.

HTTP Status Code: 400

IamRoleMissingPermissions

The IAM role requires additional permissions to export to an Amazon S3 bucket.

HTTP Status Code: 400

IamRoleNotFound

The IAM role is missing for exporting to an Amazon S3 bucket.

HTTP Status Code: 404

InvalidExportOnly

The export is invalid for exporting to an Amazon S3 bucket.

HTTP Status Code: 400

InvalidExportSourceState

The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.

HTTP Status Code: 400

InvalidS3BucketFault

The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.

HTTP Status Code: 400

KMSKeyNotAccessibleFault

An error occurred accessing an AWS KMS key.

HTTP Status Code: 400

See Also

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