AWS SDK for C++

AWS SDK for C++ Version 1.11.440

Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
Aws::Snowball::SnowballClient Class Reference

#include <SnowballClient.h>

Inheritance diagram for Aws::Snowball::SnowballClient:
[legend]

Public Types

 
 
 

Public Types inherited from Aws::Client::AWSJsonClient

 

Public Member Functions

 
 SnowballClient (const Aws::Auth::AWSCredentials &credentials, std::shared_ptr< SnowballEndpointProviderBase > endpointProvider=nullptr, const Aws::Snowball::SnowballClientConfiguration &clientConfiguration=Aws::Snowball::SnowballClientConfiguration())
 
 SnowballClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, std::shared_ptr< SnowballEndpointProviderBase > endpointProvider=nullptr, const Aws::Snowball::SnowballClientConfiguration &clientConfiguration=Aws::Snowball::SnowballClientConfiguration())
 
 SnowballClient (const Aws::Client::ClientConfiguration &clientConfiguration)
 
 SnowballClient (const Aws::Auth::AWSCredentials &credentials, const Aws::Client::ClientConfiguration &clientConfiguration)
 
 SnowballClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, const Aws::Client::ClientConfiguration &clientConfiguration)
 
virtual ~SnowballClient ()
 
 
template<typename CancelClusterRequestT = Model::CancelClusterRequest>
Model::CancelClusterOutcomeCallable CancelClusterCallable (const CancelClusterRequestT &request) const
 
template<typename CancelClusterRequestT = Model::CancelClusterRequest>
void CancelClusterAsync (const CancelClusterRequestT &request, const CancelClusterResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename CancelJobRequestT = Model::CancelJobRequest>
Model::CancelJobOutcomeCallable CancelJobCallable (const CancelJobRequestT &request) const
 
template<typename CancelJobRequestT = Model::CancelJobRequest>
void CancelJobAsync (const CancelJobRequestT &request, const CancelJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename CreateAddressRequestT = Model::CreateAddressRequest>
Model::CreateAddressOutcomeCallable CreateAddressCallable (const CreateAddressRequestT &request) const
 
template<typename CreateAddressRequestT = Model::CreateAddressRequest>
void CreateAddressAsync (const CreateAddressRequestT &request, const CreateAddressResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename CreateClusterRequestT = Model::CreateClusterRequest>
Model::CreateClusterOutcomeCallable CreateClusterCallable (const CreateClusterRequestT &request) const
 
template<typename CreateClusterRequestT = Model::CreateClusterRequest>
void CreateClusterAsync (const CreateClusterRequestT &request, const CreateClusterResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::CreateJobOutcome CreateJob (const Model::CreateJobRequest &request={}) const
 
template<typename CreateJobRequestT = Model::CreateJobRequest>
Model::CreateJobOutcomeCallable CreateJobCallable (const CreateJobRequestT &request={}) const
 
template<typename CreateJobRequestT = Model::CreateJobRequest>
void CreateJobAsync (const CreateJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const CreateJobRequestT &request={}) const
 
 
template<typename CreateLongTermPricingRequestT = Model::CreateLongTermPricingRequest>
Model::CreateLongTermPricingOutcomeCallable CreateLongTermPricingCallable (const CreateLongTermPricingRequestT &request) const
 
template<typename CreateLongTermPricingRequestT = Model::CreateLongTermPricingRequest>
void CreateLongTermPricingAsync (const CreateLongTermPricingRequestT &request, const CreateLongTermPricingResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename CreateReturnShippingLabelRequestT = Model::CreateReturnShippingLabelRequest>
Model::CreateReturnShippingLabelOutcomeCallable CreateReturnShippingLabelCallable (const CreateReturnShippingLabelRequestT &request) const
 
template<typename CreateReturnShippingLabelRequestT = Model::CreateReturnShippingLabelRequest>
void CreateReturnShippingLabelAsync (const CreateReturnShippingLabelRequestT &request, const CreateReturnShippingLabelResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename DescribeAddressRequestT = Model::DescribeAddressRequest>
Model::DescribeAddressOutcomeCallable DescribeAddressCallable (const DescribeAddressRequestT &request) const
 
template<typename DescribeAddressRequestT = Model::DescribeAddressRequest>
void DescribeAddressAsync (const DescribeAddressRequestT &request, const DescribeAddressResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename DescribeAddressesRequestT = Model::DescribeAddressesRequest>
Model::DescribeAddressesOutcomeCallable DescribeAddressesCallable (const DescribeAddressesRequestT &request={}) const
 
template<typename DescribeAddressesRequestT = Model::DescribeAddressesRequest>
void DescribeAddressesAsync (const DescribeAddressesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const DescribeAddressesRequestT &request={}) const
 
 
template<typename DescribeClusterRequestT = Model::DescribeClusterRequest>
Model::DescribeClusterOutcomeCallable DescribeClusterCallable (const DescribeClusterRequestT &request) const
 
template<typename DescribeClusterRequestT = Model::DescribeClusterRequest>
void DescribeClusterAsync (const DescribeClusterRequestT &request, const DescribeClusterResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename DescribeJobRequestT = Model::DescribeJobRequest>
Model::DescribeJobOutcomeCallable DescribeJobCallable (const DescribeJobRequestT &request) const
 
template<typename DescribeJobRequestT = Model::DescribeJobRequest>
void DescribeJobAsync (const DescribeJobRequestT &request, const DescribeJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename DescribeReturnShippingLabelRequestT = Model::DescribeReturnShippingLabelRequest>
Model::DescribeReturnShippingLabelOutcomeCallable DescribeReturnShippingLabelCallable (const DescribeReturnShippingLabelRequestT &request) const
 
template<typename DescribeReturnShippingLabelRequestT = Model::DescribeReturnShippingLabelRequest>
void DescribeReturnShippingLabelAsync (const DescribeReturnShippingLabelRequestT &request, const DescribeReturnShippingLabelResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename GetJobManifestRequestT = Model::GetJobManifestRequest>
Model::GetJobManifestOutcomeCallable GetJobManifestCallable (const GetJobManifestRequestT &request) const
 
template<typename GetJobManifestRequestT = Model::GetJobManifestRequest>
void GetJobManifestAsync (const GetJobManifestRequestT &request, const GetJobManifestResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename GetJobUnlockCodeRequestT = Model::GetJobUnlockCodeRequest>
Model::GetJobUnlockCodeOutcomeCallable GetJobUnlockCodeCallable (const GetJobUnlockCodeRequestT &request) const
 
template<typename GetJobUnlockCodeRequestT = Model::GetJobUnlockCodeRequest>
void GetJobUnlockCodeAsync (const GetJobUnlockCodeRequestT &request, const GetJobUnlockCodeResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename GetSnowballUsageRequestT = Model::GetSnowballUsageRequest>
Model::GetSnowballUsageOutcomeCallable GetSnowballUsageCallable (const GetSnowballUsageRequestT &request={}) const
 
template<typename GetSnowballUsageRequestT = Model::GetSnowballUsageRequest>
void GetSnowballUsageAsync (const GetSnowballUsageResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const GetSnowballUsageRequestT &request={}) const
 
 
template<typename GetSoftwareUpdatesRequestT = Model::GetSoftwareUpdatesRequest>
Model::GetSoftwareUpdatesOutcomeCallable GetSoftwareUpdatesCallable (const GetSoftwareUpdatesRequestT &request) const
 
template<typename GetSoftwareUpdatesRequestT = Model::GetSoftwareUpdatesRequest>
void GetSoftwareUpdatesAsync (const GetSoftwareUpdatesRequestT &request, const GetSoftwareUpdatesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename ListClusterJobsRequestT = Model::ListClusterJobsRequest>
Model::ListClusterJobsOutcomeCallable ListClusterJobsCallable (const ListClusterJobsRequestT &request) const
 
template<typename ListClusterJobsRequestT = Model::ListClusterJobsRequest>
void ListClusterJobsAsync (const ListClusterJobsRequestT &request, const ListClusterJobsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename ListClustersRequestT = Model::ListClustersRequest>
Model::ListClustersOutcomeCallable ListClustersCallable (const ListClustersRequestT &request={}) const
 
template<typename ListClustersRequestT = Model::ListClustersRequest>
void ListClustersAsync (const ListClustersResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const ListClustersRequestT &request={}) const
 
 
template<typename ListCompatibleImagesRequestT = Model::ListCompatibleImagesRequest>
Model::ListCompatibleImagesOutcomeCallable ListCompatibleImagesCallable (const ListCompatibleImagesRequestT &request={}) const
 
template<typename ListCompatibleImagesRequestT = Model::ListCompatibleImagesRequest>
void ListCompatibleImagesAsync (const ListCompatibleImagesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const ListCompatibleImagesRequestT &request={}) const
 
virtual Model::ListJobsOutcome ListJobs (const Model::ListJobsRequest &request={}) const
 
template<typename ListJobsRequestT = Model::ListJobsRequest>
Model::ListJobsOutcomeCallable ListJobsCallable (const ListJobsRequestT &request={}) const
 
template<typename ListJobsRequestT = Model::ListJobsRequest>
void ListJobsAsync (const ListJobsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const ListJobsRequestT &request={}) const
 
 
template<typename ListLongTermPricingRequestT = Model::ListLongTermPricingRequest>
Model::ListLongTermPricingOutcomeCallable ListLongTermPricingCallable (const ListLongTermPricingRequestT &request={}) const
 
template<typename ListLongTermPricingRequestT = Model::ListLongTermPricingRequest>
void ListLongTermPricingAsync (const ListLongTermPricingResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const ListLongTermPricingRequestT &request={}) const
 
 
template<typename ListPickupLocationsRequestT = Model::ListPickupLocationsRequest>
Model::ListPickupLocationsOutcomeCallable ListPickupLocationsCallable (const ListPickupLocationsRequestT &request={}) const
 
template<typename ListPickupLocationsRequestT = Model::ListPickupLocationsRequest>
void ListPickupLocationsAsync (const ListPickupLocationsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const ListPickupLocationsRequestT &request={}) const
 
 
template<typename ListServiceVersionsRequestT = Model::ListServiceVersionsRequest>
Model::ListServiceVersionsOutcomeCallable ListServiceVersionsCallable (const ListServiceVersionsRequestT &request) const
 
template<typename ListServiceVersionsRequestT = Model::ListServiceVersionsRequest>
void ListServiceVersionsAsync (const ListServiceVersionsRequestT &request, const ListServiceVersionsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename UpdateClusterRequestT = Model::UpdateClusterRequest>
Model::UpdateClusterOutcomeCallable UpdateClusterCallable (const UpdateClusterRequestT &request) const
 
template<typename UpdateClusterRequestT = Model::UpdateClusterRequest>
void UpdateClusterAsync (const UpdateClusterRequestT &request, const UpdateClusterResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename UpdateJobRequestT = Model::UpdateJobRequest>
Model::UpdateJobOutcomeCallable UpdateJobCallable (const UpdateJobRequestT &request) const
 
template<typename UpdateJobRequestT = Model::UpdateJobRequest>
void UpdateJobAsync (const UpdateJobRequestT &request, const UpdateJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename UpdateJobShipmentStateRequestT = Model::UpdateJobShipmentStateRequest>
Model::UpdateJobShipmentStateOutcomeCallable UpdateJobShipmentStateCallable (const UpdateJobShipmentStateRequestT &request) const
 
template<typename UpdateJobShipmentStateRequestT = Model::UpdateJobShipmentStateRequest>
void UpdateJobShipmentStateAsync (const UpdateJobShipmentStateRequestT &request, const UpdateJobShipmentStateResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
 
template<typename UpdateLongTermPricingRequestT = Model::UpdateLongTermPricingRequest>
Model::UpdateLongTermPricingOutcomeCallable UpdateLongTermPricingCallable (const UpdateLongTermPricingRequestT &request) const
 
template<typename UpdateLongTermPricingRequestT = Model::UpdateLongTermPricingRequest>
void UpdateLongTermPricingAsync (const UpdateLongTermPricingRequestT &request, const UpdateLongTermPricingResponseReceivedHandler &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 (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})
 
Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})
 
Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const
 
Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})
 
Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const
 
Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})
 
Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const
 
Aws::String GeneratePresignedUrl (const 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, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})
 
Aws::String GeneratePresignedUrl (const Aws::Endpoint::AWSEndpoint &endpoint, Aws::Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const Aws::Http::HeaderValueCollection &customizedHeaders={}, uint64_t expirationInSeconds=0, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const 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 std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const 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 std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const
 
const std::shared_ptr< Aws::Http::HttpClient > & GetHttpClient () const
 
 
 
virtual const char * GetServiceClientName () const
 
virtual void SetServiceClientName (const Aws::String &name)
 
void AppendToUserAgent (const Aws::String &valueToAppend)
 
 
 
 
 
void SubmitAsync (OperationFuncT operationFunc, const RequestT &request, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
void SubmitAsync (OperationFuncT operationFunc, RequestT &request, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
void SubmitAsync (OperationFuncT operationFunc, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
auto SubmitCallable (OperationFuncT operationFunc, const RequestT &request) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)(request))>
 
auto SubmitCallable (OperationFuncT operationFunc, RequestT &request) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)(request))>
 
auto SubmitCallable (OperationFuncT operationFunc) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)())>
 

Static Public Member Functions

static const char * GetServiceName ()
 
static const char * GetAllocationTag ()
 

Static Public Member Functions inherited from Aws::Client::ClientWithAsyncTemplateMethods< SnowballClient >

static void ShutdownSdkClient (void *pThis, int64_t timeoutMs=-1)
 

Friends

 

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::AmazonWebServiceRequest &request, const Aws::Endpoint::AWSEndpoint &endpoint, 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::Endpoint::AWSEndpoint &endpoint, 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, 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
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::AmazonWebServiceRequest &request, const Aws::Endpoint::AWSEndpoint &endpoint, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, 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
 

Static Protected Member Functions inherited from Aws::Client::AWSClient

static void AppendRecursionDetectionHeader (std::shared_ptr< Aws::Http::HttpRequest > ioRequest)
 
 
static bool DoesResponseGenerateError (const std::shared_ptr< Aws::Http::HttpResponse > &response)
 

Protected Attributes inherited from Aws::Client::AWSClient

 
 
 
std::atomic< bool > m_isInitialized
 
std::atomic< size_t > m_operationsProcessed
 
std::condition_variable m_shutdownSignal
 
std::mutex m_shutdownMutex
 

Detailed Description

The Amazon Web Services Snow Family provides a petabyte-scale data transport solution that uses secure devices to transfer large amounts of data between your on-premises data centers and Amazon Simple Storage Service (Amazon S3). The Snow Family commands described here provide access to the same functionality that is available in the Amazon Web Services Snow Family Management Console, which enables you to create and manage jobs for a Snow Family device. To transfer data locally with a Snow Family device, you'll need to use the Snowball Edge client or the Amazon S3 API Interface for Snowball or OpsHub for Snow Family. For more information, see the User Guide.

Definition at line 31 of file SnowballClient.h.

Member Typedef Documentation

◆ BASECLASS

Definition at line 34 of file SnowballClient.h.

◆ ClientConfigurationType

Definition at line 38 of file SnowballClient.h.

◆ EndpointProviderType

Definition at line 39 of file SnowballClient.h.

Constructor & Destructor Documentation

◆ SnowballClient() [1/6]

Aws::Snowball::SnowballClient::SnowballClient ( const Aws::Snowball::SnowballClientConfiguration clientConfiguration = Aws::Snowball::SnowballClientConfiguration(),
std::shared_ptr< SnowballEndpointProviderBase endpointProvider = nullptr 
)

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.

◆ SnowballClient() [2/6]

Aws::Snowball::SnowballClient::SnowballClient ( const Aws::Auth::AWSCredentials credentials,
std::shared_ptr< SnowballEndpointProviderBase endpointProvider = nullptr,
const Aws::Snowball::SnowballClientConfiguration clientConfiguration = Aws::Snowball::SnowballClientConfiguration() 
)

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.

◆ SnowballClient() [3/6]

Aws::Snowball::SnowballClient::SnowballClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,
std::shared_ptr< SnowballEndpointProviderBase endpointProvider = nullptr,
const Aws::Snowball::SnowballClientConfiguration clientConfiguration = Aws::Snowball::SnowballClientConfiguration() 
)

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

◆ SnowballClient() [4/6]

Aws::Snowball::SnowballClient::SnowballClient ( const Aws::Client::ClientConfiguration 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.

◆ SnowballClient() [5/6]

Aws::Snowball::SnowballClient::SnowballClient ( const Aws::Auth::AWSCredentials credentials,
const Aws::Client::ClientConfiguration 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.

◆ SnowballClient() [6/6]

Aws::Snowball::SnowballClient::SnowballClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,
const Aws::Client::ClientConfiguration 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

◆ ~SnowballClient()

virtual Aws::Snowball::SnowballClient::~SnowballClient ( )
virtual

Member Function Documentation

◆ accessEndpointProvider()

std::shared_ptr< SnowballEndpointProviderBase > & Aws::Snowball::SnowballClient::accessEndpointProvider ( )

◆ CancelCluster()

virtual Model::CancelClusterOutcome Aws::Snowball::SnowballClient::CancelCluster ( const Model::CancelClusterRequest request) const
virtual

Cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status. You'll have at least an hour after creating a cluster job to cancel it.

See Also:

AWS API Reference

◆ CancelClusterAsync()

template<typename CancelClusterRequestT = Model::CancelClusterRequest>
void Aws::Snowball::SnowballClient::CancelClusterAsync ( const CancelClusterRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for CancelCluster that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 111 of file SnowballClient.h.

◆ CancelClusterCallable()

template<typename CancelClusterRequestT = Model::CancelClusterRequest>
Model::CancelClusterOutcomeCallable Aws::Snowball::SnowballClient::CancelClusterCallable ( const CancelClusterRequestT &  request) const
inline

A Callable wrapper for CancelCluster that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 102 of file SnowballClient.h.

◆ CancelJob()

virtual Model::CancelJobOutcome Aws::Snowball::SnowballClient::CancelJob ( const Model::CancelJobRequest request) const
virtual

Cancels the specified job. You can only cancel a job before its JobState value changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action returns a job's JobState as part of the response element data returned.

See Also:

AWS API Reference

◆ CancelJobAsync()

template<typename CancelJobRequestT = Model::CancelJobRequest>
void Aws::Snowball::SnowballClient::CancelJobAsync ( const CancelJobRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for CancelJob that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 140 of file SnowballClient.h.

◆ CancelJobCallable()

template<typename CancelJobRequestT = Model::CancelJobRequest>
Model::CancelJobOutcomeCallable Aws::Snowball::SnowballClient::CancelJobCallable ( const CancelJobRequestT &  request) const
inline

A Callable wrapper for CancelJob that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 131 of file SnowballClient.h.

◆ CreateAddress()

virtual Model::CreateAddressOutcome Aws::Snowball::SnowballClient::CreateAddress ( const Model::CreateAddressRequest request) const
virtual

Creates an address for a Snow device to be shipped to. In most regions, addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown. If providing an address as a JSON file through the cli-input-json option, include the full file path. For example, –cli-input-json file://create-address.json.

See Also:

AWS API Reference

◆ CreateAddressAsync()

template<typename CreateAddressRequestT = Model::CreateAddressRequest>
void Aws::Snowball::SnowballClient::CreateAddressAsync ( const CreateAddressRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for CreateAddress that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 171 of file SnowballClient.h.

◆ CreateAddressCallable()

template<typename CreateAddressRequestT = Model::CreateAddressRequest>
Model::CreateAddressOutcomeCallable Aws::Snowball::SnowballClient::CreateAddressCallable ( const CreateAddressRequestT &  request) const
inline

A Callable wrapper for CreateAddress that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 162 of file SnowballClient.h.

◆ CreateCluster()

virtual Model::CreateClusterOutcome Aws::Snowball::SnowballClient::CreateCluster ( const Model::CreateClusterRequest request) const
virtual

Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.

See Also:

AWS API Reference

◆ CreateClusterAsync()

template<typename CreateClusterRequestT = Model::CreateClusterRequest>
void Aws::Snowball::SnowballClient::CreateClusterAsync ( const CreateClusterRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for CreateCluster that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 199 of file SnowballClient.h.

◆ CreateClusterCallable()

template<typename CreateClusterRequestT = Model::CreateClusterRequest>
Model::CreateClusterOutcomeCallable Aws::Snowball::SnowballClient::CreateClusterCallable ( const CreateClusterRequestT &  request) const
inline

A Callable wrapper for CreateCluster that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 190 of file SnowballClient.h.

◆ CreateJob()

virtual Model::CreateJobOutcome Aws::Snowball::SnowballClient::CreateJob ( const Model::CreateJobRequest request = {}) const
virtual

Creates a job to import or export data between Amazon S3 and your on-premises data center. Your Amazon Web Services account must have the right trust policies and permissions in place to create a job for a Snow device. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster.

Only the Snowball; Edge device type is supported when ordering clustered jobs.

The device capacity is optional.

Availability of device types differ by Amazon Web Services Region. For more information about Region availability, see Amazon Web Services Regional Services.

Snow Family devices and their capacities.

  • Device type: SNC1_SSD

    • Capacity: T14

    • Description: Snowcone

  • Device type: SNC1_HDD

    • Capacity: T8

    • Description: Snowcone

  • Device type: EDGE_S

    • Capacity: T98

    • Description: Snowball Edge Storage Optimized for data transfer only

  • Device type: EDGE_CG

    • Capacity: T42

    • Description: Snowball Edge Compute Optimized with GPU

  • Device type: EDGE_C

    • Capacity: T42

    • Description: Snowball Edge Compute Optimized without GPU

  • Device type: EDGE

    • Capacity: T100

    • Description: Snowball Edge Storage Optimized with EC2 Compute

    This device is replaced with T98.

  • Device type: STANDARD

    • Capacity: T50

    • Description: Original Snowball device

      This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region

  • Device type: STANDARD

    • Capacity: T80

    • Description: Original Snowball device

      This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region.

  • Snow Family device type: RACK_5U_C

    • Capacity: T13

    • Description: Snowblade.

  • Device type: V3_5S

    • Capacity: T240

    • Description: Snowball Edge Storage Optimized 210TB

See Also:

AWS API Reference

◆ CreateJobAsync()

template<typename CreateJobRequestT = Model::CreateJobRequest>
void Aws::Snowball::SnowballClient::CreateJobAsync ( const CreateJobResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr,
const CreateJobRequestT &  request = {} 
) const
inline

An Async wrapper for CreateJob that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 260 of file SnowballClient.h.

◆ CreateJobCallable()

template<typename CreateJobRequestT = Model::CreateJobRequest>
Model::CreateJobOutcomeCallable Aws::Snowball::SnowballClient::CreateJobCallable ( const CreateJobRequestT &  request = {}) const
inline

A Callable wrapper for CreateJob that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 251 of file SnowballClient.h.

◆ CreateLongTermPricing()

virtual Model::CreateLongTermPricingOutcome Aws::Snowball::SnowballClient::CreateLongTermPricing ( const Model::CreateLongTermPricingRequest request) const
virtual

Creates a job with the long-term usage option for a device. The long-term usage is a 1-year or 3-year long-term pricing type for the device. You are billed upfront, and Amazon Web Services provides discounts for long-term pricing.

See Also:

AWS API Reference

◆ CreateLongTermPricingAsync()

template<typename CreateLongTermPricingRequestT = Model::CreateLongTermPricingRequest>
void Aws::Snowball::SnowballClient::CreateLongTermPricingAsync ( const CreateLongTermPricingRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for CreateLongTermPricing that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 288 of file SnowballClient.h.

◆ CreateLongTermPricingCallable()

template<typename CreateLongTermPricingRequestT = Model::CreateLongTermPricingRequest>
Model::CreateLongTermPricingOutcomeCallable Aws::Snowball::SnowballClient::CreateLongTermPricingCallable ( const CreateLongTermPricingRequestT &  request) const
inline

A Callable wrapper for CreateLongTermPricing that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 279 of file SnowballClient.h.

◆ CreateReturnShippingLabel()

virtual Model::CreateReturnShippingLabelOutcome Aws::Snowball::SnowballClient::CreateReturnShippingLabel ( const Model::CreateReturnShippingLabelRequest request) const
virtual

Creates a shipping label that will be used to return the Snow device to Amazon Web Services.

See Also:

AWS API Reference

◆ CreateReturnShippingLabelAsync()

template<typename CreateReturnShippingLabelRequestT = Model::CreateReturnShippingLabelRequest>
void Aws::Snowball::SnowballClient::CreateReturnShippingLabelAsync ( const CreateReturnShippingLabelRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for CreateReturnShippingLabel that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 314 of file SnowballClient.h.

◆ CreateReturnShippingLabelCallable()

template<typename CreateReturnShippingLabelRequestT = Model::CreateReturnShippingLabelRequest>
Model::CreateReturnShippingLabelOutcomeCallable Aws::Snowball::SnowballClient::CreateReturnShippingLabelCallable ( const CreateReturnShippingLabelRequestT &  request) const
inline

A Callable wrapper for CreateReturnShippingLabel that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 305 of file SnowballClient.h.

◆ DescribeAddress()

virtual Model::DescribeAddressOutcome Aws::Snowball::SnowballClient::DescribeAddress ( const Model::DescribeAddressRequest request) const
virtual

Takes an AddressId and returns specific details about that address in the form of an Address object.

See Also:

AWS API Reference

◆ DescribeAddressAsync()

template<typename DescribeAddressRequestT = Model::DescribeAddressRequest>
void Aws::Snowball::SnowballClient::DescribeAddressAsync ( const DescribeAddressRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for DescribeAddress that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 341 of file SnowballClient.h.

◆ DescribeAddressCallable()

template<typename DescribeAddressRequestT = Model::DescribeAddressRequest>
Model::DescribeAddressOutcomeCallable Aws::Snowball::SnowballClient::DescribeAddressCallable ( const DescribeAddressRequestT &  request) const
inline

A Callable wrapper for DescribeAddress that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 332 of file SnowballClient.h.

◆ DescribeAddresses()

virtual Model::DescribeAddressesOutcome Aws::Snowball::SnowballClient::DescribeAddresses ( const Model::DescribeAddressesRequest request = {}) const
virtual

Returns a specified number of ADDRESS objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.

See Also:

AWS API Reference

◆ DescribeAddressesAsync()

template<typename DescribeAddressesRequestT = Model::DescribeAddressesRequest>
void Aws::Snowball::SnowballClient::DescribeAddressesAsync ( const DescribeAddressesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr,
const DescribeAddressesRequestT &  request = {} 
) const
inline

An Async wrapper for DescribeAddresses that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 368 of file SnowballClient.h.

◆ DescribeAddressesCallable()

template<typename DescribeAddressesRequestT = Model::DescribeAddressesRequest>
Model::DescribeAddressesOutcomeCallable Aws::Snowball::SnowballClient::DescribeAddressesCallable ( const DescribeAddressesRequestT &  request = {}) const
inline

A Callable wrapper for DescribeAddresses that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 359 of file SnowballClient.h.

◆ DescribeCluster()

virtual Model::DescribeClusterOutcome Aws::Snowball::SnowballClient::DescribeCluster ( const Model::DescribeClusterRequest request) const
virtual

Returns information about a specific cluster including shipping information, cluster status, and other important metadata.

See Also:

AWS API Reference

◆ DescribeClusterAsync()

template<typename DescribeClusterRequestT = Model::DescribeClusterRequest>
void Aws::Snowball::SnowballClient::DescribeClusterAsync ( const DescribeClusterRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for DescribeCluster that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 394 of file SnowballClient.h.

◆ DescribeClusterCallable()

template<typename DescribeClusterRequestT = Model::DescribeClusterRequest>
Model::DescribeClusterOutcomeCallable Aws::Snowball::SnowballClient::DescribeClusterCallable ( const DescribeClusterRequestT &  request) const
inline

A Callable wrapper for DescribeCluster that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 385 of file SnowballClient.h.

◆ DescribeJob()

virtual Model::DescribeJobOutcome Aws::Snowball::SnowballClient::DescribeJob ( const Model::DescribeJobRequest request) const
virtual

Returns information about a specific job including shipping information, job status, and other important metadata.

See Also:

AWS API Reference

◆ DescribeJobAsync()

template<typename DescribeJobRequestT = Model::DescribeJobRequest>
void Aws::Snowball::SnowballClient::DescribeJobAsync ( const DescribeJobRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for DescribeJob that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 420 of file SnowballClient.h.

◆ DescribeJobCallable()

template<typename DescribeJobRequestT = Model::DescribeJobRequest>
Model::DescribeJobOutcomeCallable Aws::Snowball::SnowballClient::DescribeJobCallable ( const DescribeJobRequestT &  request) const
inline

A Callable wrapper for DescribeJob that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 411 of file SnowballClient.h.

◆ DescribeReturnShippingLabel()

virtual Model::DescribeReturnShippingLabelOutcome Aws::Snowball::SnowballClient::DescribeReturnShippingLabel ( const Model::DescribeReturnShippingLabelRequest request) const
virtual

Information on the shipping label of a Snow device that is being returned to Amazon Web Services.

See Also:

AWS API Reference

◆ DescribeReturnShippingLabelAsync()

template<typename DescribeReturnShippingLabelRequestT = Model::DescribeReturnShippingLabelRequest>
void Aws::Snowball::SnowballClient::DescribeReturnShippingLabelAsync ( const DescribeReturnShippingLabelRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for DescribeReturnShippingLabel that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 446 of file SnowballClient.h.

◆ DescribeReturnShippingLabelCallable()

template<typename DescribeReturnShippingLabelRequestT = Model::DescribeReturnShippingLabelRequest>
Model::DescribeReturnShippingLabelOutcomeCallable Aws::Snowball::SnowballClient::DescribeReturnShippingLabelCallable ( const DescribeReturnShippingLabelRequestT &  request) const
inline

A Callable wrapper for DescribeReturnShippingLabel that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 437 of file SnowballClient.h.

◆ GetAllocationTag()

static const char * Aws::Snowball::SnowballClient::GetAllocationTag ( )
static

◆ GetJobManifest()

virtual Model::GetJobManifestOutcome Aws::Snowball::SnowballClient::GetJobManifest ( const Model::GetJobManifestRequest request) const
virtual

Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest action.

The manifest is an encrypted file that you can download after your job enters the WithCustomer status. This is the only valid status for calling this API as the manifest and UnlockCode code value are used for securing your device and should only be used when you have the device. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snow device through the Snowball client when the client is started for the first time.

As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snow device associated with that job.

The credentials of a given job, including its manifest file and unlock code, expire 360 days after the job is created.

See Also:

AWS API Reference

◆ GetJobManifestAsync()

template<typename GetJobManifestRequestT = Model::GetJobManifestRequest>
void Aws::Snowball::SnowballClient::GetJobManifestAsync ( const GetJobManifestRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for GetJobManifest that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 487 of file SnowballClient.h.

◆ GetJobManifestCallable()

template<typename GetJobManifestRequestT = Model::GetJobManifestRequest>
Model::GetJobManifestOutcomeCallable Aws::Snowball::SnowballClient::GetJobManifestCallable ( const GetJobManifestRequestT &  request) const
inline

A Callable wrapper for GetJobManifest that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 478 of file SnowballClient.h.

◆ GetJobUnlockCode()

virtual Model::GetJobUnlockCodeOutcome Aws::Snowball::SnowballClient::GetJobUnlockCode ( const Model::GetJobUnlockCodeRequest request) const
virtual

Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 360 days after the associated job has been created.

The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snow device through the Snowball client when the client is started for the first time. The only valid status for calling this API is WithCustomer as the manifest and Unlock code values are used for securing your device and should only be used when you have the device.

As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snow device associated with that job.

See Also:


AWS API Reference

◆ GetJobUnlockCodeAsync()

template<typename GetJobUnlockCodeRequestT = Model::GetJobUnlockCodeRequest>
void Aws::Snowball::SnowballClient::GetJobUnlockCodeAsync ( const GetJobUnlockCodeRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for GetJobUnlockCode that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 525 of file SnowballClient.h.

◆ GetJobUnlockCodeCallable()

template<typename GetJobUnlockCodeRequestT = Model::GetJobUnlockCodeRequest>
Model::GetJobUnlockCodeOutcomeCallable Aws::Snowball::SnowballClient::GetJobUnlockCodeCallable ( const GetJobUnlockCodeRequestT &  request) const
inline

A Callable wrapper for GetJobUnlockCode that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 516 of file SnowballClient.h.

◆ GetServiceName()

static const char * Aws::Snowball::SnowballClient::GetServiceName ( )
static

◆ GetSnowballUsage()

virtual Model::GetSnowballUsageOutcome Aws::Snowball::SnowballClient::GetSnowballUsage ( const Model::GetSnowballUsageRequest request = {}) const
virtual

Returns information about the Snow Family service limit for your account, and also the number of Snow devices your account has in use.

The default service limit for the number of Snow devices that you can have at one time is 1. If you want to increase your service limit, contact Amazon Web Services Support.

See Also:

AWS API Reference

◆ GetSnowballUsageAsync()

template<typename GetSnowballUsageRequestT = Model::GetSnowballUsageRequest>
void Aws::Snowball::SnowballClient::GetSnowballUsageAsync ( const GetSnowballUsageResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr,
const GetSnowballUsageRequestT &  request = {} 
) const
inline

An Async wrapper for GetSnowballUsage that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 554 of file SnowballClient.h.

◆ GetSnowballUsageCallable()

template<typename GetSnowballUsageRequestT = Model::GetSnowballUsageRequest>
Model::GetSnowballUsageOutcomeCallable Aws::Snowball::SnowballClient::GetSnowballUsageCallable ( const GetSnowballUsageRequestT &  request = {}) const
inline

A Callable wrapper for GetSnowballUsage that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 545 of file SnowballClient.h.

◆ GetSoftwareUpdates()

virtual Model::GetSoftwareUpdatesOutcome Aws::Snowball::SnowballClient::GetSoftwareUpdates ( const Model::GetSoftwareUpdatesRequest request) const
virtual

Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.

See Also:

AWS API Reference

◆ GetSoftwareUpdatesAsync()

template<typename GetSoftwareUpdatesRequestT = Model::GetSoftwareUpdatesRequest>
void Aws::Snowball::SnowballClient::GetSoftwareUpdatesAsync ( const GetSoftwareUpdatesRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for GetSoftwareUpdates that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 580 of file SnowballClient.h.

◆ GetSoftwareUpdatesCallable()

template<typename GetSoftwareUpdatesRequestT = Model::GetSoftwareUpdatesRequest>
Model::GetSoftwareUpdatesOutcomeCallable Aws::Snowball::SnowballClient::GetSoftwareUpdatesCallable ( const GetSoftwareUpdatesRequestT &  request) const
inline

A Callable wrapper for GetSoftwareUpdates that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 571 of file SnowballClient.h.

◆ ListClusterJobs()

virtual Model::ListClusterJobsOutcome Aws::Snowball::SnowballClient::ListClusterJobs ( const Model::ListClusterJobsRequest request) const
virtual

Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.

See Also:

AWS API Reference

◆ ListClusterJobsAsync()

template<typename ListClusterJobsRequestT = Model::ListClusterJobsRequest>
void Aws::Snowball::SnowballClient::ListClusterJobsAsync ( const ListClusterJobsRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for ListClusterJobs that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 608 of file SnowballClient.h.

◆ ListClusterJobsCallable()

template<typename ListClusterJobsRequestT = Model::ListClusterJobsRequest>
Model::ListClusterJobsOutcomeCallable Aws::Snowball::SnowballClient::ListClusterJobsCallable ( const ListClusterJobsRequestT &  request) const
inline

A Callable wrapper for ListClusterJobs that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 599 of file SnowballClient.h.

◆ ListClusters()

virtual Model::ListClustersOutcome Aws::Snowball::SnowballClient::ListClusters ( const Model::ListClustersRequest request = {}) const
virtual

Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.

See Also:


AWS API Reference

◆ ListClustersAsync()

template<typename ListClustersRequestT = Model::ListClustersRequest>
void Aws::Snowball::SnowballClient::ListClustersAsync ( const ListClustersResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr,
const ListClustersRequestT &  request = {} 
) const
inline

An Async wrapper for ListClusters that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 636 of file SnowballClient.h.

◆ ListClustersCallable()

template<typename ListClustersRequestT = Model::ListClustersRequest>
Model::ListClustersOutcomeCallable Aws::Snowball::SnowballClient::ListClustersCallable ( const ListClustersRequestT &  request = {}) const
inline

A Callable wrapper for ListClusters that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 627 of file SnowballClient.h.

◆ ListCompatibleImages()

virtual Model::ListCompatibleImagesOutcome Aws::Snowball::SnowballClient::ListCompatibleImages ( const Model::ListCompatibleImagesRequest request = {}) const
virtual

This action returns a list of the different Amazon EC2-compatible Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VM Import/Export and running locally in AMIs.

See Also:

AWS API Reference

◆ ListCompatibleImagesAsync()

template<typename ListCompatibleImagesRequestT = Model::ListCompatibleImagesRequest>
void Aws::Snowball::SnowballClient::ListCompatibleImagesAsync ( const ListCompatibleImagesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr,
const ListCompatibleImagesRequestT &  request = {} 
) const
inline

An Async wrapper for ListCompatibleImages that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 668 of file SnowballClient.h.

◆ ListCompatibleImagesCallable()

template<typename ListCompatibleImagesRequestT = Model::ListCompatibleImagesRequest>
Model::ListCompatibleImagesOutcomeCallable Aws::Snowball::SnowballClient::ListCompatibleImagesCallable ( const ListCompatibleImagesRequestT &  request = {}) const
inline

A Callable wrapper for ListCompatibleImages that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 659 of file SnowballClient.h.

◆ ListJobs()

virtual Model::ListJobsOutcome Aws::Snowball::SnowballClient::ListJobs ( const Model::ListJobsRequest request = {}) const
virtual

Returns an array of JobListEntry objects of the specified length. Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions.

See Also:

AWS API Reference

◆ ListJobsAsync()

template<typename ListJobsRequestT = Model::ListJobsRequest>
void Aws::Snowball::SnowballClient::ListJobsAsync ( const ListJobsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr,
const ListJobsRequestT &  request = {} 
) const
inline

An Async wrapper for ListJobs that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 698 of file SnowballClient.h.

◆ ListJobsCallable()

template<typename ListJobsRequestT = Model::ListJobsRequest>
Model::ListJobsOutcomeCallable Aws::Snowball::SnowballClient::ListJobsCallable ( const ListJobsRequestT &  request = {}) const
inline

A Callable wrapper for ListJobs that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 689 of file SnowballClient.h.

◆ ListLongTermPricing()

virtual Model::ListLongTermPricingOutcome Aws::Snowball::SnowballClient::ListLongTermPricing ( const Model::ListLongTermPricingRequest request = {}) const
virtual

Lists all long-term pricing types.

See Also:

AWS API Reference

◆ ListLongTermPricingAsync()

template<typename ListLongTermPricingRequestT = Model::ListLongTermPricingRequest>
void Aws::Snowball::SnowballClient::ListLongTermPricingAsync ( const ListLongTermPricingResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr,
const ListLongTermPricingRequestT &  request = {} 
) const
inline

An Async wrapper for ListLongTermPricing that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 723 of file SnowballClient.h.

◆ ListLongTermPricingCallable()

template<typename ListLongTermPricingRequestT = Model::ListLongTermPricingRequest>
Model::ListLongTermPricingOutcomeCallable Aws::Snowball::SnowballClient::ListLongTermPricingCallable ( const ListLongTermPricingRequestT &  request = {}) const
inline

A Callable wrapper for ListLongTermPricing that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 714 of file SnowballClient.h.

◆ ListPickupLocations()

virtual Model::ListPickupLocationsOutcome Aws::Snowball::SnowballClient::ListPickupLocations ( const Model::ListPickupLocationsRequest request = {}) const
virtual

A list of locations from which the customer can choose to pickup a device.

See Also:

AWS API Reference

◆ ListPickupLocationsAsync()

template<typename ListPickupLocationsRequestT = Model::ListPickupLocationsRequest>
void Aws::Snowball::SnowballClient::ListPickupLocationsAsync ( const ListPickupLocationsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr,
const ListPickupLocationsRequestT &  request = {} 
) const
inline

An Async wrapper for ListPickupLocations that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 749 of file SnowballClient.h.

◆ ListPickupLocationsCallable()

template<typename ListPickupLocationsRequestT = Model::ListPickupLocationsRequest>
Model::ListPickupLocationsOutcomeCallable Aws::Snowball::SnowballClient::ListPickupLocationsCallable ( const ListPickupLocationsRequestT &  request = {}) const
inline

A Callable wrapper for ListPickupLocations that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 740 of file SnowballClient.h.

◆ ListServiceVersions()

virtual Model::ListServiceVersionsOutcome Aws::Snowball::SnowballClient::ListServiceVersions ( const Model::ListServiceVersionsRequest request) const
virtual

Lists all supported versions for Snow on-device services. Returns an array of ServiceVersion object containing the supported versions for a particular service.

See Also:

AWS API Reference

◆ ListServiceVersionsAsync()

template<typename ListServiceVersionsRequestT = Model::ListServiceVersionsRequest>
void Aws::Snowball::SnowballClient::ListServiceVersionsAsync ( const ListServiceVersionsRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for ListServiceVersions that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 776 of file SnowballClient.h.

◆ ListServiceVersionsCallable()

template<typename ListServiceVersionsRequestT = Model::ListServiceVersionsRequest>
Model::ListServiceVersionsOutcomeCallable Aws::Snowball::SnowballClient::ListServiceVersionsCallable ( const ListServiceVersionsRequestT &  request) const
inline

A Callable wrapper for ListServiceVersions that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 767 of file SnowballClient.h.

◆ OverrideEndpoint()

void Aws::Snowball::SnowballClient::OverrideEndpoint ( const Aws::String endpoint)

◆ UpdateCluster()

virtual Model::UpdateClusterOutcome Aws::Snowball::SnowballClient::UpdateCluster ( const Model::UpdateClusterRequest request) const
virtual

While a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60 minutes after the cluster being created, this action is no longer available.

See Also:

AWS API Reference

◆ UpdateClusterAsync()

template<typename UpdateClusterRequestT = Model::UpdateClusterRequest>
void Aws::Snowball::SnowballClient::UpdateClusterAsync ( const UpdateClusterRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for UpdateCluster that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 805 of file SnowballClient.h.

◆ UpdateClusterCallable()

template<typename UpdateClusterRequestT = Model::UpdateClusterRequest>
Model::UpdateClusterOutcomeCallable Aws::Snowball::SnowballClient::UpdateClusterCallable ( const UpdateClusterRequestT &  request) const
inline

A Callable wrapper for UpdateCluster that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 796 of file SnowballClient.h.

◆ UpdateJob()

virtual Model::UpdateJobOutcome Aws::Snowball::SnowballClient::UpdateJob ( const Model::UpdateJobRequest request) const
virtual

While a job's JobState value is New, you can update some of the information associated with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available.

See Also:

AWS API Reference

◆ UpdateJobAsync()

template<typename UpdateJobRequestT = Model::UpdateJobRequest>
void Aws::Snowball::SnowballClient::UpdateJobAsync ( const UpdateJobRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for UpdateJob that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 833 of file SnowballClient.h.

◆ UpdateJobCallable()

template<typename UpdateJobRequestT = Model::UpdateJobRequest>
Model::UpdateJobOutcomeCallable Aws::Snowball::SnowballClient::UpdateJobCallable ( const UpdateJobRequestT &  request) const
inline

A Callable wrapper for UpdateJob that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 824 of file SnowballClient.h.

◆ UpdateJobShipmentState()

virtual Model::UpdateJobShipmentStateOutcome Aws::Snowball::SnowballClient::UpdateJobShipmentState ( const Model::UpdateJobShipmentStateRequest request) const
virtual

Updates the state when a shipment state changes to a different state.

See Also:

AWS API Reference

◆ UpdateJobShipmentStateAsync()

template<typename UpdateJobShipmentStateRequestT = Model::UpdateJobShipmentStateRequest>
void Aws::Snowball::SnowballClient::UpdateJobShipmentStateAsync ( const UpdateJobShipmentStateRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for UpdateJobShipmentState that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 859 of file SnowballClient.h.

◆ UpdateJobShipmentStateCallable()

template<typename UpdateJobShipmentStateRequestT = Model::UpdateJobShipmentStateRequest>
Model::UpdateJobShipmentStateOutcomeCallable Aws::Snowball::SnowballClient::UpdateJobShipmentStateCallable ( const UpdateJobShipmentStateRequestT &  request) const
inline

A Callable wrapper for UpdateJobShipmentState that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 850 of file SnowballClient.h.

◆ UpdateLongTermPricing()

virtual Model::UpdateLongTermPricingOutcome Aws::Snowball::SnowballClient::UpdateLongTermPricing ( const Model::UpdateLongTermPricingRequest request) const
virtual

Updates the long-term pricing type.

See Also:

AWS API Reference

◆ UpdateLongTermPricingAsync()

template<typename UpdateLongTermPricingRequestT = Model::UpdateLongTermPricingRequest>
void Aws::Snowball::SnowballClient::UpdateLongTermPricingAsync ( const UpdateLongTermPricingRequestT &  request,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
inline

An Async wrapper for UpdateLongTermPricing that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 884 of file SnowballClient.h.

◆ UpdateLongTermPricingCallable()

template<typename UpdateLongTermPricingRequestT = Model::UpdateLongTermPricingRequest>
Model::UpdateLongTermPricingOutcomeCallable Aws::Snowball::SnowballClient::UpdateLongTermPricingCallable ( const UpdateLongTermPricingRequestT &  request) const
inline

A Callable wrapper for UpdateLongTermPricing that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 875 of file SnowballClient.h.

Friends And Related Symbol Documentation

◆ Aws::Client::ClientWithAsyncTemplateMethods< SnowballClient >

Definition at line 891 of file SnowballClient.h.


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