DescribeExportTasks - Amazon Relational Database Service
Request ParametersResponse ElementsErrorsSee Also

DescribeExportTasks

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

Request Parameters

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

ExportTaskIdentifier

The identifier of the snapshot or cluster export task to be described.

Type: String

Required: No

Filters.Filter.N

Filters specify one or more snapshot or cluster exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.

Supported filters include the following:

  • export-task-identifier - An identifier for the snapshot or cluster export task.

  • s3-bucket - The Amazon S3 bucket the data is exported to.

  • source-arn - The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.

  • status - The status of the export task. Must be lowercase. Valid statuses are the following:

    • canceled

    • canceling

    • complete

    • failed

    • in_progress

    • starting

Type: Array of Filter objects

Required: No

Marker

An optional pagination token provided by a previous DescribeExportTasks request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

Type: String

Required: No

MaxRecords

The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later DescribeExportTasks request to retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Type: Integer

Valid Range: Minimum value of 20. Maximum value of 100.

Required: No

SourceArn

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

Type: String

Required: No

SourceType

The type of source for the export.

Type: String

Valid Values: SNAPSHOT | CLUSTER

Required: No

Response Elements

The following elements are returned by the service.

ExportTasks.ExportTask.N

Information about an export of a snapshot or cluster to Amazon S3.

Type: Array of ExportTask objects

Marker

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.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

ExportTaskNotFound

The export task doesn't exist.

HTTP Status Code: 404

See Also

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