AWS SDK for C++  1.9.104
AWS SDK for C++
Public Types | Public Member Functions | List of all members
Aws::EBS::EBSClient Class Reference

#include <EBSClient.h>

+ Inheritance diagram for Aws::EBS::EBSClient:

Public Types

typedef Aws::Client::AWSJsonClient BASECLASS
 
- Public Types inherited from Aws::Client::AWSJsonClient
typedef AWSClient BASECLASS
 

Public Member Functions

 EBSClient (const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 EBSClient (const Aws::Auth::AWSCredentials &credentials, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 EBSClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
virtual ~EBSClient ()
 
virtual Model::CompleteSnapshotOutcome CompleteSnapshot (const Model::CompleteSnapshotRequest &request) const
 
virtual Model::CompleteSnapshotOutcomeCallable CompleteSnapshotCallable (const Model::CompleteSnapshotRequest &request) const
 
virtual void CompleteSnapshotAsync (const Model::CompleteSnapshotRequest &request, const CompleteSnapshotResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetSnapshotBlockOutcome GetSnapshotBlock (const Model::GetSnapshotBlockRequest &request) const
 
virtual Model::GetSnapshotBlockOutcomeCallable GetSnapshotBlockCallable (const Model::GetSnapshotBlockRequest &request) const
 
virtual void GetSnapshotBlockAsync (const Model::GetSnapshotBlockRequest &request, const GetSnapshotBlockResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListChangedBlocksOutcome ListChangedBlocks (const Model::ListChangedBlocksRequest &request) const
 
virtual Model::ListChangedBlocksOutcomeCallable ListChangedBlocksCallable (const Model::ListChangedBlocksRequest &request) const
 
virtual void ListChangedBlocksAsync (const Model::ListChangedBlocksRequest &request, const ListChangedBlocksResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListSnapshotBlocksOutcome ListSnapshotBlocks (const Model::ListSnapshotBlocksRequest &request) const
 
virtual Model::ListSnapshotBlocksOutcomeCallable ListSnapshotBlocksCallable (const Model::ListSnapshotBlocksRequest &request) const
 
virtual void ListSnapshotBlocksAsync (const Model::ListSnapshotBlocksRequest &request, const ListSnapshotBlocksResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::PutSnapshotBlockOutcome PutSnapshotBlock (const Model::PutSnapshotBlockRequest &request) const
 
virtual Model::PutSnapshotBlockOutcomeCallable PutSnapshotBlockCallable (const Model::PutSnapshotBlockRequest &request) const
 
virtual void PutSnapshotBlockAsync (const Model::PutSnapshotBlockRequest &request, const PutSnapshotBlockResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::StartSnapshotOutcome StartSnapshot (const Model::StartSnapshotRequest &request) const
 
virtual Model::StartSnapshotOutcomeCallable StartSnapshotCallable (const Model::StartSnapshotRequest &request) const
 
virtual void StartSnapshotAsync (const Model::StartSnapshotRequest &request, const StartSnapshotResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
void OverrideEndpoint (const Aws::String &endpoint)
 
- Public Member Functions inherited from Aws::Client::AWSJsonClient
 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSJsonClient ()=default
 
- Public Member Functions inherited from Aws::Client::AWSClient
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSClient ()
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
void DisableRequestProcessing ()
 
void EnableRequestProcessing ()
 
virtual const char * GetServiceClientName () const
 
virtual void SetServiceClientName (const Aws::String &name)
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::Client::AWSJsonClient
virtual AWSError< CoreErrorsBuildAWSError (const std::shared_ptr< Aws::Http::HttpResponse > &response) const override
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeEventStreamRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 
- Protected Member Functions inherited from Aws::Client::AWSClient
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod httpMethod, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, Http::HttpMethod httpMethod, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const Aws::AmazonWebServiceRequest &request, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
virtual void BuildHttpRequest (const Aws::AmazonWebServiceRequest &request, const std::shared_ptr< Aws::Http::HttpRequest > &httpRequest) const
 
const std::shared_ptr< AWSErrorMarshaller > & GetErrorMarshaller () const
 
Aws::Client::AWSAuthSignerGetSignerByName (const char *name) const
 
std::shared_ptr< Aws::Http::HttpRequestBuildAndSignHttpRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method, const char *signerName) const
 
std::shared_ptr< Aws::Http::HttpResponseMakeHttpRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 
- Protected Attributes inherited from Aws::Client::AWSClient
Aws::String m_region
 

Detailed Description

You can use the Amazon Elastic Block Store (Amazon EBS) direct APIs to create Amazon EBS snapshots, write data directly to your snapshots, read data on your snapshots, and identify the differences or changes between two snapshots. If you’re an independent software vendor (ISV) who offers backup services for Amazon EBS, the EBS direct APIs make it more efficient and cost-effective to track incremental changes on your Amazon EBS volumes through snapshots. This can be done without having to create new volumes from snapshots, and then use Amazon Elastic Compute Cloud (Amazon EC2) instances to compare the differences.

You can create incremental snapshots directly from data on-premises into volumes and the cloud to use for quick disaster recovery. With the ability to write and read snapshots, you can write your on-premises data to an snapshot during a disaster. Then after recovery, you can restore it back to Amazon Web Services or on-premises from the snapshot. You no longer need to build and maintain complex mechanisms to copy data to and from Amazon EBS.

This API reference provides detailed information about the actions, data types, parameters, and errors of the EBS direct APIs. For more information about the elements that make up the EBS direct APIs, and examples of how to use them effectively, see Accessing the Contents of an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas for the EBS direct APIs, see Amazon Elastic Block Store Endpoints and Quotas in the Amazon Web Services General Reference.

Definition at line 117 of file EBSClient.h.

Member Typedef Documentation

◆ BASECLASS

Definition at line 120 of file EBSClient.h.

Constructor & Destructor Documentation

◆ EBSClient() [1/3]

Aws::EBS::EBSClient::EBSClient ( const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration())

Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ EBSClient() [2/3]

Aws::EBS::EBSClient::EBSClient ( const Aws::Auth::AWSCredentials credentials,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration() 
)

Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ EBSClient() [3/3]

Aws::EBS::EBSClient::EBSClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration() 
)

Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used

◆ ~EBSClient()

virtual Aws::EBS::EBSClient::~EBSClient ( )
virtual

Member Function Documentation

◆ CompleteSnapshot()

virtual Model::CompleteSnapshotOutcome Aws::EBS::EBSClient::CompleteSnapshot ( const Model::CompleteSnapshotRequest request) const
virtual

Seals and completes the snapshot after all of the required blocks of data have been written to it. Completing the snapshot changes the status to completed. You cannot write new blocks to a snapshot after it has been completed.

See Also:

AWS API Reference

◆ CompleteSnapshotAsync()

virtual void Aws::EBS::EBSClient::CompleteSnapshotAsync ( const Model::CompleteSnapshotRequest request,
const CompleteSnapshotResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Seals and completes the snapshot after all of the required blocks of data have been written to it. Completing the snapshot changes the status to completed. You cannot write new blocks to a snapshot after it has been completed.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ CompleteSnapshotCallable()

virtual Model::CompleteSnapshotOutcomeCallable Aws::EBS::EBSClient::CompleteSnapshotCallable ( const Model::CompleteSnapshotRequest request) const
virtual

Seals and completes the snapshot after all of the required blocks of data have been written to it. Completing the snapshot changes the status to completed. You cannot write new blocks to a snapshot after it has been completed.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetSnapshotBlock()

virtual Model::GetSnapshotBlockOutcome Aws::EBS::EBSClient::GetSnapshotBlock ( const Model::GetSnapshotBlockRequest request) const
virtual

Returns the data in a block in an Amazon Elastic Block Store snapshot.

See Also:

AWS API Reference

◆ GetSnapshotBlockAsync()

virtual void Aws::EBS::EBSClient::GetSnapshotBlockAsync ( const Model::GetSnapshotBlockRequest request,
const GetSnapshotBlockResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns the data in a block in an Amazon Elastic Block Store snapshot.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetSnapshotBlockCallable()

virtual Model::GetSnapshotBlockOutcomeCallable Aws::EBS::EBSClient::GetSnapshotBlockCallable ( const Model::GetSnapshotBlockRequest request) const
virtual

Returns the data in a block in an Amazon Elastic Block Store snapshot.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListChangedBlocks()

virtual Model::ListChangedBlocksOutcome Aws::EBS::EBSClient::ListChangedBlocks ( const Model::ListChangedBlocksRequest request) const
virtual

Returns information about the blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.

See Also:

AWS API Reference

◆ ListChangedBlocksAsync()

virtual void Aws::EBS::EBSClient::ListChangedBlocksAsync ( const Model::ListChangedBlocksRequest request,
const ListChangedBlocksResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns information about the blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListChangedBlocksCallable()

virtual Model::ListChangedBlocksOutcomeCallable Aws::EBS::EBSClient::ListChangedBlocksCallable ( const Model::ListChangedBlocksRequest request) const
virtual

Returns information about the blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListSnapshotBlocks()

virtual Model::ListSnapshotBlocksOutcome Aws::EBS::EBSClient::ListSnapshotBlocks ( const Model::ListSnapshotBlocksRequest request) const
virtual

Returns information about the blocks in an Amazon Elastic Block Store snapshot.

See Also:

AWS API Reference

◆ ListSnapshotBlocksAsync()

virtual void Aws::EBS::EBSClient::ListSnapshotBlocksAsync ( const Model::ListSnapshotBlocksRequest request,
const ListSnapshotBlocksResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns information about the blocks in an Amazon Elastic Block Store snapshot.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListSnapshotBlocksCallable()

virtual Model::ListSnapshotBlocksOutcomeCallable Aws::EBS::EBSClient::ListSnapshotBlocksCallable ( const Model::ListSnapshotBlocksRequest request) const
virtual

Returns information about the blocks in an Amazon Elastic Block Store snapshot.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ OverrideEndpoint()

void Aws::EBS::EBSClient::OverrideEndpoint ( const Aws::String endpoint)

◆ PutSnapshotBlock()

virtual Model::PutSnapshotBlockOutcome Aws::EBS::EBSClient::PutSnapshotBlock ( const Model::PutSnapshotBlockRequest request) const
virtual

Writes a block of data to a snapshot. If the specified block contains data, the existing data is overwritten. The target snapshot must be in the pending state.

Data written to a snapshot must be aligned with 512-KiB sectors.

See Also:

AWS API Reference

◆ PutSnapshotBlockAsync()

virtual void Aws::EBS::EBSClient::PutSnapshotBlockAsync ( const Model::PutSnapshotBlockRequest request,
const PutSnapshotBlockResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Writes a block of data to a snapshot. If the specified block contains data, the existing data is overwritten. The target snapshot must be in the pending state.

Data written to a snapshot must be aligned with 512-KiB sectors.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ PutSnapshotBlockCallable()

virtual Model::PutSnapshotBlockOutcomeCallable Aws::EBS::EBSClient::PutSnapshotBlockCallable ( const Model::PutSnapshotBlockRequest request) const
virtual

Writes a block of data to a snapshot. If the specified block contains data, the existing data is overwritten. The target snapshot must be in the pending state.

Data written to a snapshot must be aligned with 512-KiB sectors.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ StartSnapshot()

virtual Model::StartSnapshotOutcome Aws::EBS::EBSClient::StartSnapshot ( const Model::StartSnapshotRequest request) const
virtual

Creates a new Amazon EBS snapshot. The new snapshot enters the pending state after the request completes.

After creating the snapshot, use PutSnapshotBlock to write blocks of data to the snapshot.

See Also:

AWS API Reference

◆ StartSnapshotAsync()

virtual void Aws::EBS::EBSClient::StartSnapshotAsync ( const Model::StartSnapshotRequest request,
const StartSnapshotResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Creates a new Amazon EBS snapshot. The new snapshot enters the pending state after the request completes.

After creating the snapshot, use PutSnapshotBlock to write blocks of data to the snapshot.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ StartSnapshotCallable()

virtual Model::StartSnapshotOutcomeCallable Aws::EBS::EBSClient::StartSnapshotCallable ( const Model::StartSnapshotRequest request) const
virtual

Creates a new Amazon EBS snapshot. The new snapshot enters the pending state after the request completes.

After creating the snapshot, use PutSnapshotBlock to write blocks of data to the snapshot.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.


The documentation for this class was generated from the following file: