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.

This action creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.

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 BeginCreateLegalHold and EndCreateLegalHold.

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

Syntax

C#
public abstract Task<CreateLegalHoldResponse> CreateLegalHoldAsync(
         CreateLegalHoldRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Backup.Model.CreateLegalHoldRequest

Container for the necessary parameters to execute the CreateLegalHold 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 CreateLegalHold service method, as returned by Backup.

Exceptions

ExceptionCondition
InvalidParameterValueException Indicates that something is wrong with a parameter's value. For example, the value is out of range.
LimitExceededException A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
MissingParameterValueException Indicates that a required parameter is missing.
ServiceUnavailableException The request failed due to a temporary failure of the server.

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