Skip to content

Cancel Export Task

rds_cancel_export_task R Documentation

Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3

Description

Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3. Any data that has already been written to the S3 bucket isn't removed.

Usage

rds_cancel_export_task(ExportTaskIdentifier)

Arguments

ExportTaskIdentifier

[required] The identifier of the snapshot or cluster export task to cancel.

Value

A list with the following syntax:

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$cancel_export_task(
  ExportTaskIdentifier = "string"
)