@Generated(value="software.amazon.awssdk:codegen") public interface SnowballClient extends SdkClient
builder()
method.
AWS Snowball is a petabyte-scale data transport solution that uses secure appliances to transfer large amounts of data between your on-premises data centers and Amazon Simple Storage Service (Amazon S3). The Snowball commands described here provide access to the same functionality that is available in the AWS Snowball Management Console, which enables you to create and manage jobs for Snowball. To transfer data locally with a Snowball appliance, you'll need to use the Snowball client or the Amazon S3 API adapter for Snowball. For more information, see the User Guide.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static SnowballClientBuilder |
builder()
Create a builder that can be used to configure and create a
SnowballClient . |
default CancelClusterResponse |
cancelCluster(CancelClusterRequest cancelClusterRequest)
Cancels a cluster job.
|
default CancelClusterResponse |
cancelCluster(Consumer<CancelClusterRequest.Builder> cancelClusterRequest)
Cancels a cluster job.
|
default CancelJobResponse |
cancelJob(CancelJobRequest cancelJobRequest)
Cancels the specified job.
|
default CancelJobResponse |
cancelJob(Consumer<CancelJobRequest.Builder> cancelJobRequest)
Cancels the specified job.
|
static SnowballClient |
create()
Create a
SnowballClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateAddressResponse |
createAddress(Consumer<CreateAddressRequest.Builder> createAddressRequest)
Creates an address for a Snowball to be shipped to.
|
default CreateAddressResponse |
createAddress(CreateAddressRequest createAddressRequest)
Creates an address for a Snowball to be shipped to.
|
default CreateClusterResponse |
createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)
Creates an empty cluster.
|
default CreateClusterResponse |
createCluster(CreateClusterRequest createClusterRequest)
Creates an empty cluster.
|
default CreateJobResponse |
createJob(Consumer<CreateJobRequest.Builder> createJobRequest)
Creates a job to import or export data between Amazon S3 and your on-premises data center.
|
default CreateJobResponse |
createJob(CreateJobRequest createJobRequest)
Creates a job to the other job attributes are inherited from the cluster.
|
default DescribeAddressResponse |
describeAddress(Consumer<DescribeAddressRequest.Builder> describeAddressRequest)
Takes an
AddressId and returns specific details about that address in the form of an
Address object. |
default DescribeAddressResponse |
describeAddress(DescribeAddressRequest describeAddressRequest)
Takes an
AddressId and returns specific details about that address in the form of an
Address object. |
default DescribeAddressesResponse |
describeAddresses()
Returns a specified number of
ADDRESS objects. |
default DescribeAddressesResponse |
describeAddresses(Consumer<DescribeAddressesRequest.Builder> describeAddressesRequest)
Returns a specified number of
ADDRESS objects. |
default DescribeAddressesResponse |
describeAddresses(DescribeAddressesRequest describeAddressesRequest)
Returns a specified number of
ADDRESS objects. |
default DescribeAddressesIterable |
describeAddressesPaginator()
Returns a specified number of
ADDRESS objects. |
default DescribeAddressesIterable |
describeAddressesPaginator(Consumer<DescribeAddressesRequest.Builder> describeAddressesRequest)
Returns a specified number of
ADDRESS objects. |
default DescribeAddressesIterable |
describeAddressesPaginator(DescribeAddressesRequest describeAddressesRequest)
Returns a specified number of
ADDRESS objects. |
default DescribeClusterResponse |
describeCluster(Consumer<DescribeClusterRequest.Builder> describeClusterRequest)
Returns information about a specific cluster including shipping information, cluster status, and other important
metadata.
|
default DescribeClusterResponse |
describeCluster(DescribeClusterRequest describeClusterRequest)
Returns information about a specific cluster including shipping information, cluster status, and other important
metadata.
|
default DescribeJobResponse |
describeJob(Consumer<DescribeJobRequest.Builder> describeJobRequest)
Returns information about a specific job including shipping information, job status, and other important
metadata.
|
default DescribeJobResponse |
describeJob(DescribeJobRequest describeJobRequest)
Returns information about a specific job including shipping information, job status, and other important
metadata.
|
default GetJobManifestResponse |
getJobManifest(Consumer<GetJobManifestRequest.Builder> getJobManifestRequest)
Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified
JobId value. |
default GetJobManifestResponse |
getJobManifest(GetJobManifestRequest getJobManifestRequest)
Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified
JobId value. |
default GetJobUnlockCodeResponse |
getJobUnlockCode(Consumer<GetJobUnlockCodeRequest.Builder> getJobUnlockCodeRequest)
Returns the
UnlockCode code value for the specified job. |
default GetJobUnlockCodeResponse |
getJobUnlockCode(GetJobUnlockCodeRequest getJobUnlockCodeRequest)
Returns the
UnlockCode code value for the specified job. |
default GetSnowballUsageResponse |
getSnowballUsage()
Returns information about the Snowball service limit for your account, and also the number of Snowballs your
account has in use.
|
default GetSnowballUsageResponse |
getSnowballUsage(Consumer<GetSnowballUsageRequest.Builder> getSnowballUsageRequest)
Returns information about the Snowball service limit for your account, and also the number of Snowballs your
account has in use.
|
default GetSnowballUsageResponse |
getSnowballUsage(GetSnowballUsageRequest getSnowballUsageRequest)
Returns information about the Snowball service limit for your account, and also the number of Snowballs your
account has in use.
|
default ListClusterJobsResponse |
listClusterJobs(Consumer<ListClusterJobsRequest.Builder> listClusterJobsRequest)
Returns an array of
JobListEntry objects of the specified length. |
default ListClusterJobsResponse |
listClusterJobs(ListClusterJobsRequest listClusterJobsRequest)
Returns an array of
JobListEntry objects of the specified length. |
default ListClustersResponse |
listClusters()
Returns an array of
ClusterListEntry objects of the specified length. |
default ListClustersResponse |
listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)
Returns an array of
ClusterListEntry objects of the specified length. |
default ListClustersResponse |
listClusters(ListClustersRequest listClustersRequest)
Returns an array of
ClusterListEntry objects of the specified length. |
default ListJobsResponse |
listJobs()
Returns an array of
JobListEntry objects of the specified length. |
default ListJobsResponse |
listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest)
Returns an array of
JobListEntry objects of the specified length. |
default ListJobsResponse |
listJobs(ListJobsRequest listJobsRequest)
Returns an array of
JobListEntry objects of the specified length. |
default ListJobsIterable |
listJobsPaginator()
Returns an array of
JobListEntry objects of the specified length. |
default ListJobsIterable |
listJobsPaginator(Consumer<ListJobsRequest.Builder> listJobsRequest)
Returns an array of
JobListEntry objects of the specified length. |
default ListJobsIterable |
listJobsPaginator(ListJobsRequest listJobsRequest)
Returns an array of
JobListEntry objects of the specified length. |
static ServiceMetadata |
serviceMetadata() |
default UpdateClusterResponse |
updateCluster(Consumer<UpdateClusterRequest.Builder> updateClusterRequest)
While a cluster's
ClusterState value is in the AwaitingQuorum state, you can update
some of the information associated with a cluster. |
default UpdateClusterResponse |
updateCluster(UpdateClusterRequest updateClusterRequest)
While a cluster's
ClusterState value is in the AwaitingQuorum state, you can update
some of the information associated with a cluster. |
default UpdateJobResponse |
updateJob(Consumer<UpdateJobRequest.Builder> updateJobRequest)
While a job's
JobState value is New , you can update some of the information associated
with a job. |
default UpdateJobResponse |
updateJob(UpdateJobRequest updateJobRequest)
While a job's
JobState value is New , you can update some of the information associated
with a job. |
serviceName
close
static final String SERVICE_NAME
static SnowballClient create()
SnowballClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static SnowballClientBuilder builder()
SnowballClient
.default CancelClusterResponse cancelCluster(CancelClusterRequest cancelClusterRequest) throws KmsRequestFailedException, InvalidJobStateException, InvalidResourceException, AwsServiceException, SdkClientException, SnowballException
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.
cancelClusterRequest
- KmsRequestFailedException
- The provided AWS Key Management Service key lacks the permissions to perform the specified
CreateJob or UpdateJob action.InvalidJobStateException
- The action can't be performed because the job's current state doesn't allow that action to be performed.InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CancelClusterResponse cancelCluster(Consumer<CancelClusterRequest.Builder> cancelClusterRequest) throws KmsRequestFailedException, InvalidJobStateException, InvalidResourceException, AwsServiceException, SdkClientException, SnowballException
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.
This is a convenience which creates an instance of the CancelClusterRequest.Builder
avoiding the need to
create one manually via CancelClusterRequest.builder()
cancelClusterRequest
- A Consumer
that will call methods on CancelClusterRequest.Builder
to create a request.KmsRequestFailedException
- The provided AWS Key Management Service key lacks the permissions to perform the specified
CreateJob or UpdateJob action.InvalidJobStateException
- The action can't be performed because the job's current state doesn't allow that action to be performed.InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CancelJobResponse cancelJob(CancelJobRequest cancelJobRequest) throws InvalidResourceException, InvalidJobStateException, KmsRequestFailedException, AwsServiceException, SdkClientException, SnowballException
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.
cancelJobRequest
- InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.InvalidJobStateException
- The action can't be performed because the job's current state doesn't allow that action to be performed.KmsRequestFailedException
- The provided AWS Key Management Service key lacks the permissions to perform the specified
CreateJob or UpdateJob action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CancelJobResponse cancelJob(Consumer<CancelJobRequest.Builder> cancelJobRequest) throws InvalidResourceException, InvalidJobStateException, KmsRequestFailedException, AwsServiceException, SdkClientException, SnowballException
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.
This is a convenience which creates an instance of the CancelJobRequest.Builder
avoiding the need to
create one manually via CancelJobRequest.builder()
cancelJobRequest
- A Consumer
that will call methods on CancelJobRequest.Builder
to create a request.InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.InvalidJobStateException
- The action can't be performed because the job's current state doesn't allow that action to be performed.KmsRequestFailedException
- The provided AWS Key Management Service key lacks the permissions to perform the specified
CreateJob or UpdateJob action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateAddressResponse createAddress(CreateAddressRequest createAddressRequest) throws InvalidAddressException, UnsupportedAddressException, AwsServiceException, SdkClientException, SnowballException
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.
createAddressRequest
- InvalidAddressException
- The address provided was invalid. Check the address with your region's carrier, and try again.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateAddressResponse createAddress(Consumer<CreateAddressRequest.Builder> createAddressRequest) throws InvalidAddressException, UnsupportedAddressException, AwsServiceException, SdkClientException, SnowballException
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.
This is a convenience which creates an instance of the CreateAddressRequest.Builder
avoiding the need to
create one manually via CreateAddressRequest.builder()
createAddressRequest
- A Consumer
that will call methods on CreateAddressRequest.Builder
to create a request.InvalidAddressException
- The address provided was invalid. Check the address with your region's carrier, and try again.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateClusterResponse createCluster(CreateClusterRequest createClusterRequest) throws InvalidResourceException, KmsRequestFailedException, InvalidInputCombinationException, AwsServiceException, SdkClientException, SnowballException
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.
createClusterRequest
- InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.KmsRequestFailedException
- The provided AWS Key Management Service key lacks the permissions to perform the specified
CreateJob or UpdateJob action.InvalidInputCombinationException
- Job or cluster creation failed. One ore more inputs were invalid. Confirm that the
CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and
try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateClusterResponse createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest) throws InvalidResourceException, KmsRequestFailedException, InvalidInputCombinationException, AwsServiceException, SdkClientException, SnowballException
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.
This is a convenience which creates an instance of the CreateClusterRequest.Builder
avoiding the need to
create one manually via CreateClusterRequest.builder()
createClusterRequest
- A Consumer
that will call methods on CreateClusterRequest.Builder
to create a request.InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.KmsRequestFailedException
- The provided AWS Key Management Service key lacks the permissions to perform the specified
CreateJob or UpdateJob action.InvalidInputCombinationException
- Job or cluster creation failed. One ore more inputs were invalid. Confirm that the
CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and
try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateJobResponse createJob(CreateJobRequest createJobRequest) throws InvalidResourceException, KmsRequestFailedException, InvalidInputCombinationException, ClusterLimitExceededException, AwsServiceException, SdkClientException, SnowballException
Creates a job to the other job attributes are inherited from the cluster.
createJobRequest
- InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.KmsRequestFailedException
- The provided AWS Key Management Service key lacks the permissions to perform the specified
CreateJob or UpdateJob action.InvalidInputCombinationException
- Job or cluster creation failed. One ore more inputs were invalid. Confirm that the
CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and
try again.ClusterLimitExceededException
- Job creation failed. Currently, clusters support five nodes. If you have less 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 notes.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateJobResponse createJob(Consumer<CreateJobRequest.Builder> createJobRequest) throws InvalidResourceException, KmsRequestFailedException, InvalidInputCombinationException, ClusterLimitExceededException, AwsServiceException, SdkClientException, SnowballException
Creates a job to import or export data between Amazon S3 and your on-premises data center. Your AWS account must
have the right trust policies and permissions in place to create a job for Snowball. 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.
This is a convenience which creates an instance of the CreateJobRequest.Builder
avoiding the need to
create one manually via CreateJobRequest.builder()
createJobRequest
- A Consumer
that will call methods on CreateJobRequest.Builder
to create a request.InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.KmsRequestFailedException
- The provided AWS Key Management Service key lacks the permissions to perform the specified
CreateJob or UpdateJob action.InvalidInputCombinationException
- Job or cluster creation failed. One ore more inputs were invalid. Confirm that the
CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and
try again.ClusterLimitExceededException
- Job creation failed. Currently, clusters support five nodes. If you have less 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 notes.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAddressResponse describeAddress(DescribeAddressRequest describeAddressRequest) throws InvalidResourceException, AwsServiceException, SdkClientException, SnowballException
Takes an AddressId
and returns specific details about that address in the form of an
Address
object.
describeAddressRequest
- InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAddressResponse describeAddress(Consumer<DescribeAddressRequest.Builder> describeAddressRequest) throws InvalidResourceException, AwsServiceException, SdkClientException, SnowballException
Takes an AddressId
and returns specific details about that address in the form of an
Address
object.
This is a convenience which creates an instance of the DescribeAddressRequest.Builder
avoiding the need
to create one manually via DescribeAddressRequest.builder()
describeAddressRequest
- A Consumer
that will call methods on DescribeAddressRequest.Builder
to create a request.InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAddressesResponse describeAddresses() throws InvalidResourceException, InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException
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.
InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.InvalidNextTokenException
- The NextToken
string was altered unexpectedly, and the operation has stopped. Run the
operation without changing the NextToken
string, and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeAddresses(DescribeAddressesRequest)
,
AWS API
Documentationdefault DescribeAddressesResponse describeAddresses(DescribeAddressesRequest describeAddressesRequest) throws InvalidResourceException, InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException
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.
describeAddressesRequest
- InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.InvalidNextTokenException
- The NextToken
string was altered unexpectedly, and the operation has stopped. Run the
operation without changing the NextToken
string, and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAddressesResponse describeAddresses(Consumer<DescribeAddressesRequest.Builder> describeAddressesRequest) throws InvalidResourceException, InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException
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.
This is a convenience which creates an instance of the DescribeAddressesRequest.Builder
avoiding the need
to create one manually via DescribeAddressesRequest.builder()
describeAddressesRequest
- A Consumer
that will call methods on DescribeAddressesRequest.Builder
to create a request.InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.InvalidNextTokenException
- The NextToken
string was altered unexpectedly, and the operation has stopped. Run the
operation without changing the NextToken
string, and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAddressesIterable describeAddressesPaginator() throws InvalidResourceException, InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException
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.
This is a variant of
describeAddresses(software.amazon.awssdk.services.snowball.model.DescribeAddressesRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.snowball.paginators.DescribeAddressesIterable responses = client.describeAddressesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.snowball.paginators.DescribeAddressesIterable responses = client .describeAddressesPaginator(request); for (software.amazon.awssdk.services.snowball.model.DescribeAddressesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.snowball.paginators.DescribeAddressesIterable responses = client.describeAddressesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeAddresses(software.amazon.awssdk.services.snowball.model.DescribeAddressesRequest)
operation.
InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.InvalidNextTokenException
- The NextToken
string was altered unexpectedly, and the operation has stopped. Run the
operation without changing the NextToken
string, and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeAddressesPaginator(DescribeAddressesRequest)
,
AWS API
Documentationdefault DescribeAddressesIterable describeAddressesPaginator(DescribeAddressesRequest describeAddressesRequest) throws InvalidResourceException, InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException
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.
This is a variant of
describeAddresses(software.amazon.awssdk.services.snowball.model.DescribeAddressesRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.snowball.paginators.DescribeAddressesIterable responses = client.describeAddressesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.snowball.paginators.DescribeAddressesIterable responses = client .describeAddressesPaginator(request); for (software.amazon.awssdk.services.snowball.model.DescribeAddressesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.snowball.paginators.DescribeAddressesIterable responses = client.describeAddressesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeAddresses(software.amazon.awssdk.services.snowball.model.DescribeAddressesRequest)
operation.
describeAddressesRequest
- InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.InvalidNextTokenException
- The NextToken
string was altered unexpectedly, and the operation has stopped. Run the
operation without changing the NextToken
string, and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAddressesIterable describeAddressesPaginator(Consumer<DescribeAddressesRequest.Builder> describeAddressesRequest) throws InvalidResourceException, InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException
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.
This is a variant of
describeAddresses(software.amazon.awssdk.services.snowball.model.DescribeAddressesRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.snowball.paginators.DescribeAddressesIterable responses = client.describeAddressesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.snowball.paginators.DescribeAddressesIterable responses = client .describeAddressesPaginator(request); for (software.amazon.awssdk.services.snowball.model.DescribeAddressesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.snowball.paginators.DescribeAddressesIterable responses = client.describeAddressesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeAddresses(software.amazon.awssdk.services.snowball.model.DescribeAddressesRequest)
operation.
This is a convenience which creates an instance of the DescribeAddressesRequest.Builder
avoiding the need
to create one manually via DescribeAddressesRequest.builder()
describeAddressesRequest
- A Consumer
that will call methods on DescribeAddressesRequest.Builder
to create a request.InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.InvalidNextTokenException
- The NextToken
string was altered unexpectedly, and the operation has stopped. Run the
operation without changing the NextToken
string, and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeClusterResponse describeCluster(DescribeClusterRequest describeClusterRequest) throws InvalidResourceException, AwsServiceException, SdkClientException, SnowballException
Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
describeClusterRequest
- InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeClusterResponse describeCluster(Consumer<DescribeClusterRequest.Builder> describeClusterRequest) throws InvalidResourceException, AwsServiceException, SdkClientException, SnowballException
Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
This is a convenience which creates an instance of the DescribeClusterRequest.Builder
avoiding the need
to create one manually via DescribeClusterRequest.builder()
describeClusterRequest
- A Consumer
that will call methods on DescribeClusterRequest.Builder
to create a request.InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeJobResponse describeJob(DescribeJobRequest describeJobRequest) throws InvalidResourceException, AwsServiceException, SdkClientException, SnowballException
Returns information about a specific job including shipping information, job status, and other important metadata.
describeJobRequest
- InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeJobResponse describeJob(Consumer<DescribeJobRequest.Builder> describeJobRequest) throws InvalidResourceException, AwsServiceException, SdkClientException, SnowballException
Returns information about a specific job including shipping information, job status, and other important metadata.
This is a convenience which creates an instance of the DescribeJobRequest.Builder
avoiding the need to
create one manually via DescribeJobRequest.builder()
describeJobRequest
- A Consumer
that will call methods on DescribeJobRequest.Builder
to create a request.InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetJobManifestResponse getJobManifest(GetJobManifestRequest getJobManifestRequest) throws InvalidResourceException, InvalidJobStateException, AwsServiceException, SdkClientException, SnowballException
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.
getJobManifestRequest
- InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.InvalidJobStateException
- The action can't be performed because the job's current state doesn't allow that action to be performed.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetJobManifestResponse getJobManifest(Consumer<GetJobManifestRequest.Builder> getJobManifestRequest) throws InvalidResourceException, InvalidJobStateException, AwsServiceException, SdkClientException, SnowballException
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.
This is a convenience which creates an instance of the GetJobManifestRequest.Builder
avoiding the need to
create one manually via GetJobManifestRequest.builder()
getJobManifestRequest
- A Consumer
that will call methods on GetJobManifestRequest.Builder
to create a request.InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.InvalidJobStateException
- The action can't be performed because the job's current state doesn't allow that action to be performed.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetJobUnlockCodeResponse getJobUnlockCode(GetJobUnlockCodeRequest getJobUnlockCodeRequest) throws InvalidResourceException, InvalidJobStateException, AwsServiceException, SdkClientException, SnowballException
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.
getJobUnlockCodeRequest
- InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.InvalidJobStateException
- The action can't be performed because the job's current state doesn't allow that action to be performed.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetJobUnlockCodeResponse getJobUnlockCode(Consumer<GetJobUnlockCodeRequest.Builder> getJobUnlockCodeRequest) throws InvalidResourceException, InvalidJobStateException, AwsServiceException, SdkClientException, SnowballException
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.
This is a convenience which creates an instance of the GetJobUnlockCodeRequest.Builder
avoiding the need
to create one manually via GetJobUnlockCodeRequest.builder()
getJobUnlockCodeRequest
- A Consumer
that will call methods on GetJobUnlockCodeRequest.Builder
to create a request.InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.InvalidJobStateException
- The action can't be performed because the job's current state doesn't allow that action to be performed.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetSnowballUsageResponse getSnowballUsage() throws AwsServiceException, SdkClientException, SnowballException
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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getSnowballUsage(GetSnowballUsageRequest)
,
AWS API
Documentationdefault GetSnowballUsageResponse getSnowballUsage(GetSnowballUsageRequest getSnowballUsageRequest) throws AwsServiceException, SdkClientException, SnowballException
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.
getSnowballUsageRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetSnowballUsageResponse getSnowballUsage(Consumer<GetSnowballUsageRequest.Builder> getSnowballUsageRequest) throws AwsServiceException, SdkClientException, SnowballException
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.
This is a convenience which creates an instance of the GetSnowballUsageRequest.Builder
avoiding the need
to create one manually via GetSnowballUsageRequest.builder()
getSnowballUsageRequest
- A Consumer
that will call methods on GetSnowballUsageRequest.Builder
to create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListClusterJobsResponse listClusterJobs(ListClusterJobsRequest listClusterJobsRequest) throws InvalidResourceException, InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException
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.
listClusterJobsRequest
- InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.InvalidNextTokenException
- The NextToken
string was altered unexpectedly, and the operation has stopped. Run the
operation without changing the NextToken
string, and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListClusterJobsResponse listClusterJobs(Consumer<ListClusterJobsRequest.Builder> listClusterJobsRequest) throws InvalidResourceException, InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException
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.
This is a convenience which creates an instance of the ListClusterJobsRequest.Builder
avoiding the need
to create one manually via ListClusterJobsRequest.builder()
listClusterJobsRequest
- A Consumer
that will call methods on ListClusterJobsRequest.Builder
to create a request.InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.InvalidNextTokenException
- The NextToken
string was altered unexpectedly, and the operation has stopped. Run the
operation without changing the NextToken
string, and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListClustersResponse listClusters() throws InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException
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.
InvalidNextTokenException
- The NextToken
string was altered unexpectedly, and the operation has stopped. Run the
operation without changing the NextToken
string, and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listClusters(ListClustersRequest)
,
AWS API
Documentationdefault ListClustersResponse listClusters(ListClustersRequest listClustersRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException
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.
listClustersRequest
- InvalidNextTokenException
- The NextToken
string was altered unexpectedly, and the operation has stopped. Run the
operation without changing the NextToken
string, and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListClustersResponse listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException
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.
This is a convenience which creates an instance of the ListClustersRequest.Builder
avoiding the need to
create one manually via ListClustersRequest.builder()
listClustersRequest
- A Consumer
that will call methods on ListClustersRequest.Builder
to create a request.InvalidNextTokenException
- The NextToken
string was altered unexpectedly, and the operation has stopped. Run the
operation without changing the NextToken
string, and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListJobsResponse listJobs() throws InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException
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.
InvalidNextTokenException
- The NextToken
string was altered unexpectedly, and the operation has stopped. Run the
operation without changing the NextToken
string, and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listJobs(ListJobsRequest)
,
AWS API
Documentationdefault ListJobsResponse listJobs(ListJobsRequest listJobsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException
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.
listJobsRequest
- InvalidNextTokenException
- The NextToken
string was altered unexpectedly, and the operation has stopped. Run the
operation without changing the NextToken
string, and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListJobsResponse listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException
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.
This is a convenience which creates an instance of the ListJobsRequest.Builder
avoiding the need to
create one manually via ListJobsRequest.builder()
listJobsRequest
- A Consumer
that will call methods on ListJobsRequest.Builder
to create a request.InvalidNextTokenException
- The NextToken
string was altered unexpectedly, and the operation has stopped. Run the
operation without changing the NextToken
string, and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListJobsIterable listJobsPaginator() throws InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException
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.
This is a variant of listJobs(software.amazon.awssdk.services.snowball.model.ListJobsRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.snowball.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.snowball.paginators.ListJobsIterable responses = client.listJobsPaginator(request); for (software.amazon.awssdk.services.snowball.model.ListJobsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.snowball.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listJobs(software.amazon.awssdk.services.snowball.model.ListJobsRequest)
operation.
InvalidNextTokenException
- The NextToken
string was altered unexpectedly, and the operation has stopped. Run the
operation without changing the NextToken
string, and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listJobsPaginator(ListJobsRequest)
,
AWS API
Documentationdefault ListJobsIterable listJobsPaginator(ListJobsRequest listJobsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException
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.
This is a variant of listJobs(software.amazon.awssdk.services.snowball.model.ListJobsRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.snowball.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.snowball.paginators.ListJobsIterable responses = client.listJobsPaginator(request); for (software.amazon.awssdk.services.snowball.model.ListJobsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.snowball.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listJobs(software.amazon.awssdk.services.snowball.model.ListJobsRequest)
operation.
listJobsRequest
- InvalidNextTokenException
- The NextToken
string was altered unexpectedly, and the operation has stopped. Run the
operation without changing the NextToken
string, and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListJobsIterable listJobsPaginator(Consumer<ListJobsRequest.Builder> listJobsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException
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.
This is a variant of listJobs(software.amazon.awssdk.services.snowball.model.ListJobsRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.snowball.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.snowball.paginators.ListJobsIterable responses = client.listJobsPaginator(request); for (software.amazon.awssdk.services.snowball.model.ListJobsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.snowball.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listJobs(software.amazon.awssdk.services.snowball.model.ListJobsRequest)
operation.
This is a convenience which creates an instance of the ListJobsRequest.Builder
avoiding the need to
create one manually via ListJobsRequest.builder()
listJobsRequest
- A Consumer
that will call methods on ListJobsRequest.Builder
to create a request.InvalidNextTokenException
- The NextToken
string was altered unexpectedly, and the operation has stopped. Run the
operation without changing the NextToken
string, and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateClusterResponse updateCluster(UpdateClusterRequest updateClusterRequest) throws InvalidResourceException, InvalidJobStateException, KmsRequestFailedException, InvalidInputCombinationException, AwsServiceException, SdkClientException, SnowballException
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.
updateClusterRequest
- InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.InvalidJobStateException
- The action can't be performed because the job's current state doesn't allow that action to be performed.KmsRequestFailedException
- The provided AWS Key Management Service key lacks the permissions to perform the specified
CreateJob or UpdateJob action.InvalidInputCombinationException
- Job or cluster creation failed. One ore more inputs were invalid. Confirm that the
CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and
try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateClusterResponse updateCluster(Consumer<UpdateClusterRequest.Builder> updateClusterRequest) throws InvalidResourceException, InvalidJobStateException, KmsRequestFailedException, InvalidInputCombinationException, AwsServiceException, SdkClientException, SnowballException
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.
This is a convenience which creates an instance of the UpdateClusterRequest.Builder
avoiding the need to
create one manually via UpdateClusterRequest.builder()
updateClusterRequest
- A Consumer
that will call methods on UpdateClusterRequest.Builder
to create a request.InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.InvalidJobStateException
- The action can't be performed because the job's current state doesn't allow that action to be performed.KmsRequestFailedException
- The provided AWS Key Management Service key lacks the permissions to perform the specified
CreateJob or UpdateJob action.InvalidInputCombinationException
- Job or cluster creation failed. One ore more inputs were invalid. Confirm that the
CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and
try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateJobResponse updateJob(UpdateJobRequest updateJobRequest) throws InvalidResourceException, InvalidJobStateException, KmsRequestFailedException, InvalidInputCombinationException, ClusterLimitExceededException, AwsServiceException, SdkClientException, SnowballException
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.
updateJobRequest
- InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.InvalidJobStateException
- The action can't be performed because the job's current state doesn't allow that action to be performed.KmsRequestFailedException
- The provided AWS Key Management Service key lacks the permissions to perform the specified
CreateJob or UpdateJob action.InvalidInputCombinationException
- Job or cluster creation failed. One ore more inputs were invalid. Confirm that the
CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and
try again.ClusterLimitExceededException
- Job creation failed. Currently, clusters support five nodes. If you have less 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 notes.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateJobResponse updateJob(Consumer<UpdateJobRequest.Builder> updateJobRequest) throws InvalidResourceException, InvalidJobStateException, KmsRequestFailedException, InvalidInputCombinationException, ClusterLimitExceededException, AwsServiceException, SdkClientException, SnowballException
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.
This is a convenience which creates an instance of the UpdateJobRequest.Builder
avoiding the need to
create one manually via UpdateJobRequest.builder()
updateJobRequest
- A Consumer
that will call methods on UpdateJobRequest.Builder
to create a request.InvalidResourceException
- The specified resource can't be found. Check the information you provided in your last request, and try
again.InvalidJobStateException
- The action can't be performed because the job's current state doesn't allow that action to be performed.KmsRequestFailedException
- The provided AWS Key Management Service key lacks the permissions to perform the specified
CreateJob or UpdateJob action.InvalidInputCombinationException
- Job or cluster creation failed. One ore more inputs were invalid. Confirm that the
CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and
try again.ClusterLimitExceededException
- Job creation failed. Currently, clusters support five nodes. If you have less 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 notes.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SnowballException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.