Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . rds ]

describe-export-tasks

Description

Returns information about a snapshot export to Amazon S3. This API operation supports pagination.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

describe-export-tasks is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: ExportTasks

Synopsis

  describe-export-tasks
[--export-task-identifier <value>]
[--source-arn <value>]
[--filters <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--export-task-identifier (string)

The identifier of the snapshot export task to be described.

--source-arn (string)

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

--filters (list)

Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output.

Supported filters include the following:

  • export-task-identifier - An identifier for the snapshot export task.
  • s3-bucket - The Amazon S3 bucket the snapshot is exported to.
  • source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3
  • status - The status of the export task.

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Marker -> (string)

A pagination token that can be used in a later DescribeExportTasks request. A marker is used for pagination to identify the location to begin output for the next response of DescribeExportTasks .

ExportTasks -> (list)

Information about an export of a snapshot to Amazon S3.

(structure)

Contains the details of a snapshot export to Amazon S3.

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

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

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.