AbstractAmazonSnowball (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.snowball.AbstractAmazonSnowball

All Implemented Interfaces:

AmazonSnowball

Direct Known Subclasses:

AbstractAmazonSnowballAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonSnowball
extends Object
implements AmazonSnowball
```
Abstract implementation of AmazonSnowball. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.snowball.AmazonSnowball
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CancelClusterResult`	`cancelCluster(CancelClusterRequest request)` Cancels a cluster job.
`CancelJobResult`	`cancelJob(CancelJobRequest request)` Cancels the specified job.
`CreateAddressResult`	`createAddress(CreateAddressRequest request)` Creates an address for a Snowball to be shipped to.
`CreateClusterResult`	`createCluster(CreateClusterRequest request)` Creates an empty cluster.
`CreateJobResult`	`createJob(CreateJobRequest request)` Creates a job to the other job attributes are inherited from the cluster.
`DescribeAddressResult`	`describeAddress(DescribeAddressRequest request)` Takes an `AddressId` and returns specific details about that address in the form of an `Address` object.
`DescribeAddressesResult`	`describeAddresses(DescribeAddressesRequest request)` Returns a specified number of `ADDRESS` objects.
`DescribeClusterResult`	`describeCluster(DescribeClusterRequest request)` Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
`DescribeJobResult`	`describeJob(DescribeJobRequest request)` Returns information about a specific job including shipping information, job status, and other important metadata.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetJobManifestResult`	`getJobManifest(GetJobManifestRequest request)` Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified `JobId` value.
`GetJobUnlockCodeResult`	`getJobUnlockCode(GetJobUnlockCodeRequest request)` Returns the `UnlockCode` code value for the specified job.
`GetSnowballUsageResult`	`getSnowballUsage(GetSnowballUsageRequest request)` Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.
`ListClusterJobsResult`	`listClusterJobs(ListClusterJobsRequest request)` Returns an array of `JobListEntry` objects of the specified length.
`ListClustersResult`	`listClusters(ListClustersRequest request)` Returns an array of `ClusterListEntry` objects of the specified length.
`ListJobsResult`	`listJobs(ListJobsRequest request)` Returns an array of `JobListEntry` objects of the specified length.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("snowball.us-east-1.amazonaws.com/").
`void`	`setRegion(Region region)` An alternative to `AmazonSnowball.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`UpdateClusterResult`	`updateCluster(UpdateClusterRequest request)` While a cluster's `ClusterState` value is in the `AwaitingQuorum` state, you can update some of the information associated with a cluster.
`UpdateJobResult`	`updateJob(UpdateJobRequest request)` While a job's `JobState` value is `New`, you can update some of the information associated with a job.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AmazonSnowball
    
    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 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.
    
    Specified by:
    
    setEndpoint in interface AmazonSnowball
    
    Parameters:
    
    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.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AmazonSnowball
    
    An alternative to 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 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.
    
    Specified by:
    
    setRegion in interface AmazonSnowball
    
    Parameters:
    
    region - The region this client will communicate with. See 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 Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - cancelCluster
```
public CancelClusterResult cancelCluster(CancelClusterRequest request)
```
    Description copied from interface: AmazonSnowball
    
    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.
    
    Specified by:
    
    cancelCluster in interface AmazonSnowball
    
    Returns:
    
    Result of the CancelCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - cancelJob
```
public CancelJobResult cancelJob(CancelJobRequest request)
```
    Description copied from interface: AmazonSnowball
    
    Cancels the specified job. 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.
    
    Specified by:
    
    cancelJob in interface AmazonSnowball
    
    Returns:
    
    Result of the CancelJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createAddress
```
public CreateAddressResult createAddress(CreateAddressRequest request)
```
    Description copied from interface: AmazonSnowball
    
    Creates an address for a Snowball 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.
    
    Specified by:
    
    createAddress in interface AmazonSnowball
    
    Returns:
    
    Result of the CreateAddress operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createCluster
```
public CreateClusterResult createCluster(CreateClusterRequest request)
```
    Description copied from interface: AmazonSnowball
    
    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.
    
    Specified by:
    
    createCluster in interface AmazonSnowball
    
    Returns:
    
    Result of the CreateCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createJob
```
public CreateJobResult createJob(CreateJobRequest request)
```
    Description copied from interface: AmazonSnowball
    
    Creates a job to the other job attributes are inherited from the cluster.
    
    Specified by:
    
    createJob in interface AmazonSnowball
    
    Returns:
    
    Result of the CreateJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeAddress
```
public DescribeAddressResult describeAddress(DescribeAddressRequest request)
```
    Description copied from interface: AmazonSnowball
    
    Takes an AddressId and returns specific details about that address in the form of an Address object.
    
    Specified by:
    
    describeAddress in interface AmazonSnowball
    
    Returns:
    
    Result of the DescribeAddress operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeAddresses
```
public DescribeAddressesResult describeAddresses(DescribeAddressesRequest request)
```
    Description copied from interface: AmazonSnowball
    
    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.
    
    Specified by:
    
    describeAddresses in interface AmazonSnowball
    
    Returns:
    
    Result of the DescribeAddresses operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeCluster
```
public DescribeClusterResult describeCluster(DescribeClusterRequest request)
```
    Description copied from interface: AmazonSnowball
    
    Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
    
    Specified by:
    
    describeCluster in interface AmazonSnowball
    
    Returns:
    
    Result of the DescribeCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeJob
```
public DescribeJobResult describeJob(DescribeJobRequest request)
```
    Description copied from interface: AmazonSnowball
    
    Returns information about a specific job including shipping information, job status, and other important metadata.
    
    Specified by:
    
    describeJob in interface AmazonSnowball
    
    Returns:
    
    Result of the DescribeJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getJobManifest
```
public GetJobManifestResult getJobManifest(GetJobManifestRequest request)
```
    Description copied from interface: AmazonSnowball
    
    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.
    
    The credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created.
    
    Specified by:
    
    getJobManifest in interface AmazonSnowball
    
    Returns:
    
    Result of the GetJobManifest operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getJobUnlockCode
```
public GetJobUnlockCodeResult getJobUnlockCode(GetJobUnlockCodeRequest request)
```
    Description copied from interface: AmazonSnowball
    
    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.
    
    Specified by:
    
    getJobUnlockCode in interface AmazonSnowball
    
    Returns:
    
    Result of the GetJobUnlockCode operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getSnowballUsage
```
public GetSnowballUsageResult getSnowballUsage(GetSnowballUsageRequest request)
```
    Description copied from interface: AmazonSnowball
    
    Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.
    
    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.
    
    Specified by:
    
    getSnowballUsage in interface AmazonSnowball
    
    Returns:
    
    Result of the GetSnowballUsage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listClusterJobs
```
public ListClusterJobsResult listClusterJobs(ListClusterJobsRequest request)
```
    Description copied from interface: AmazonSnowball
    
    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.
    
    Specified by:
    
    listClusterJobs in interface AmazonSnowball
    
    Returns:
    
    Result of the ListClusterJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listClusters
```
public ListClustersResult listClusters(ListClustersRequest request)
```
    Description copied from interface: AmazonSnowball
    
    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.
    
    Specified by:
    
    listClusters in interface AmazonSnowball
    
    Returns:
    
    Result of the ListClusters operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listJobs
```
public ListJobsResult listJobs(ListJobsRequest request)
```
    Description copied from interface: AmazonSnowball
    
    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.
    
    Specified by:
    
    listJobs in interface AmazonSnowball
    
    Returns:
    
    Result of the ListJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateCluster
```
public UpdateClusterResult updateCluster(UpdateClusterRequest request)
```
    Description copied from interface: AmazonSnowball
    
    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.
    
    Specified by:
    
    updateCluster in interface AmazonSnowball
    
    Returns:
    
    Result of the UpdateCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateJob
```
public UpdateJobResult updateJob(UpdateJobRequest request)
```
    Description copied from interface: AmazonSnowball
    
    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.
    
    Specified by:
    
    updateJob in interface AmazonSnowball
    
    Returns:
    
    Result of the UpdateJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonSnowball
    
    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.
    
    Specified by:
    
    shutdown in interface AmazonSnowball
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonSnowball
    
    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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonSnowball
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAmazonSnowball

Field Summary

Fields inherited from interface com.amazonaws.services.snowball.AmazonSnowball

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

cancelCluster

cancelJob

createAddress

createCluster

createJob

describeAddress

describeAddresses

describeCluster

describeJob

getJobManifest

getJobUnlockCode

getSnowballUsage

listClusterJobs

listClusters

listJobs

updateCluster

updateJob

shutdown

getCachedResponseMetadata