AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Starts an export of DB snapshot or DB cluster data to Amazon S3. The provided IAM role must have access to the S3 bucket.

You can't export snapshot data from RDS Custom DB instances. For more information, see Supported Regions and DB engines for exporting snapshots to S3 in Amazon RDS.

For more information on exporting DB snapshot data, see Exporting DB snapshot data to Amazon S3 in the Amazon RDS User Guide or Exporting DB cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.

For more information on exporting DB cluster data, see Exporting DB cluster data to Amazon S3 in the Amazon Aurora User Guide.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginStartExportTask and EndStartExportTask.

Namespace: Amazon.RDS
Assembly: AWSSDK.RDS.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<StartExportTaskResponse> StartExportTaskAsync(
         StartExportTaskRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.RDS.Model.StartExportTaskRequest

Container for the necessary parameters to execute the StartExportTask service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the StartExportTask service method, as returned by RDS.

Exceptions

ExceptionCondition
DBClusterNotFoundException DBClusterIdentifier doesn't refer to an existing DB cluster.
DBClusterSnapshotNotFoundException DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
DBSnapshotNotFoundException DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
ExportTaskAlreadyExistsException You can't start an export task that's already running.
IamRoleMissingPermissionsException The IAM role requires additional permissions to export to an Amazon S3 bucket.
IamRoleNotFoundException The IAM role is missing for exporting to an Amazon S3 bucket.
InvalidExportOnlyException The export is invalid for exporting to an Amazon S3 bucket.
InvalidExportSourceStateException The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.
InvalidS3BucketException The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.
KMSKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also