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.

Implementation for accessing BackupStorage

The frontend service for Cryo Storage.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.BackupStorage.AmazonBackupStorageClient

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

Syntax

C#
public class AmazonBackupStorageClient : AmazonServiceClient
         IAmazonBackupStorage, IAmazonService, IDisposable

The AmazonBackupStorageClient type exposes the following members

Constructors

NameDescription
Public Method AmazonBackupStorageClient()

Constructs AmazonBackupStorageClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

Public Method AmazonBackupStorageClient(RegionEndpoint)

Constructs AmazonBackupStorageClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

Public Method AmazonBackupStorageClient(AmazonBackupStorageConfig)

Constructs AmazonBackupStorageClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

Public Method AmazonBackupStorageClient(AWSCredentials)

Constructs AmazonBackupStorageClient with AWS Credentials

Public Method AmazonBackupStorageClient(AWSCredentials, RegionEndpoint)

Constructs AmazonBackupStorageClient with AWS Credentials

Public Method AmazonBackupStorageClient(AWSCredentials, AmazonBackupStorageConfig)

Constructs AmazonBackupStorageClient with AWS Credentials and an AmazonBackupStorageClient Configuration object.

Public Method AmazonBackupStorageClient(string, string)

Constructs AmazonBackupStorageClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonBackupStorageClient(string, string, RegionEndpoint)

Constructs AmazonBackupStorageClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonBackupStorageClient(string, string, AmazonBackupStorageConfig)

Constructs AmazonBackupStorageClient with AWS Access Key ID, AWS Secret Key and an AmazonBackupStorageClient Configuration object.

Public Method AmazonBackupStorageClient(string, string, string)

Constructs AmazonBackupStorageClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonBackupStorageClient(string, string, string, RegionEndpoint)

Constructs AmazonBackupStorageClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonBackupStorageClient(string, string, string, AmazonBackupStorageConfig)

Constructs AmazonBackupStorageClient with AWS Access Key ID, AWS Secret Key and an AmazonBackupStorageClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.
Public Property Paginators Amazon.BackupStorage.Model.IBackupStoragePaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method DeleteObject(DeleteObjectRequest)

Delete Object from the incremental base Backup.

Public Method DeleteObjectAsync(DeleteObjectRequest, CancellationToken)

Delete Object from the incremental base Backup.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetChunk(GetChunkRequest)

Gets the specified object's chunk.

Public Method GetChunkAsync(GetChunkRequest, CancellationToken)

Gets the specified object's chunk.

Public Method GetObjectMetadata(GetObjectMetadataRequest)

Get metadata associated with an Object.

Public Method GetObjectMetadataAsync(GetObjectMetadataRequest, CancellationToken)

Get metadata associated with an Object.

Public Method ListChunks(ListChunksRequest)

List chunks in a given Object

Public Method ListChunksAsync(ListChunksRequest, CancellationToken)

List chunks in a given Object

Public Method ListObjects(ListObjectsRequest)

List all Objects in a given Backup.

Public Method ListObjectsAsync(ListObjectsRequest, CancellationToken)

List all Objects in a given Backup.

Public Method NotifyObjectComplete(NotifyObjectCompleteRequest)

Complete upload

Public Method NotifyObjectCompleteAsync(NotifyObjectCompleteRequest, CancellationToken)

Complete upload

Public Method PutChunk(PutChunkRequest)

Upload chunk.

Public Method PutChunkAsync(PutChunkRequest, CancellationToken)

Upload chunk.

Public Method PutObject(PutObjectRequest)

Upload object that can store object metadata String and data blob in single API call using inline chunk field.

Public Method PutObjectAsync(PutObjectRequest, CancellationToken)

Upload object that can store object metadata String and data blob in single API call using inline chunk field.

Public Method StartObject(StartObjectRequest)

Start upload containing one or many chunks.

Public Method StartObjectAsync(StartObjectRequest, CancellationToken)

Start upload containing one or many chunks.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5