Skip to content

Describe Export Tasks

rds_describe_export_tasks R Documentation

Returns information about a snapshot or cluster export to Amazon S3

Description

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

Usage

rds_describe_export_tasks(ExportTaskIdentifier, SourceArn, Filters,
  Marker, MaxRecords, SourceType)

Arguments

ExportTaskIdentifier

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

SourceArn

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

Filters

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

Marker

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

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 describe_export_tasks request to retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

SourceType

The type of source for the export.

Value

A list with the following syntax: 

list(
  Marker = "string",
  ExportTasks = list(
    list(
      ExportTaskIdentifier = "string",
      SourceArn = "string",
      ExportOnly = list(
        "string"
      ),
      SnapshotTime = as.POSIXct(
        "2015-01-01"
      ),
      TaskStartTime = as.POSIXct(
        "2015-01-01"
      ),
      TaskEndTime = as.POSIXct(
        "2015-01-01"
      ),
      S3Bucket = "string",
      S3Prefix = "string",
      IamRoleArn = "string",
      KmsKeyId = "string",
      Status = "string",
      PercentProgress = 123,
      TotalExtractedDataInGB = 123,
      FailureCause = "string",
      WarningMessage = "string",
      SourceType = "SNAPSHOT"|"CLUSTER"
    )
  )
)

Request syntax

svc$describe_export_tasks(
  ExportTaskIdentifier = "string",
  SourceArn = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  Marker = "string",
  MaxRecords = 123,
  SourceType = "SNAPSHOT"|"CLUSTER"
)