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.
Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). You can have up to five backup copy requests in progress to a single destination Region per account.
You can use cross-Region backup copies for cross-Region disaster recovery. You can
periodically take backups and copy them to another Region so that in the event of
a disaster in the primary Region, you can restore from backup and recover availability
quickly in the other Region. You can make cross-Region copies only within your Amazon
Web Services partition. A partition is a grouping of Regions. Amazon Web Services
currently has three partitions: aws (Standard Regions), aws-cn (China
Regions), and aws-us-gov (Amazon Web Services GovCloud [US] Regions).
You can also use backup copies to clone your file dataset to another Region or within the same Region.
You can use the SourceRegion parameter to specify the Amazon Web Services Region
from which the backup will be copied. For example, if you make the call from the us-west-1
Region and want to copy a backup from the us-east-2 Region, you specify us-east-2
in the SourceRegion parameter to make a cross-Region copy. If you don't specify
a Region, the backup copy is created in the same Region where the request is sent
from (in-Region copy).
For more information about creating backup copies, see Copying backups in the Amazon FSx for Windows User Guide, Copying backups in the Amazon FSx for Lustre User Guide, and Copying backups in the Amazon FSx for OpenZFS User Guide.
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 BeginCopyBackup and EndCopyBackup.
Namespace: Amazon.FSx
Assembly: AWSSDK.FSx.dll
Version: 3.x.y.z
public abstract Task<CopyBackupResponse> CopyBackupAsync( CopyBackupRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the CopyBackup service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| BackupNotFoundException | No Amazon FSx backups were found based upon the supplied parameters. |
| BadRequestException | A generic error indicating a failure with a client request. |
| IncompatibleParameterErrorException | The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request. |
| IncompatibleRegionForMultiAZException | Amazon FSx doesn't support Multi-AZ Windows File Server copy backup in the destination Region, so the copied backup can't be restored. |
| InternalServerErrorException | A generic error indicating a server-side failure. |
| InvalidDestinationKmsKeyException | The Key Management Service (KMS) key of the destination backup is not valid. |
| InvalidRegionException | The Region provided for SourceRegion is not valid or is in a different Amazon Web Services partition. |
| InvalidSourceKmsKeyException | The Key Management Service (KMS) key of the source backup is not valid. |
| ServiceLimitExceededException | An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support. |
| SourceBackupUnavailableException | The request was rejected because the lifecycle status of the source backup isn't AVAILABLE. |
| UnsupportedOperationException | The requested operation is not supported for this resource or API. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer