com.amazonaws.services.snowball.AmazonSnowball Maven / Gradle / Ivy
Show all versions of aws-java-sdk-snowball Show documentation
/*
* Copyright 2011-2016 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.
*/
package com.amazonaws.services.snowball;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.snowball.model.*;
/**
* Interface for accessing Amazon Snowball.
*
*
* This is a test of the welcome page front matter.
*
*/
public interface AmazonSnowball {
/**
* The region metadata service name for computing region endpoints. You can
* use this value to retrieve metadata (such as supported regions) of the
* service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "snowball";
/**
* Overrides the default endpoint for this client
* ("snowball.us-east-1.amazonaws.com/"). Callers can use this method to
* control which AWS region they want to work with.
*
* Callers can pass in just the endpoint (ex:
* "snowball.us-east-1.amazonaws.com/") or a full URL, including the
* protocol (ex: "snowball.us-east-1.amazonaws.com/"). If the protocol is
* not specified here, the default protocol from this client's
* {@link ClientConfiguration} will be used, which by default is HTTPS.
*
* For more information on using AWS regions with the AWS SDK for Java, and
* a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=
* 3912
*
* This method is not threadsafe. An endpoint should be configured when
* the client is created and before any service requests are made. Changing
* it afterwards creates inevitable race conditions for any service requests
* in transit or retrying.
*
* @param endpoint
* The endpoint (ex: "snowball.us-east-1.amazonaws.com/") or a full
* URL, including the protocol (ex:
* "snowball.us-east-1.amazonaws.com/") of the region specific AWS
* endpoint this client will communicate with.
*/
void setEndpoint(String endpoint);
/**
* An alternative to {@link AmazonSnowball#setEndpoint(String)}, sets the
* regional endpoint for this client's service calls. Callers can use this
* method to control which AWS region they want to work with.
*
* By default, all service endpoints in all regions use the https protocol.
* To use http instead, specify it in the {@link ClientConfiguration}
* supplied at construction.
*
* This method is not threadsafe. A region should be configured when the
* client is created and before any service requests are made. Changing it
* afterwards creates inevitable race conditions for any service requests in
* transit or retrying.
*
* @param region
* The region this client will communicate with. See
* {@link Region#getRegion(com.amazonaws.regions.Regions)} for
* accessing a given region. Must not be null and must be a region
* where the service is available.
*
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class,
* com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
*/
void setRegion(Region region);
/**
*
* Cancels the specified job. Note that you can only cancel a job before its
* JobState value changes to PreparingAppliance.
* Requesting the ListJobs or DescribeJob action
* will return a job's JobState as part of the response element
* data returned.
*
*
* @param cancelJobRequest
* @return Result of the CancelJob operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you
* provided in your last request, and try again.
* @throws InvalidJobStateException
* The action can't be performed because the job's current state
* doesn't allow that action to be performed.
* @throws KMSRequestFailedException
* The provided AWS Key Management Service key lacks the permissions
* to perform the specified CreateJob or UpdateJob
* action.
* @sample AmazonSnowball.CancelJob
*/
CancelJobResult cancelJob(CancelJobRequest cancelJobRequest);
/**
*
* Creates an address for a Snowball to be shipped to.
*
*
* 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.
*
*
* @param createAddressRequest
* @return Result of the CreateAddress operation returned by the service.
* @throws InvalidAddressException
* The address provided was invalid. Check the address with your
* region's carrier, and try again.
* @throws UnsupportedAddressException
* 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
* AWS Support.
* @sample AmazonSnowball.CreateAddress
*/
CreateAddressResult createAddress(CreateAddressRequest createAddressRequest);
/**
*
* Creates a job to import or export data between Amazon S3 and your
* on-premises data center. Note that your AWS account must have the right
* trust policies and permissions in place to create a job for Snowball. For
* more information, see api-reference-policies.
*
*
* @param createJobRequest
* @return Result of the CreateJob operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you
* provided in your last request, and try again.
* @throws KMSRequestFailedException
* The provided AWS Key Management Service key lacks the permissions
* to perform the specified CreateJob or UpdateJob
* action.
* @sample AmazonSnowball.CreateJob
*/
CreateJobResult createJob(CreateJobRequest createJobRequest);
/**
*
* Takes an AddressId and returns specific details about that
* address in the form of an Address object.
*
*
* @param describeAddressRequest
* @return Result of the DescribeAddress operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you
* provided in your last request, and try again.
* @sample AmazonSnowball.DescribeAddress
*/
DescribeAddressResult describeAddress(
DescribeAddressRequest describeAddressRequest);
/**
*
* 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.
*
*
* @param describeAddressesRequest
* @return Result of the DescribeAddresses operation returned by the
* service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you
* provided in your last request, and try again.
* @sample AmazonSnowball.DescribeAddresses
*/
DescribeAddressesResult describeAddresses(
DescribeAddressesRequest describeAddressesRequest);
/**
*
* Returns information about a specific job including shipping information,
* job status, and other important metadata.
*
*
* @param describeJobRequest
* @return Result of the DescribeJob operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you
* provided in your last request, and try again.
* @sample AmazonSnowball.DescribeJob
*/
DescribeJobResult describeJob(DescribeJobRequest describeJobRequest);
/**
*
* 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. The manifest is decrypted by
* using the UnlockCode code value, when you pass both values
* to the Snowball 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 Snowball associated with that job.
*
*
* Note that the credentials of a given job, including its manifest file and
* unlock code, expire 90 days after the job is created.
*
*
* @param getJobManifestRequest
* @return Result of the GetJobManifest operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you
* provided in your last request, and try again.
* @throws InvalidJobStateException
* The action can't be performed because the job's current state
* doesn't allow that action to be performed.
* @sample AmazonSnowball.GetJobManifest
*/
GetJobManifestResult getJobManifest(
GetJobManifestRequest getJobManifestRequest);
/**
*
* Returns the UnlockCode code value for the specified job. A
* particular UnlockCode value can be accessed for up to 90
* 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 Snowball
* 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 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 Snowball associated with that job.
*
*
* @param getJobUnlockCodeRequest
* @return Result of the GetJobUnlockCode operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you
* provided in your last request, and try again.
* @throws InvalidJobStateException
* The action can't be performed because the job's current state
* doesn't allow that action to be performed.
* @sample AmazonSnowball.GetJobUnlockCode
*/
GetJobUnlockCodeResult getJobUnlockCode(
GetJobUnlockCodeRequest getJobUnlockCodeRequest);
/**
*
* Returns information about the Snowball service limit for your account,
* and also the number of Snowballs your account has in use.
*
*
* Note that the default service limit for the number of Snowballs that you
* can have at one time is 1. If you want to increase your service limit,
* contact AWS Support.
*
*
* @param getSnowballUsageRequest
* @return Result of the GetSnowballUsage operation returned by the service.
* @sample AmazonSnowball.GetSnowballUsage
*/
GetSnowballUsageResult getSnowballUsage(
GetSnowballUsageRequest getSnowballUsageRequest);
/**
*
* 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.
*
*
* @param listJobsRequest
* @return Result of the ListJobs operation returned by the service.
* @sample AmazonSnowball.ListJobs
*/
ListJobsResult listJobs(ListJobsRequest listJobsRequest);
/**
*
* 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.
*
*
* @param updateJobRequest
* @return Result of the UpdateJob operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you
* provided in your last request, and try again.
* @throws InvalidJobStateException
* The action can't be performed because the job's current state
* doesn't allow that action to be performed.
* @throws KMSRequestFailedException
* The provided AWS Key Management Service key lacks the permissions
* to perform the specified CreateJob or UpdateJob
* action.
* @sample AmazonSnowball.UpdateJob
*/
UpdateJobResult updateJob(UpdateJobRequest updateJobRequest);
/**
* Shuts down this client object, releasing any resources that might be held
* open. This is an optional method, and callers are not expected to call
* it, but can if they want to explicitly release any open resources. Once a
* client has been shutdown, it should not be used to make any more
* requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request,
* typically used for debugging issues where a service isn't acting as
* expected. This data isn't considered part of the result data returned by
* an operation, so it's available through this separate, diagnostic
* interface.
*
* Response metadata is only cached for a limited period of time, so if you
* need to access this extra diagnostic information for an executed request,
* you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none
* is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}