/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the snowball-2016-06-30.normal.json service model. */ using System; using System.Collections.Generic; using Amazon.Runtime; using Amazon.Snowball.Model; namespace Amazon.Snowball { /// /// Interface for accessing Snowball /// /// 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. /// public partial interface IAmazonSnowball : IAmazonService, IDisposable { #if BCL45 || AWS_ASYNC_ENUMERABLES_API /// /// Paginators for the service /// ISnowballPaginatorFactory Paginators { get; } #endif #region CancelCluster /// /// 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. /// /// Container for the necessary parameters to execute the CancelCluster service method. /// /// The response from the CancelCluster service method, as returned by Snowball. /// /// The action can't be performed because the job's current state doesn't allow that action /// to be performed. /// /// /// The specified resource can't be found. Check the information you provided in your /// last request, and try again. /// /// /// The provided Key Management Service key lacks the permissions to perform the specified /// CreateJob or UpdateJob action. /// /// REST API Reference for CancelCluster Operation CancelClusterResponse CancelCluster(CancelClusterRequest request); /// /// Initiates the asynchronous execution of the CancelCluster operation. /// /// /// Container for the necessary parameters to execute the CancelCluster operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelCluster /// operation. /// REST API Reference for CancelCluster Operation IAsyncResult BeginCancelCluster(CancelClusterRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CancelCluster operation. /// /// /// The IAsyncResult returned by the call to BeginCancelCluster. /// /// Returns a CancelClusterResult from Snowball. /// REST API Reference for CancelCluster Operation CancelClusterResponse EndCancelCluster(IAsyncResult asyncResult); #endregion #region CancelJob /// /// 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. /// /// Container for the necessary parameters to execute the CancelJob service method. /// /// The response from the CancelJob service method, as returned by Snowball. /// /// The action can't be performed because the job's current state doesn't allow that action /// to be performed. /// /// /// The specified resource can't be found. Check the information you provided in your /// last request, and try again. /// /// /// The provided Key Management Service key lacks the permissions to perform the specified /// CreateJob or UpdateJob action. /// /// REST API Reference for CancelJob Operation CancelJobResponse CancelJob(CancelJobRequest request); /// /// Initiates the asynchronous execution of the CancelJob operation. /// /// /// Container for the necessary parameters to execute the CancelJob operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelJob /// operation. /// REST API Reference for CancelJob Operation IAsyncResult BeginCancelJob(CancelJobRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CancelJob operation. /// /// /// The IAsyncResult returned by the call to BeginCancelJob. /// /// Returns a CancelJobResult from Snowball. /// REST API Reference for CancelJob Operation CancelJobResponse EndCancelJob(IAsyncResult asyncResult); #endregion #region CreateAddress /// /// 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. /// /// Container for the necessary parameters to execute the CreateAddress service method. /// /// The response from the CreateAddress service method, as returned by Snowball. /// /// The address provided was invalid. Check the address with your region's carrier, and /// try again. /// /// /// The address is either outside the serviceable area for your region, or an error occurred. /// Check the address with your region's carrier and try again. If the issue persists, /// contact Amazon Web Services Support. /// /// REST API Reference for CreateAddress Operation CreateAddressResponse CreateAddress(CreateAddressRequest request); /// /// Initiates the asynchronous execution of the CreateAddress operation. /// /// /// Container for the necessary parameters to execute the CreateAddress operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateAddress /// operation. /// REST API Reference for CreateAddress Operation IAsyncResult BeginCreateAddress(CreateAddressRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreateAddress operation. /// /// /// The IAsyncResult returned by the call to BeginCreateAddress. /// /// Returns a CreateAddressResult from Snowball. /// REST API Reference for CreateAddress Operation CreateAddressResponse EndCreateAddress(IAsyncResult asyncResult); #endregion #region CreateCluster /// /// 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. /// /// Container for the necessary parameters to execute the CreateCluster service method. /// /// The response from the CreateCluster service method, as returned by Snowball. /// /// Your user lacks the necessary Amazon EC2 permissions to perform the attempted action. /// /// /// Job or cluster creation failed. One or more inputs were invalid. Confirm that the /// CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, /// and try again. /// /// /// The specified resource can't be found. Check the information you provided in your /// last request, and try again. /// /// /// The provided Key Management Service key lacks the permissions to perform the specified /// CreateJob or UpdateJob action. /// /// REST API Reference for CreateCluster Operation CreateClusterResponse CreateCluster(CreateClusterRequest request); /// /// Initiates the asynchronous execution of the CreateCluster operation. /// /// /// Container for the necessary parameters to execute the CreateCluster operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateCluster /// operation. /// REST API Reference for CreateCluster Operation IAsyncResult BeginCreateCluster(CreateClusterRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreateCluster operation. /// /// /// The IAsyncResult returned by the call to BeginCreateCluster. /// /// Returns a CreateClusterResult from Snowball. /// REST API Reference for CreateCluster Operation CreateClusterResponse EndCreateCluster(IAsyncResult asyncResult); #endregion #region CreateJob /// /// 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. /// ///

/// /// Container for the necessary parameters to execute the CreateJob service method. /// /// The response from the CreateJob service method, as returned by Snowball. /// /// Job creation failed. Currently, clusters support five nodes. If you have fewer than /// five nodes for your cluster and you have more nodes to create for this cluster, try /// again and create jobs until your cluster has exactly five nodes. /// /// /// Your user lacks the necessary Amazon EC2 permissions to perform the attempted action. /// /// /// Job or cluster creation failed. One or more inputs were invalid. Confirm that the /// CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, /// and try again. /// /// /// The specified resource can't be found. Check the information you provided in your /// last request, and try again. /// /// /// The provided Key Management Service key lacks the permissions to perform the specified /// CreateJob or UpdateJob action. /// /// REST API Reference for CreateJob Operation CreateJobResponse CreateJob(CreateJobRequest request); /// /// Initiates the asynchronous execution of the CreateJob operation. /// /// /// Container for the necessary parameters to execute the CreateJob operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateJob /// operation. /// REST API Reference for CreateJob Operation IAsyncResult BeginCreateJob(CreateJobRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreateJob operation. /// /// /// The IAsyncResult returned by the call to BeginCreateJob. /// /// Returns a CreateJobResult from Snowball. /// REST API Reference for CreateJob Operation CreateJobResponse EndCreateJob(IAsyncResult asyncResult); #endregion #region CreateLongTermPricing /// /// 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. /// /// Container for the necessary parameters to execute the CreateLongTermPricing service method. /// /// The response from the CreateLongTermPricing service method, as returned by Snowball. /// /// The specified resource can't be found. Check the information you provided in your /// last request, and try again. /// /// REST API Reference for CreateLongTermPricing Operation CreateLongTermPricingResponse CreateLongTermPricing(CreateLongTermPricingRequest request); /// /// Initiates the asynchronous execution of the CreateLongTermPricing operation. /// /// /// Container for the necessary parameters to execute the CreateLongTermPricing operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateLongTermPricing /// operation. /// REST API Reference for CreateLongTermPricing Operation IAsyncResult BeginCreateLongTermPricing(CreateLongTermPricingRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreateLongTermPricing operation. /// /// /// The IAsyncResult returned by the call to BeginCreateLongTermPricing. /// /// Returns a CreateLongTermPricingResult from Snowball. /// REST API Reference for CreateLongTermPricing Operation CreateLongTermPricingResponse EndCreateLongTermPricing(IAsyncResult asyncResult); #endregion #region CreateReturnShippingLabel /// /// Creates a shipping label that will be used to return the Snow device to Amazon Web /// Services. /// /// Container for the necessary parameters to execute the CreateReturnShippingLabel service method. /// /// The response from the CreateReturnShippingLabel service method, as returned by Snowball. /// /// You get this exception when you call CreateReturnShippingLabel more than /// once when other requests are not completed. /// /// /// Job or cluster creation failed. One or more inputs were invalid. Confirm that the /// CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, /// and try again. /// /// /// The action can't be performed because the job's current state doesn't allow that action /// to be performed. /// /// /// The specified resource can't be found. Check the information you provided in your /// last request, and try again. /// /// /// You get this exception if you call CreateReturnShippingLabel and a valid /// return shipping label already exists. In this case, use DescribeReturnShippingLabel /// to get the URL. /// /// REST API Reference for CreateReturnShippingLabel Operation CreateReturnShippingLabelResponse CreateReturnShippingLabel(CreateReturnShippingLabelRequest request); /// /// Initiates the asynchronous execution of the CreateReturnShippingLabel operation. /// /// /// Container for the necessary parameters to execute the CreateReturnShippingLabel operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateReturnShippingLabel /// operation. /// REST API Reference for CreateReturnShippingLabel Operation IAsyncResult BeginCreateReturnShippingLabel(CreateReturnShippingLabelRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreateReturnShippingLabel operation. /// /// /// The IAsyncResult returned by the call to BeginCreateReturnShippingLabel. /// /// Returns a CreateReturnShippingLabelResult from Snowball. /// REST API Reference for CreateReturnShippingLabel Operation CreateReturnShippingLabelResponse EndCreateReturnShippingLabel(IAsyncResult asyncResult); #endregion #region DescribeAddress /// /// Takes an AddressId and returns specific details about that address in /// the form of an Address object. /// /// Container for the necessary parameters to execute the DescribeAddress service method. /// /// The response from the DescribeAddress service method, as returned by Snowball. /// /// The specified resource can't be found. Check the information you provided in your /// last request, and try again. /// /// REST API Reference for DescribeAddress Operation DescribeAddressResponse DescribeAddress(DescribeAddressRequest request); /// /// Initiates the asynchronous execution of the DescribeAddress operation. /// /// /// Container for the necessary parameters to execute the DescribeAddress operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAddress /// operation. /// REST API Reference for DescribeAddress Operation IAsyncResult BeginDescribeAddress(DescribeAddressRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeAddress operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeAddress. /// /// Returns a DescribeAddressResult from Snowball. /// REST API Reference for DescribeAddress Operation DescribeAddressResponse EndDescribeAddress(IAsyncResult asyncResult); #endregion #region DescribeAddresses /// /// 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. /// /// Container for the necessary parameters to execute the DescribeAddresses service method. /// /// The response from the DescribeAddresses service method, as returned by Snowball. /// /// The NextToken string was altered unexpectedly, and the operation has /// stopped. Run the operation without changing the NextToken string, and /// try again. /// /// /// The specified resource can't be found. Check the information you provided in your /// last request, and try again. /// /// REST API Reference for DescribeAddresses Operation DescribeAddressesResponse DescribeAddresses(DescribeAddressesRequest request); /// /// Initiates the asynchronous execution of the DescribeAddresses operation. /// /// /// Container for the necessary parameters to execute the DescribeAddresses operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAddresses /// operation. /// REST API Reference for DescribeAddresses Operation IAsyncResult BeginDescribeAddresses(DescribeAddressesRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeAddresses operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeAddresses. /// /// Returns a DescribeAddressesResult from Snowball. /// REST API Reference for DescribeAddresses Operation DescribeAddressesResponse EndDescribeAddresses(IAsyncResult asyncResult); #endregion #region DescribeCluster /// /// Returns information about a specific cluster including shipping information, cluster /// status, and other important metadata. /// /// Container for the necessary parameters to execute the DescribeCluster service method. /// /// The response from the DescribeCluster service method, as returned by Snowball. /// /// The specified resource can't be found. Check the information you provided in your /// last request, and try again. /// /// REST API Reference for DescribeCluster Operation DescribeClusterResponse DescribeCluster(DescribeClusterRequest request); /// /// Initiates the asynchronous execution of the DescribeCluster operation. /// /// /// Container for the necessary parameters to execute the DescribeCluster operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeCluster /// operation. /// REST API Reference for DescribeCluster Operation IAsyncResult BeginDescribeCluster(DescribeClusterRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeCluster operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeCluster. /// /// Returns a DescribeClusterResult from Snowball. /// REST API Reference for DescribeCluster Operation DescribeClusterResponse EndDescribeCluster(IAsyncResult asyncResult); #endregion #region DescribeJob /// /// Returns information about a specific job including shipping information, job status, /// and other important metadata. /// /// Container for the necessary parameters to execute the DescribeJob service method. /// /// The response from the DescribeJob service method, as returned by Snowball. /// /// The specified resource can't be found. Check the information you provided in your /// last request, and try again. /// /// REST API Reference for DescribeJob Operation DescribeJobResponse DescribeJob(DescribeJobRequest request); /// /// Initiates the asynchronous execution of the DescribeJob operation. /// /// /// Container for the necessary parameters to execute the DescribeJob operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeJob /// operation. /// REST API Reference for DescribeJob Operation IAsyncResult BeginDescribeJob(DescribeJobRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeJob operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeJob. /// /// Returns a DescribeJobResult from Snowball. /// REST API Reference for DescribeJob Operation DescribeJobResponse EndDescribeJob(IAsyncResult asyncResult); #endregion #region DescribeReturnShippingLabel /// /// Information on the shipping label of a Snow device that is being returned to Amazon /// Web Services. /// /// Container for the necessary parameters to execute the DescribeReturnShippingLabel service method. /// /// The response from the DescribeReturnShippingLabel service method, as returned by Snowball. /// /// You get this exception when you call CreateReturnShippingLabel more than /// once when other requests are not completed. /// /// /// The action can't be performed because the job's current state doesn't allow that action /// to be performed. /// /// /// The specified resource can't be found. Check the information you provided in your /// last request, and try again. /// /// REST API Reference for DescribeReturnShippingLabel Operation DescribeReturnShippingLabelResponse DescribeReturnShippingLabel(DescribeReturnShippingLabelRequest request); /// /// Initiates the asynchronous execution of the DescribeReturnShippingLabel operation. /// /// /// Container for the necessary parameters to execute the DescribeReturnShippingLabel operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeReturnShippingLabel /// operation. /// REST API Reference for DescribeReturnShippingLabel Operation IAsyncResult BeginDescribeReturnShippingLabel(DescribeReturnShippingLabelRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeReturnShippingLabel operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeReturnShippingLabel. /// /// Returns a DescribeReturnShippingLabelResult from Snowball. /// REST API Reference for DescribeReturnShippingLabel Operation DescribeReturnShippingLabelResponse EndDescribeReturnShippingLabel(IAsyncResult asyncResult); #endregion #region GetJobManifest /// /// 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. /// /// /// Container for the necessary parameters to execute the GetJobManifest service method. /// /// The response from the GetJobManifest service method, as returned by Snowball. /// /// The action can't be performed because the job's current state doesn't allow that action /// to be performed. /// /// /// The specified resource can't be found. Check the information you provided in your /// last request, and try again. /// /// REST API Reference for GetJobManifest Operation GetJobManifestResponse GetJobManifest(GetJobManifestRequest request); /// /// Initiates the asynchronous execution of the GetJobManifest operation. /// /// /// Container for the necessary parameters to execute the GetJobManifest operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetJobManifest /// operation. /// REST API Reference for GetJobManifest Operation IAsyncResult BeginGetJobManifest(GetJobManifestRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetJobManifest operation. /// /// /// The IAsyncResult returned by the call to BeginGetJobManifest. /// /// Returns a GetJobManifestResult from Snowball. /// REST API Reference for GetJobManifest Operation GetJobManifestResponse EndGetJobManifest(IAsyncResult asyncResult); #endregion #region GetJobUnlockCode /// /// 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. /// /// /// Container for the necessary parameters to execute the GetJobUnlockCode service method. /// /// The response from the GetJobUnlockCode service method, as returned by Snowball. /// /// The action can't be performed because the job's current state doesn't allow that action /// to be performed. /// /// /// The specified resource can't be found. Check the information you provided in your /// last request, and try again. /// /// REST API Reference for GetJobUnlockCode Operation GetJobUnlockCodeResponse GetJobUnlockCode(GetJobUnlockCodeRequest request); /// /// Initiates the asynchronous execution of the GetJobUnlockCode operation. /// /// /// Container for the necessary parameters to execute the GetJobUnlockCode operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetJobUnlockCode /// operation. /// REST API Reference for GetJobUnlockCode Operation IAsyncResult BeginGetJobUnlockCode(GetJobUnlockCodeRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetJobUnlockCode operation. /// /// /// The IAsyncResult returned by the call to BeginGetJobUnlockCode. /// /// Returns a GetJobUnlockCodeResult from Snowball. /// REST API Reference for GetJobUnlockCode Operation GetJobUnlockCodeResponse EndGetJobUnlockCode(IAsyncResult asyncResult); #endregion #region GetSnowballUsage /// /// 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. /// /// /// Container for the necessary parameters to execute the GetSnowballUsage service method. /// /// The response from the GetSnowballUsage service method, as returned by Snowball. /// REST API Reference for GetSnowballUsage Operation GetSnowballUsageResponse GetSnowballUsage(GetSnowballUsageRequest request); /// /// Initiates the asynchronous execution of the GetSnowballUsage operation. /// /// /// Container for the necessary parameters to execute the GetSnowballUsage operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetSnowballUsage /// operation. /// REST API Reference for GetSnowballUsage Operation IAsyncResult BeginGetSnowballUsage(GetSnowballUsageRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetSnowballUsage operation. /// /// /// The IAsyncResult returned by the call to BeginGetSnowballUsage. /// /// Returns a GetSnowballUsageResult from Snowball. /// REST API Reference for GetSnowballUsage Operation GetSnowballUsageResponse EndGetSnowballUsage(IAsyncResult asyncResult); #endregion #region GetSoftwareUpdates /// /// Returns an Amazon S3 presigned URL for an update file associated with a specified /// JobId. /// /// Container for the necessary parameters to execute the GetSoftwareUpdates service method. /// /// The response from the GetSoftwareUpdates service method, as returned by Snowball. /// /// The action can't be performed because the job's current state doesn't allow that action /// to be performed. /// /// /// The specified resource can't be found. Check the information you provided in your /// last request, and try again. /// /// REST API Reference for GetSoftwareUpdates Operation GetSoftwareUpdatesResponse GetSoftwareUpdates(GetSoftwareUpdatesRequest request); /// /// Initiates the asynchronous execution of the GetSoftwareUpdates operation. /// /// /// Container for the necessary parameters to execute the GetSoftwareUpdates operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetSoftwareUpdates /// operation. /// REST API Reference for GetSoftwareUpdates Operation IAsyncResult BeginGetSoftwareUpdates(GetSoftwareUpdatesRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetSoftwareUpdates operation. /// /// /// The IAsyncResult returned by the call to BeginGetSoftwareUpdates. /// /// Returns a GetSoftwareUpdatesResult from Snowball. /// REST API Reference for GetSoftwareUpdates Operation GetSoftwareUpdatesResponse EndGetSoftwareUpdates(IAsyncResult asyncResult); #endregion #region ListClusterJobs /// /// 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. /// /// Container for the necessary parameters to execute the ListClusterJobs service method. /// /// The response from the ListClusterJobs service method, as returned by Snowball. /// /// The NextToken string was altered unexpectedly, and the operation has /// stopped. Run the operation without changing the NextToken string, and /// try again. /// /// /// The specified resource can't be found. Check the information you provided in your /// last request, and try again. /// /// REST API Reference for ListClusterJobs Operation ListClusterJobsResponse ListClusterJobs(ListClusterJobsRequest request); /// /// Initiates the asynchronous execution of the ListClusterJobs operation. /// /// /// Container for the necessary parameters to execute the ListClusterJobs operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListClusterJobs /// operation. /// REST API Reference for ListClusterJobs Operation IAsyncResult BeginListClusterJobs(ListClusterJobsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListClusterJobs operation. /// /// /// The IAsyncResult returned by the call to BeginListClusterJobs. /// /// Returns a ListClusterJobsResult from Snowball. /// REST API Reference for ListClusterJobs Operation ListClusterJobsResponse EndListClusterJobs(IAsyncResult asyncResult); #endregion #region ListClusters /// /// 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. /// /// Container for the necessary parameters to execute the ListClusters service method. /// /// The response from the ListClusters service method, as returned by Snowball. /// /// The NextToken string was altered unexpectedly, and the operation has /// stopped. Run the operation without changing the NextToken string, and /// try again. /// /// REST API Reference for ListClusters Operation ListClustersResponse ListClusters(ListClustersRequest request); /// /// Initiates the asynchronous execution of the ListClusters operation. /// /// /// Container for the necessary parameters to execute the ListClusters operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListClusters /// operation. /// REST API Reference for ListClusters Operation IAsyncResult BeginListClusters(ListClustersRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListClusters operation. /// /// /// The IAsyncResult returned by the call to BeginListClusters. /// /// Returns a ListClustersResult from Snowball. /// REST API Reference for ListClusters Operation ListClustersResponse EndListClusters(IAsyncResult asyncResult); #endregion #region ListCompatibleImages /// /// 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. /// /// Container for the necessary parameters to execute the ListCompatibleImages service method. /// /// The response from the ListCompatibleImages service method, as returned by Snowball. /// /// Your user lacks the necessary Amazon EC2 permissions to perform the attempted action. /// /// /// The NextToken string was altered unexpectedly, and the operation has /// stopped. Run the operation without changing the NextToken string, and /// try again. /// /// REST API Reference for ListCompatibleImages Operation ListCompatibleImagesResponse ListCompatibleImages(ListCompatibleImagesRequest request); /// /// Initiates the asynchronous execution of the ListCompatibleImages operation. /// /// /// Container for the necessary parameters to execute the ListCompatibleImages operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListCompatibleImages /// operation. /// REST API Reference for ListCompatibleImages Operation IAsyncResult BeginListCompatibleImages(ListCompatibleImagesRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListCompatibleImages operation. /// /// /// The IAsyncResult returned by the call to BeginListCompatibleImages. /// /// Returns a ListCompatibleImagesResult from Snowball. /// REST API Reference for ListCompatibleImages Operation ListCompatibleImagesResponse EndListCompatibleImages(IAsyncResult asyncResult); #endregion #region ListJobs /// /// 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. /// /// Container for the necessary parameters to execute the ListJobs service method. /// /// The response from the ListJobs service method, as returned by Snowball. /// /// The NextToken string was altered unexpectedly, and the operation has /// stopped. Run the operation without changing the NextToken string, and /// try again. /// /// REST API Reference for ListJobs Operation ListJobsResponse ListJobs(ListJobsRequest request); /// /// Initiates the asynchronous execution of the ListJobs operation. /// /// /// Container for the necessary parameters to execute the ListJobs operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListJobs /// operation. /// REST API Reference for ListJobs Operation IAsyncResult BeginListJobs(ListJobsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListJobs operation. /// /// /// The IAsyncResult returned by the call to BeginListJobs. /// /// Returns a ListJobsResult from Snowball. /// REST API Reference for ListJobs Operation ListJobsResponse EndListJobs(IAsyncResult asyncResult); #endregion #region ListLongTermPricing /// /// Lists all long-term pricing types. /// /// Container for the necessary parameters to execute the ListLongTermPricing service method. /// /// The response from the ListLongTermPricing service method, as returned by Snowball. /// /// The NextToken string was altered unexpectedly, and the operation has /// stopped. Run the operation without changing the NextToken string, and /// try again. /// /// /// The specified resource can't be found. Check the information you provided in your /// last request, and try again. /// /// REST API Reference for ListLongTermPricing Operation ListLongTermPricingResponse ListLongTermPricing(ListLongTermPricingRequest request); /// /// Initiates the asynchronous execution of the ListLongTermPricing operation. /// /// /// Container for the necessary parameters to execute the ListLongTermPricing operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListLongTermPricing /// operation. /// REST API Reference for ListLongTermPricing Operation IAsyncResult BeginListLongTermPricing(ListLongTermPricingRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListLongTermPricing operation. /// /// /// The IAsyncResult returned by the call to BeginListLongTermPricing. /// /// Returns a ListLongTermPricingResult from Snowball. /// REST API Reference for ListLongTermPricing Operation ListLongTermPricingResponse EndListLongTermPricing(IAsyncResult asyncResult); #endregion #region ListPickupLocations /// /// A list of locations from which the customer can choose to pickup a device. /// /// Container for the necessary parameters to execute the ListPickupLocations service method. /// /// The response from the ListPickupLocations service method, as returned by Snowball. /// /// The specified resource can't be found. Check the information you provided in your /// last request, and try again. /// /// REST API Reference for ListPickupLocations Operation ListPickupLocationsResponse ListPickupLocations(ListPickupLocationsRequest request); /// /// Initiates the asynchronous execution of the ListPickupLocations operation. /// /// /// Container for the necessary parameters to execute the ListPickupLocations operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListPickupLocations /// operation. /// REST API Reference for ListPickupLocations Operation IAsyncResult BeginListPickupLocations(ListPickupLocationsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListPickupLocations operation. /// /// /// The IAsyncResult returned by the call to BeginListPickupLocations. /// /// Returns a ListPickupLocationsResult from Snowball. /// REST API Reference for ListPickupLocations Operation ListPickupLocationsResponse EndListPickupLocations(IAsyncResult asyncResult); #endregion #region ListServiceVersions /// /// Lists all supported versions for Snow on-device services. Returns an array of ServiceVersion /// object containing the supported versions for a particular service. /// /// Container for the necessary parameters to execute the ListServiceVersions service method. /// /// The response from the ListServiceVersions service method, as returned by Snowball. /// /// The NextToken string was altered unexpectedly, and the operation has /// stopped. Run the operation without changing the NextToken string, and /// try again. /// /// /// The specified resource can't be found. Check the information you provided in your /// last request, and try again. /// /// REST API Reference for ListServiceVersions Operation ListServiceVersionsResponse ListServiceVersions(ListServiceVersionsRequest request); /// /// Initiates the asynchronous execution of the ListServiceVersions operation. /// /// /// Container for the necessary parameters to execute the ListServiceVersions operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListServiceVersions /// operation. /// REST API Reference for ListServiceVersions Operation IAsyncResult BeginListServiceVersions(ListServiceVersionsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListServiceVersions operation. /// /// /// The IAsyncResult returned by the call to BeginListServiceVersions. /// /// Returns a ListServiceVersionsResult from Snowball. /// REST API Reference for ListServiceVersions Operation ListServiceVersionsResponse EndListServiceVersions(IAsyncResult asyncResult); #endregion #region UpdateCluster /// /// 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. /// /// Container for the necessary parameters to execute the UpdateCluster service method. /// /// The response from the UpdateCluster service method, as returned by Snowball. /// /// Your user lacks the necessary Amazon EC2 permissions to perform the attempted action. /// /// /// Job or cluster creation failed. One or more inputs were invalid. Confirm that the /// CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, /// and try again. /// /// /// The action can't be performed because the job's current state doesn't allow that action /// to be performed. /// /// /// The specified resource can't be found. Check the information you provided in your /// last request, and try again. /// /// /// The provided Key Management Service key lacks the permissions to perform the specified /// CreateJob or UpdateJob action. /// /// REST API Reference for UpdateCluster Operation UpdateClusterResponse UpdateCluster(UpdateClusterRequest request); /// /// Initiates the asynchronous execution of the UpdateCluster operation. /// /// /// Container for the necessary parameters to execute the UpdateCluster operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateCluster /// operation. /// REST API Reference for UpdateCluster Operation IAsyncResult BeginUpdateCluster(UpdateClusterRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UpdateCluster operation. /// /// /// The IAsyncResult returned by the call to BeginUpdateCluster. /// /// Returns a UpdateClusterResult from Snowball. /// REST API Reference for UpdateCluster Operation UpdateClusterResponse EndUpdateCluster(IAsyncResult asyncResult); #endregion #region UpdateJob /// /// 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. /// /// Container for the necessary parameters to execute the UpdateJob service method. /// /// The response from the UpdateJob service method, as returned by Snowball. /// /// Job creation failed. Currently, clusters support five nodes. If you have fewer than /// five nodes for your cluster and you have more nodes to create for this cluster, try /// again and create jobs until your cluster has exactly five nodes. /// /// /// Your user lacks the necessary Amazon EC2 permissions to perform the attempted action. /// /// /// Job or cluster creation failed. One or more inputs were invalid. Confirm that the /// CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, /// and try again. /// /// /// The action can't be performed because the job's current state doesn't allow that action /// to be performed. /// /// /// The specified resource can't be found. Check the information you provided in your /// last request, and try again. /// /// /// The provided Key Management Service key lacks the permissions to perform the specified /// CreateJob or UpdateJob action. /// /// REST API Reference for UpdateJob Operation UpdateJobResponse UpdateJob(UpdateJobRequest request); /// /// Initiates the asynchronous execution of the UpdateJob operation. /// /// /// Container for the necessary parameters to execute the UpdateJob operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateJob /// operation. /// REST API Reference for UpdateJob Operation IAsyncResult BeginUpdateJob(UpdateJobRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UpdateJob operation. /// /// /// The IAsyncResult returned by the call to BeginUpdateJob. /// /// Returns a UpdateJobResult from Snowball. /// REST API Reference for UpdateJob Operation UpdateJobResponse EndUpdateJob(IAsyncResult asyncResult); #endregion #region UpdateJobShipmentState /// /// Updates the state when a shipment state changes to a different state. /// /// Container for the necessary parameters to execute the UpdateJobShipmentState service method. /// /// The response from the UpdateJobShipmentState service method, as returned by Snowball. /// /// The action can't be performed because the job's current state doesn't allow that action /// to be performed. /// /// /// The specified resource can't be found. Check the information you provided in your /// last request, and try again. /// /// REST API Reference for UpdateJobShipmentState Operation UpdateJobShipmentStateResponse UpdateJobShipmentState(UpdateJobShipmentStateRequest request); /// /// Initiates the asynchronous execution of the UpdateJobShipmentState operation. /// /// /// Container for the necessary parameters to execute the UpdateJobShipmentState operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateJobShipmentState /// operation. /// REST API Reference for UpdateJobShipmentState Operation IAsyncResult BeginUpdateJobShipmentState(UpdateJobShipmentStateRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UpdateJobShipmentState operation. /// /// /// The IAsyncResult returned by the call to BeginUpdateJobShipmentState. /// /// Returns a UpdateJobShipmentStateResult from Snowball. /// REST API Reference for UpdateJobShipmentState Operation UpdateJobShipmentStateResponse EndUpdateJobShipmentState(IAsyncResult asyncResult); #endregion #region UpdateLongTermPricing /// /// Updates the long-term pricing type. /// /// Container for the necessary parameters to execute the UpdateLongTermPricing service method. /// /// The response from the UpdateLongTermPricing service method, as returned by Snowball. /// /// The specified resource can't be found. Check the information you provided in your /// last request, and try again. /// /// REST API Reference for UpdateLongTermPricing Operation UpdateLongTermPricingResponse UpdateLongTermPricing(UpdateLongTermPricingRequest request); /// /// Initiates the asynchronous execution of the UpdateLongTermPricing operation. /// /// /// Container for the necessary parameters to execute the UpdateLongTermPricing operation on AmazonSnowballClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateLongTermPricing /// operation. /// REST API Reference for UpdateLongTermPricing Operation IAsyncResult BeginUpdateLongTermPricing(UpdateLongTermPricingRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UpdateLongTermPricing operation. /// /// /// The IAsyncResult returned by the call to BeginUpdateLongTermPricing. /// /// Returns a UpdateLongTermPricingResult from Snowball. /// REST API Reference for UpdateLongTermPricing Operation UpdateLongTermPricingResponse EndUpdateLongTermPricing(IAsyncResult asyncResult); #endregion } }