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.

Returns BackupPlan details for the specified BackupPlanId. The details are the body of a backup plan in JSON format, in addition to plan metadata.

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 BeginGetBackupPlan and EndGetBackupPlan.

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

Syntax

C#
public abstract Task<GetBackupPlanResponse> GetBackupPlanAsync(
         GetBackupPlanRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Backup.Model.GetBackupPlanRequest

Container for the necessary parameters to execute the GetBackupPlan 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 GetBackupPlan 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.
MissingParameterValueException Indicates that a required parameter is missing.
ResourceNotFoundException A resource that is required for the action doesn't exist.
ServiceUnavailableException The request failed due to a temporary failure of the server.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also