AWS SDK for C++  1.8.50
AWS SDK for C++
Public Types | Public Member Functions | List of all members
Aws::ImportExport::ImportExportClient Class Reference

#include <ImportExportClient.h>

+ Inheritance diagram for Aws::ImportExport::ImportExportClient:

Public Types

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

Public Member Functions

 ImportExportClient (const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 ImportExportClient (const Aws::Auth::AWSCredentials &credentials, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 ImportExportClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
virtual ~ImportExportClient ()
 
Aws::String ConvertRequestToPresignedUrl (const Aws::AmazonSerializableWebServiceRequest &requestToConvert, const char *region) const
 
virtual Model::CancelJobOutcome CancelJob (const Model::CancelJobRequest &request) const
 
virtual Model::CancelJobOutcomeCallable CancelJobCallable (const Model::CancelJobRequest &request) const
 
virtual void CancelJobAsync (const Model::CancelJobRequest &request, const CancelJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::CreateJobOutcome CreateJob (const Model::CreateJobRequest &request) const
 
virtual Model::CreateJobOutcomeCallable CreateJobCallable (const Model::CreateJobRequest &request) const
 
virtual void CreateJobAsync (const Model::CreateJobRequest &request, const CreateJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetShippingLabelOutcome GetShippingLabel (const Model::GetShippingLabelRequest &request) const
 
virtual Model::GetShippingLabelOutcomeCallable GetShippingLabelCallable (const Model::GetShippingLabelRequest &request) const
 
virtual void GetShippingLabelAsync (const Model::GetShippingLabelRequest &request, const GetShippingLabelResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetStatusOutcome GetStatus (const Model::GetStatusRequest &request) const
 
virtual Model::GetStatusOutcomeCallable GetStatusCallable (const Model::GetStatusRequest &request) const
 
virtual void GetStatusAsync (const Model::GetStatusRequest &request, const GetStatusResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListJobsOutcome ListJobs (const Model::ListJobsRequest &request) const
 
virtual Model::ListJobsOutcomeCallable ListJobsCallable (const Model::ListJobsRequest &request) const
 
virtual void ListJobsAsync (const Model::ListJobsRequest &request, const ListJobsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UpdateJobOutcome UpdateJob (const Model::UpdateJobRequest &request) const
 
virtual Model::UpdateJobOutcomeCallable UpdateJobCallable (const Model::UpdateJobRequest &request) const
 
virtual void UpdateJobAsync (const Model::UpdateJobRequest &request, const UpdateJobResponseReceivedHandler &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::AWSXMLClient
 AWSXMLClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSXMLClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSXMLClient ()=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 (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 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::AWSXMLClient
virtual AWSError< CoreErrorsBuildAWSError (const std::shared_ptr< Aws::Http::HttpResponse > &response) const override
 
XmlOutcome 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
 
XmlOutcome 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
 
XmlOutcome MakeRequestWithEventStream (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *singerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr) const
 
XmlOutcome MakeRequestWithEventStream (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
 
- 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
 
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, Http::HttpMethod httpMethod, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const Aws::AmazonWebServiceRequest &request, const char *signerName, const char *signerRegionOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const char *signerName, const char *requestName="", const char *signerRegionOverride=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
 
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
 
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

<fullname>AWS Import/Export Service</fullname> AWS Import/Export accelerates transferring large amounts of data between the AWS cloud and portable storage devices that you mail to us. AWS Import/Export transfers data directly onto and off of your storage devices using Amazon's high-speed internal network and bypassing the Internet. For large data sets, AWS Import/Export is often faster than Internet transfer and more cost effective than upgrading your connectivity.

Definition at line 105 of file ImportExportClient.h.

Member Typedef Documentation

◆ BASECLASS

Definition at line 108 of file ImportExportClient.h.

Constructor & Destructor Documentation

◆ ImportExportClient() [1/3]

Aws::ImportExport::ImportExportClient::ImportExportClient ( 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.

◆ ImportExportClient() [2/3]

Aws::ImportExport::ImportExportClient::ImportExportClient ( 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.

◆ ImportExportClient() [3/3]

Aws::ImportExport::ImportExportClient::ImportExportClient ( 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

◆ ~ImportExportClient()

virtual Aws::ImportExport::ImportExportClient::~ImportExportClient ( )
virtual

Member Function Documentation

◆ CancelJob()

virtual Model::CancelJobOutcome Aws::ImportExport::ImportExportClient::CancelJob ( const Model::CancelJobRequest request) const
virtual

This operation cancels a specified job. Only the job owner can cancel it. The operation fails if the job has already started or is complete.

See Also:

AWS API Reference

◆ CancelJobAsync()

virtual void Aws::ImportExport::ImportExportClient::CancelJobAsync ( const Model::CancelJobRequest request,
const CancelJobResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

This operation cancels a specified job. Only the job owner can cancel it. The operation fails if the job has already started or is complete.

See Also:

AWS API Reference

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

◆ CancelJobCallable()

virtual Model::CancelJobOutcomeCallable Aws::ImportExport::ImportExportClient::CancelJobCallable ( const Model::CancelJobRequest request) const
virtual

This operation cancels a specified job. Only the job owner can cancel it. The operation fails if the job has already started or is complete.

See Also:

AWS API Reference

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

◆ ConvertRequestToPresignedUrl()

Aws::String Aws::ImportExport::ImportExportClient::ConvertRequestToPresignedUrl ( const Aws::AmazonSerializableWebServiceRequest requestToConvert,
const char *  region 
) const

Converts any request object to a presigned URL with the GET method, using region for the signer and a timeout of 15 minutes.

◆ CreateJob()

virtual Model::CreateJobOutcome Aws::ImportExport::ImportExportClient::CreateJob ( const Model::CreateJobRequest request) const
virtual

This operation initiates the process of scheduling an upload or download of your data. You include in the request a manifest that describes the data transfer specifics. The response to the request includes a job ID, which you can use in other operations, a signature that you use to identify your storage device, and the address where you should ship your storage device.

See Also:

AWS API Reference

◆ CreateJobAsync()

virtual void Aws::ImportExport::ImportExportClient::CreateJobAsync ( const Model::CreateJobRequest request,
const CreateJobResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

This operation initiates the process of scheduling an upload or download of your data. You include in the request a manifest that describes the data transfer specifics. The response to the request includes a job ID, which you can use in other operations, a signature that you use to identify your storage device, and the address where you should ship your storage device.

See Also:

AWS API Reference

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

◆ CreateJobCallable()

virtual Model::CreateJobOutcomeCallable Aws::ImportExport::ImportExportClient::CreateJobCallable ( const Model::CreateJobRequest request) const
virtual

This operation initiates the process of scheduling an upload or download of your data. You include in the request a manifest that describes the data transfer specifics. The response to the request includes a job ID, which you can use in other operations, a signature that you use to identify your storage device, and the address where you should ship your storage device.

See Also:

AWS API Reference

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

◆ GetShippingLabel()

virtual Model::GetShippingLabelOutcome Aws::ImportExport::ImportExportClient::GetShippingLabel ( const Model::GetShippingLabelRequest request) const
virtual

This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing.

See Also:

AWS API Reference

◆ GetShippingLabelAsync()

virtual void Aws::ImportExport::ImportExportClient::GetShippingLabelAsync ( const Model::GetShippingLabelRequest request,
const GetShippingLabelResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing.

See Also:

AWS API Reference

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

◆ GetShippingLabelCallable()

virtual Model::GetShippingLabelOutcomeCallable Aws::ImportExport::ImportExportClient::GetShippingLabelCallable ( const Model::GetShippingLabelRequest request) const
virtual

This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing.

See Also:

AWS API Reference

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

◆ GetStatus()

virtual Model::GetStatusOutcome Aws::ImportExport::ImportExportClient::GetStatus ( const Model::GetStatusRequest request) const
virtual

This operation returns information about a job, including where the job is in the processing pipeline, the status of the results, and the signature value associated with the job. You can only return information about jobs you own.

See Also:

AWS API Reference

◆ GetStatusAsync()

virtual void Aws::ImportExport::ImportExportClient::GetStatusAsync ( const Model::GetStatusRequest request,
const GetStatusResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

This operation returns information about a job, including where the job is in the processing pipeline, the status of the results, and the signature value associated with the job. You can only return information about jobs you own.

See Also:

AWS API Reference

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

◆ GetStatusCallable()

virtual Model::GetStatusOutcomeCallable Aws::ImportExport::ImportExportClient::GetStatusCallable ( const Model::GetStatusRequest request) const
virtual

This operation returns information about a job, including where the job is in the processing pipeline, the status of the results, and the signature value associated with the job. You can only return information about jobs you own.

See Also:

AWS API Reference

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

◆ ListJobs()

virtual Model::ListJobsOutcome Aws::ImportExport::ImportExportClient::ListJobs ( const Model::ListJobsRequest request) const
virtual

This operation returns the jobs associated with the requester. AWS Import/Export lists the jobs in reverse chronological order based on the date of creation. For example if Job Test1 was created 2009Dec30 and Test2 was created 2010Feb05, the ListJobs operation would return Test2 followed by Test1.

See Also:

AWS API Reference

◆ ListJobsAsync()

virtual void Aws::ImportExport::ImportExportClient::ListJobsAsync ( const Model::ListJobsRequest request,
const ListJobsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

This operation returns the jobs associated with the requester. AWS Import/Export lists the jobs in reverse chronological order based on the date of creation. For example if Job Test1 was created 2009Dec30 and Test2 was created 2010Feb05, the ListJobs operation would return Test2 followed by Test1.

See Also:

AWS API Reference

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

◆ ListJobsCallable()

virtual Model::ListJobsOutcomeCallable Aws::ImportExport::ImportExportClient::ListJobsCallable ( const Model::ListJobsRequest request) const
virtual

This operation returns the jobs associated with the requester. AWS Import/Export lists the jobs in reverse chronological order based on the date of creation. For example if Job Test1 was created 2009Dec30 and Test2 was created 2010Feb05, the ListJobs operation would return Test2 followed by Test1.

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::ImportExport::ImportExportClient::OverrideEndpoint ( const Aws::String endpoint)

◆ UpdateJob()

virtual Model::UpdateJobOutcome Aws::ImportExport::ImportExportClient::UpdateJob ( const Model::UpdateJobRequest request) const
virtual

You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file. The manifest file attached to this request replaces the original manifest file. You can only use the operation after a CreateJob request but before the data transfer starts and you can only use it on jobs you own.

See Also:

AWS API Reference

◆ UpdateJobAsync()

virtual void Aws::ImportExport::ImportExportClient::UpdateJobAsync ( const Model::UpdateJobRequest request,
const UpdateJobResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file. The manifest file attached to this request replaces the original manifest file. You can only use the operation after a CreateJob request but before the data transfer starts and you can only use it on jobs you own.

See Also:

AWS API Reference

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

◆ UpdateJobCallable()

virtual Model::UpdateJobOutcomeCallable Aws::ImportExport::ImportExportClient::UpdateJobCallable ( const Model::UpdateJobRequest request) const
virtual

You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file. The manifest file attached to this request replaces the original manifest file. You can only use the operation after a CreateJob request but before the data transfer starts and you can only use it on jobs you own.

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: