start-export-task¶

Description¶

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

This command doesn’t apply to RDS Custom.

Synopsis¶

  start-export-task
--export-task-identifier <value>
--source-arn <value>
--s3-bucket-name <value>
--iam-role-arn <value>
--kms-key-id <value>
[--s3-prefix <value>]
[--export-only <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--export-task-identifier (string)

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.

--source-arn (string)

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

--s3-bucket-name (string)

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

--iam-role-arn (string)

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

--kms-key-id (string)

The ID of the Amazon Web Services KMS key to use to encrypt the snapshot 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 execute the following operations. These can be set in the Amazon Web Services KMS key policy:

GrantOperation.Encrypt

GrantOperation.Decrypt

GrantOperation.GenerateDataKey

GrantOperation.GenerateDataKeyWithoutPlaintext

GrantOperation.ReEncryptFrom

GrantOperation.ReEncryptTo

GrantOperation.CreateGrant

GrantOperation.DescribeKey

GrantOperation.RetireGrant

--s3-prefix (string)

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

--export-only (list)

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.

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To export a snapshot to Amazon S3

The following start-export-task example exports a DB snapshot named db5-snapshot-test to the Amazon S3 bucket named mybucket.

aws rds start-export-task \
    --export-task-identifier my-s3-export \
    --source-arn arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test \
    --s3-bucket-name mybucket \
    --iam-role-arn arn:aws:iam::123456789012:role/service-role/ExportRole \
    --kms-key-id arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff

Output:

{
    "ExportTaskIdentifier": "my-s3-export",
    "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test",
    "SnapshotTime": "2020-03-27T20:48:42.023Z",
    "S3Bucket": "mybucket",
    "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole",
    "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff",
    "Status": "STARTING",
    "PercentProgress": 0,
    "TotalExtractedDataInGB": 0
}

For more information, see Exporting a Snapshot to an Amazon S3 Bucket in the Amazon RDS User Guide.

Output¶

ExportTaskIdentifier -> (string)

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.

SourceArn -> (string)

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

ExportOnly -> (list)

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.

(string)

SnapshotTime -> (timestamp)

The time that the snapshot was created.

TaskStartTime -> (timestamp)

The time that the snapshot export task started.

TaskEndTime -> (timestamp)

The time that the snapshot export task completed.

S3Bucket -> (string)

The Amazon S3 bucket that the snapshot is exported to.

S3Prefix -> (string)

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

IamRoleArn -> (string)

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

KmsKeyId -> (string)

The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot 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 snapshot export must have encryption and decryption permissions to use this KMS key.

Status -> (string)

The progress status of the export task.

PercentProgress -> (integer)

The progress of the snapshot export task as a percentage.

TotalExtractedDataInGB -> (integer)

The total amount of data exported, in gigabytes.

FailureCause -> (string)

The reason the export failed, if it failed.

WarningMessage -> (string)

A warning about the snapshot export task.

Table of Contents

Feedback

User Guide