@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface SnowballClient extends AwsClient
builder() method.
The Amazon Web Services Snow Family provides a petabyte-scale data transport solution that uses secure devices to transfer large amounts of data between your on-premises data centers and Amazon Simple Storage Service (Amazon S3). The Snow Family commands described here provide access to the same functionality that is available in the Amazon Web Services Snow Family Management Console, which enables you to create and manage jobs for a Snow Family device. To transfer data locally with a Snow Family device, you'll need to use the Snowball Edge client or the Amazon S3 API Interface for Snowball or OpsHub for Snow Family. For more information, see the User Guide.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
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 Snow device to be shipped to.
|
default CreateAddressResponse |
createAddress(CreateAddressRequest createAddressRequest)
Creates an address for a Snow device 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 import or export data between Amazon S3 and your on-premises data center.
|
default CreateLongTermPricingResponse |
createLongTermPricing(Consumer<CreateLongTermPricingRequest.Builder> createLongTermPricingRequest)
Creates a job with the long-term usage option for a device.
|
default CreateLongTermPricingResponse |
createLongTermPricing(CreateLongTermPricingRequest createLongTermPricingRequest)
Creates a job with the long-term usage option for a device.
|
default CreateReturnShippingLabelResponse |
createReturnShippingLabel(Consumer<CreateReturnShippingLabelRequest.Builder> createReturnShippingLabelRequest)
Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
|
default CreateReturnShippingLabelResponse |
createReturnShippingLabel(CreateReturnShippingLabelRequest createReturnShippingLabelRequest)
Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
|
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 DescribeReturnShippingLabelResponse |
describeReturnShippingLabel(Consumer<DescribeReturnShippingLabelRequest.Builder> describeReturnShippingLabelRequest)
Information on the shipping label of a Snow device that is being returned to Amazon Web Services.
|
default DescribeReturnShippingLabelResponse |
describeReturnShippingLabel(DescribeReturnShippingLabelRequest describeReturnShippingLabelRequest)
Information on the shipping label of a Snow device that is being returned to Amazon Web Services.
|
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 Snow Family service limit for your account, and also the number of Snow devices
your account has in use.
|
default GetSnowballUsageResponse |
getSnowballUsage(Consumer<GetSnowballUsageRequest.Builder> getSnowballUsageRequest)
Returns information about the Snow Family service limit for your account, and also the number of Snow devices
your account has in use.
|
default GetSnowballUsageResponse |
getSnowballUsage(GetSnowballUsageRequest getSnowballUsageRequest)
Returns information about the Snow Family service limit for your account, and also the number of Snow devices
your account has in use.
|
default GetSoftwareUpdatesResponse |
getSoftwareUpdates(Consumer<GetSoftwareUpdatesRequest.Builder> getSoftwareUpdatesRequest)
Returns an Amazon S3 presigned URL for an update file associated with a specified
JobId. |
default GetSoftwareUpdatesResponse |
getSoftwareUpdates(GetSoftwareUpdatesRequest getSoftwareUpdatesRequest)
Returns an Amazon S3 presigned URL for an update file associated with a specified
JobId. |
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 ListClusterJobsIterable |
listClusterJobsPaginator(Consumer<ListClusterJobsRequest.Builder> listClusterJobsRequest)
Returns an array of
JobListEntry objects of the specified length. |
default ListClusterJobsIterable |
listClusterJobsPaginator(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 ListClustersIterable |
listClustersPaginator()
Returns an array of
ClusterListEntry objects of the specified length. |
default ListClustersIterable |
listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest)
Returns an array of
ClusterListEntry objects of the specified length. |
default ListClustersIterable |
listClustersPaginator(ListClustersRequest listClustersRequest)
Returns an array of
ClusterListEntry objects of the specified length. |
default ListCompatibleImagesResponse |
listCompatibleImages()
This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your Amazon
Web Services accountthat would be supported for use on a Snow device.
|
default ListCompatibleImagesResponse |
listCompatibleImages(Consumer<ListCompatibleImagesRequest.Builder> listCompatibleImagesRequest)
This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your Amazon
Web Services accountthat would be supported for use on a Snow device.
|
default ListCompatibleImagesResponse |
listCompatibleImages(ListCompatibleImagesRequest listCompatibleImagesRequest)
This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your Amazon
Web Services accountthat would be supported for use on a Snow device.
|
default ListCompatibleImagesIterable |
listCompatibleImagesPaginator()
This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your Amazon
Web Services accountthat would be supported for use on a Snow device.
|
default ListCompatibleImagesIterable |
listCompatibleImagesPaginator(Consumer<ListCompatibleImagesRequest.Builder> listCompatibleImagesRequest)
This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your Amazon
Web Services accountthat would be supported for use on a Snow device.
|
default ListCompatibleImagesIterable |
listCompatibleImagesPaginator(ListCompatibleImagesRequest listCompatibleImagesRequest)
This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your Amazon
Web Services accountthat would be supported for use on a Snow device.
|
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. |
default ListLongTermPricingResponse |
listLongTermPricing(Consumer<ListLongTermPricingRequest.Builder> listLongTermPricingRequest)
Lists all long-term pricing types.
|
default ListLongTermPricingResponse |
listLongTermPricing(ListLongTermPricingRequest listLongTermPricingRequest)
Lists all long-term pricing types.
|
default ListLongTermPricingIterable |
listLongTermPricingPaginator(Consumer<ListLongTermPricingRequest.Builder> listLongTermPricingRequest)
Lists all long-term pricing types.
|
default ListLongTermPricingIterable |
listLongTermPricingPaginator(ListLongTermPricingRequest listLongTermPricingRequest)
Lists all long-term pricing types.
|
default ListServiceVersionsResponse |
listServiceVersions(Consumer<ListServiceVersionsRequest.Builder> listServiceVersionsRequest)
Lists all supported versions for Snow on-device services.
|
default ListServiceVersionsResponse |
listServiceVersions(ListServiceVersionsRequest listServiceVersionsRequest)
Lists all supported versions for Snow on-device services.
|
default SnowballServiceClientConfiguration |
serviceClientConfiguration() |
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. |
default UpdateJobShipmentStateResponse |
updateJobShipmentState(Consumer<UpdateJobShipmentStateRequest.Builder> updateJobShipmentStateRequest)
Updates the state when a shipment state changes to a different state.
|
default UpdateJobShipmentStateResponse |
updateJobShipmentState(UpdateJobShipmentStateRequest updateJobShipmentStateRequest)
Updates the state when a shipment state changes to a different state.
|
default UpdateLongTermPricingResponse |
updateLongTermPricing(Consumer<UpdateLongTermPricingRequest.Builder> updateLongTermPricingRequest)
Updates the long-term pricing type.
|
default UpdateLongTermPricingResponse |
updateLongTermPricing(UpdateLongTermPricingRequest updateLongTermPricingRequest)
Updates the long-term pricing type.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.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 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.AwsServiceExceptiondefault 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 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.AwsServiceExceptiondefault 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 returns
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 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.AwsServiceExceptiondefault 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 returns
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 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.AwsServiceExceptiondefault CreateAddressResponse createAddress(CreateAddressRequest createAddressRequest) throws InvalidAddressException, UnsupportedAddressException, AwsServiceException, SdkClientException, SnowballException
Creates an address for a Snow device to be shipped to. In most regions, addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown.
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 Amazon Web Services
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.AwsServiceExceptiondefault CreateAddressResponse createAddress(Consumer<CreateAddressRequest.Builder> createAddressRequest) throws InvalidAddressException, UnsupportedAddressException, AwsServiceException, SdkClientException, SnowballException
Creates an address for a Snow device to be shipped to. In most regions, addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown.
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 Amazon Web Services
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.AwsServiceExceptiondefault CreateClusterResponse createCluster(CreateClusterRequest createClusterRequest) throws InvalidResourceException, KmsRequestFailedException, InvalidInputCombinationException, Ec2RequestFailedException, 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 Key Management Service key lacks the permissions to perform the specified CreateJob
or UpdateJob action.InvalidInputCombinationException - Job or cluster creation failed. One or more inputs were invalid. Confirm that the
CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and
try again.Ec2RequestFailedException - Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.AwsServiceExceptiondefault CreateClusterResponse createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest) throws InvalidResourceException, KmsRequestFailedException, InvalidInputCombinationException, Ec2RequestFailedException, 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 Key Management Service key lacks the permissions to perform the specified CreateJob
or UpdateJob action.InvalidInputCombinationException - Job or cluster creation failed. One or more inputs were invalid. Confirm that the
CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and
try again.Ec2RequestFailedException - Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.AwsServiceExceptiondefault CreateJobResponse createJob(CreateJobRequest createJobRequest) throws InvalidResourceException, KmsRequestFailedException, InvalidInputCombinationException, ClusterLimitExceededException, Ec2RequestFailedException, AwsServiceException, SdkClientException, SnowballException
Creates a job to import or export data between Amazon S3 and your on-premises data center. Your Amazon Web
Services account must have the right trust policies and permissions in place to create a job for a Snow device.
If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the
other job attributes are inherited from the cluster.
Only the Snowball; Edge device type is supported when ordering clustered jobs.
The device capacity is optional.
Availability of device types differ by Amazon Web Services Region. For more information about Region availability, see Amazon Web Services Regional Services.
Snow Family devices and their capacities.
Device type: SNC1_SSD
Capacity: T14
Description: Snowcone
Device type: SNC1_HDD
Capacity: T8
Description: Snowcone
Device type: EDGE_S
Capacity: T98
Description: Snowball Edge Storage Optimized for data transfer only
Device type: EDGE_CG
Capacity: T42
Description: Snowball Edge Compute Optimized with GPU
Device type: EDGE_C
Capacity: T42
Description: Snowball Edge Compute Optimized without GPU
Device type: EDGE
Capacity: T100
Description: Snowball Edge Storage Optimized with EC2 Compute
Device type: STANDARD
Capacity: T50
Description: Original Snowball device
This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region
Device type: STANDARD
Capacity: T80
Description: Original Snowball device
This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region.
Device type: V3_5C
Capacity: T32
Description: Snowball Edge Compute Optimized without GPU
Device type: V3_5S
Capacity: T240
Description: Snowball Edge Storage Optimized 210TB
createJobRequest - InvalidResourceException - The specified resource can't be found. Check the information you provided in your last request, and try
again.KmsRequestFailedException - The provided Key Management Service key lacks the permissions to perform the specified CreateJob
or UpdateJob action.InvalidInputCombinationException - Job or cluster creation failed. One or 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 fewer than five nodes for your
cluster and you have more nodes to create for this cluster, try again and create jobs until your cluster
has exactly five nodes.Ec2RequestFailedException - Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.AwsServiceExceptiondefault CreateJobResponse createJob(Consumer<CreateJobRequest.Builder> createJobRequest) throws InvalidResourceException, KmsRequestFailedException, InvalidInputCombinationException, ClusterLimitExceededException, Ec2RequestFailedException, AwsServiceException, SdkClientException, SnowballException
Creates a job to import or export data between Amazon S3 and your on-premises data center. Your Amazon Web
Services account must have the right trust policies and permissions in place to create a job for a Snow device.
If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the
other job attributes are inherited from the cluster.
Only the Snowball; Edge device type is supported when ordering clustered jobs.
The device capacity is optional.
Availability of device types differ by Amazon Web Services Region. For more information about Region availability, see Amazon Web Services Regional Services.
Snow Family devices and their capacities.
Device type: SNC1_SSD
Capacity: T14
Description: Snowcone
Device type: SNC1_HDD
Capacity: T8
Description: Snowcone
Device type: EDGE_S
Capacity: T98
Description: Snowball Edge Storage Optimized for data transfer only
Device type: EDGE_CG
Capacity: T42
Description: Snowball Edge Compute Optimized with GPU
Device type: EDGE_C
Capacity: T42
Description: Snowball Edge Compute Optimized without GPU
Device type: EDGE
Capacity: T100
Description: Snowball Edge Storage Optimized with EC2 Compute
Device type: STANDARD
Capacity: T50
Description: Original Snowball device
This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region
Device type: STANDARD
Capacity: T80
Description: Original Snowball device
This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region.
Device type: V3_5C
Capacity: T32
Description: Snowball Edge Compute Optimized without GPU
Device type: V3_5S
Capacity: T240
Description: Snowball Edge Storage Optimized 210TB
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 Key Management Service key lacks the permissions to perform the specified CreateJob
or UpdateJob action.InvalidInputCombinationException - Job or cluster creation failed. One or 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 fewer than five nodes for your
cluster and you have more nodes to create for this cluster, try again and create jobs until your cluster
has exactly five nodes.Ec2RequestFailedException - Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.AwsServiceExceptiondefault CreateLongTermPricingResponse createLongTermPricing(CreateLongTermPricingRequest createLongTermPricingRequest) throws InvalidResourceException, AwsServiceException, SdkClientException, SnowballException
Creates a job with the long-term usage option for a device. The long-term usage is a 1-year or 3-year long-term pricing type for the device. You are billed upfront, and Amazon Web Services provides discounts for long-term pricing.
createLongTermPricingRequest - 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.AwsServiceExceptiondefault CreateLongTermPricingResponse createLongTermPricing(Consumer<CreateLongTermPricingRequest.Builder> createLongTermPricingRequest) throws InvalidResourceException, AwsServiceException, SdkClientException, SnowballException
Creates a job with the long-term usage option for a device. The long-term usage is a 1-year or 3-year long-term pricing type for the device. You are billed upfront, and Amazon Web Services provides discounts for long-term pricing.
This is a convenience which creates an instance of the CreateLongTermPricingRequest.Builder avoiding the
need to create one manually via CreateLongTermPricingRequest.builder()
createLongTermPricingRequest - A Consumer that will call methods on CreateLongTermPricingRequest.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.AwsServiceExceptiondefault CreateReturnShippingLabelResponse createReturnShippingLabel(CreateReturnShippingLabelRequest createReturnShippingLabelRequest) throws InvalidResourceException, InvalidJobStateException, InvalidInputCombinationException, ConflictException, ReturnShippingLabelAlreadyExistsException, AwsServiceException, SdkClientException, SnowballException
Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
createReturnShippingLabelRequest - 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.InvalidInputCombinationException - Job or cluster creation failed. One or more inputs were invalid. Confirm that the
CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and
try again.ConflictException - You get this exception when you call CreateReturnShippingLabel more than once when other
requests are not completed.ReturnShippingLabelAlreadyExistsException - You get this exception if you call CreateReturnShippingLabel and a valid return shipping
label already exists. In this case, use DescribeReturnShippingLabel to get the URL.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.AwsServiceExceptiondefault CreateReturnShippingLabelResponse createReturnShippingLabel(Consumer<CreateReturnShippingLabelRequest.Builder> createReturnShippingLabelRequest) throws InvalidResourceException, InvalidJobStateException, InvalidInputCombinationException, ConflictException, ReturnShippingLabelAlreadyExistsException, AwsServiceException, SdkClientException, SnowballException
Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
This is a convenience which creates an instance of the CreateReturnShippingLabelRequest.Builder avoiding
the need to create one manually via CreateReturnShippingLabelRequest.builder()
createReturnShippingLabelRequest - A Consumer that will call methods on CreateReturnShippingLabelRequest.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.InvalidInputCombinationException - Job or cluster creation failed. One or more inputs were invalid. Confirm that the
CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and
try again.ConflictException - You get this exception when you call CreateReturnShippingLabel more than once when other
requests are not completed.ReturnShippingLabelAlreadyExistsException - You get this exception if you call CreateReturnShippingLabel and a valid return shipping
label already exists. In this case, use DescribeReturnShippingLabel to get the URL.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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondescribeAddresses(DescribeAddressesRequest),
AWS
API Documentationdefault 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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.AwsServiceExceptiondescribeAddressesPaginator(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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.AwsServiceExceptiondefault 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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault DescribeReturnShippingLabelResponse describeReturnShippingLabel(DescribeReturnShippingLabelRequest describeReturnShippingLabelRequest) throws InvalidResourceException, InvalidJobStateException, ConflictException, AwsServiceException, SdkClientException, SnowballException
Information on the shipping label of a Snow device that is being returned to Amazon Web Services.
describeReturnShippingLabelRequest - 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.ConflictException - You get this exception when you call CreateReturnShippingLabel more than once when other
requests are not completed.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.AwsServiceExceptiondefault DescribeReturnShippingLabelResponse describeReturnShippingLabel(Consumer<DescribeReturnShippingLabelRequest.Builder> describeReturnShippingLabelRequest) throws InvalidResourceException, InvalidJobStateException, ConflictException, AwsServiceException, SdkClientException, SnowballException
Information on the shipping label of a Snow device that is being returned to Amazon Web Services.
This is a convenience which creates an instance of the DescribeReturnShippingLabelRequest.Builder
avoiding the need to create one manually via DescribeReturnShippingLabelRequest.builder()
describeReturnShippingLabelRequest - A Consumer that will call methods on DescribeReturnShippingLabelRequest.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.ConflictException - You get this exception when you call CreateReturnShippingLabel more than once when other
requests are not completed.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.AwsServiceExceptiondefault 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. This is the only valid status for calling this API as the manifest and UnlockCode code value
are used for securing your device and should only be used when you have the device. The manifest is decrypted by
using the UnlockCode code value, when you pass both values to the Snow device through the Snowball
client when the client is started for the first time.
As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same
location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from
gaining access to the Snow device associated with that job.
The credentials of a given job, including its manifest file and unlock code, expire 360 days after the job is created.
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.AwsServiceExceptiondefault 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. This is the only valid status for calling this API as the manifest and UnlockCode code value
are used for securing your device and should only be used when you have the device. The manifest is decrypted by
using the UnlockCode code value, when you pass both values to the Snow device through the Snowball
client when the client is started for the first time.
As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same
location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from
gaining access to the Snow device associated with that job.
The credentials of a given job, including its manifest file and unlock code, expire 360 days after the job is created.
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.AwsServiceExceptiondefault 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 360 days after the associated job has been created.
The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code
is used to decrypt the manifest file when it is passed along with the manifest to the Snow device through the
Snowball client when the client is started for the first time. The only valid status for calling this API is
WithCustomer as the manifest and Unlock code values are used for securing your device
and should only be used when you have the device.
As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location
as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access
to the Snow device associated with that job.
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.AwsServiceExceptiondefault 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 360 days after the associated job has been created.
The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code
is used to decrypt the manifest file when it is passed along with the manifest to the Snow device through the
Snowball client when the client is started for the first time. The only valid status for calling this API is
WithCustomer as the manifest and Unlock code values are used for securing your device
and should only be used when you have the device.
As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location
as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access
to the Snow device associated with that job.
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.AwsServiceExceptiondefault GetSnowballUsageResponse getSnowballUsage(GetSnowballUsageRequest getSnowballUsageRequest) throws AwsServiceException, SdkClientException, SnowballException
Returns information about the Snow Family service limit for your account, and also the number of Snow devices your account has in use.
The default service limit for the number of Snow devices that you can have at one time is 1. If you want to increase your service limit, contact Amazon Web Services Support.
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.AwsServiceExceptiondefault GetSnowballUsageResponse getSnowballUsage(Consumer<GetSnowballUsageRequest.Builder> getSnowballUsageRequest) throws AwsServiceException, SdkClientException, SnowballException
Returns information about the Snow Family service limit for your account, and also the number of Snow devices your account has in use.
The default service limit for the number of Snow devices that you can have at one time is 1. If you want to increase your service limit, contact Amazon Web Services Support.
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.AwsServiceExceptiondefault GetSnowballUsageResponse getSnowballUsage() throws AwsServiceException, SdkClientException, SnowballException
Returns information about the Snow Family service limit for your account, and also the number of Snow devices your account has in use.
The default service limit for the number of Snow devices that you can have at one time is 1. If you want to increase your service limit, contact Amazon Web Services Support.
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.AwsServiceExceptiongetSnowballUsage(GetSnowballUsageRequest),
AWS API
Documentationdefault GetSoftwareUpdatesResponse getSoftwareUpdates(GetSoftwareUpdatesRequest getSoftwareUpdatesRequest) throws InvalidResourceException, InvalidJobStateException, AwsServiceException, SdkClientException, SnowballException
Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.
getSoftwareUpdatesRequest - 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.AwsServiceExceptiondefault GetSoftwareUpdatesResponse getSoftwareUpdates(Consumer<GetSoftwareUpdatesRequest.Builder> getSoftwareUpdatesRequest) throws InvalidResourceException, InvalidJobStateException, AwsServiceException, SdkClientException, SnowballException
Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.
This is a convenience which creates an instance of the GetSoftwareUpdatesRequest.Builder avoiding the
need to create one manually via GetSoftwareUpdatesRequest.builder()
getSoftwareUpdatesRequest - A Consumer that will call methods on GetSoftwareUpdatesRequest.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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault ListClusterJobsIterable listClusterJobsPaginator(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.
This is a variant of
listClusterJobs(software.amazon.awssdk.services.snowball.model.ListClusterJobsRequest) 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.ListClusterJobsIterable responses = client.listClusterJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.snowball.paginators.ListClusterJobsIterable responses = client
.listClusterJobsPaginator(request);
for (software.amazon.awssdk.services.snowball.model.ListClusterJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.snowball.paginators.ListClusterJobsIterable responses = client.listClusterJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listClusterJobs(software.amazon.awssdk.services.snowball.model.ListClusterJobsRequest) operation.
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.AwsServiceExceptiondefault ListClusterJobsIterable listClusterJobsPaginator(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 variant of
listClusterJobs(software.amazon.awssdk.services.snowball.model.ListClusterJobsRequest) 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.ListClusterJobsIterable responses = client.listClusterJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.snowball.paginators.ListClusterJobsIterable responses = client
.listClusterJobsPaginator(request);
for (software.amazon.awssdk.services.snowball.model.ListClusterJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.snowball.paginators.ListClusterJobsIterable responses = client.listClusterJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listClusterJobs(software.amazon.awssdk.services.snowball.model.ListClusterJobsRequest) operation.
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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptionlistClusters(ListClustersRequest),
AWS API
Documentationdefault ListClustersIterable listClustersPaginator() 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 variant of listClusters(software.amazon.awssdk.services.snowball.model.ListClustersRequest)
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.ListClustersIterable responses = client.listClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.snowball.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
for (software.amazon.awssdk.services.snowball.model.ListClustersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.snowball.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listClusters(software.amazon.awssdk.services.snowball.model.ListClustersRequest) 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.AwsServiceExceptionlistClustersPaginator(ListClustersRequest),
AWS API
Documentationdefault ListClustersIterable listClustersPaginator(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.
This is a variant of listClusters(software.amazon.awssdk.services.snowball.model.ListClustersRequest)
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.ListClustersIterable responses = client.listClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.snowball.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
for (software.amazon.awssdk.services.snowball.model.ListClustersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.snowball.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listClusters(software.amazon.awssdk.services.snowball.model.ListClustersRequest) operation.
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.AwsServiceExceptiondefault ListClustersIterable listClustersPaginator(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 variant of listClusters(software.amazon.awssdk.services.snowball.model.ListClustersRequest)
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.ListClustersIterable responses = client.listClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.snowball.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
for (software.amazon.awssdk.services.snowball.model.ListClustersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.snowball.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listClusters(software.amazon.awssdk.services.snowball.model.ListClustersRequest) operation.
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.AwsServiceExceptiondefault ListCompatibleImagesResponse listCompatibleImages(ListCompatibleImagesRequest listCompatibleImagesRequest) throws InvalidNextTokenException, Ec2RequestFailedException, AwsServiceException, SdkClientException, SnowballException
This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VM Import/Export and running locally in AMIs.
listCompatibleImagesRequest - InvalidNextTokenException - The NextToken string was altered unexpectedly, and the operation has stopped. Run the
operation without changing the NextToken string, and try again.Ec2RequestFailedException - Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.AwsServiceExceptiondefault ListCompatibleImagesResponse listCompatibleImages(Consumer<ListCompatibleImagesRequest.Builder> listCompatibleImagesRequest) throws InvalidNextTokenException, Ec2RequestFailedException, AwsServiceException, SdkClientException, SnowballException
This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VM Import/Export and running locally in AMIs.
This is a convenience which creates an instance of the ListCompatibleImagesRequest.Builder avoiding the
need to create one manually via ListCompatibleImagesRequest.builder()
listCompatibleImagesRequest - A Consumer that will call methods on ListCompatibleImagesRequest.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.Ec2RequestFailedException - Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.AwsServiceExceptiondefault ListCompatibleImagesResponse listCompatibleImages() throws InvalidNextTokenException, Ec2RequestFailedException, AwsServiceException, SdkClientException, SnowballException
This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VM Import/Export and running locally in AMIs.
InvalidNextTokenException - The NextToken string was altered unexpectedly, and the operation has stopped. Run the
operation without changing the NextToken string, and try again.Ec2RequestFailedException - Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.AwsServiceExceptionlistCompatibleImages(ListCompatibleImagesRequest),
AWS
API Documentationdefault ListCompatibleImagesIterable listCompatibleImagesPaginator() throws InvalidNextTokenException, Ec2RequestFailedException, AwsServiceException, SdkClientException, SnowballException
This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VM Import/Export and running locally in AMIs.
This is a variant of
listCompatibleImages(software.amazon.awssdk.services.snowball.model.ListCompatibleImagesRequest)
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.ListCompatibleImagesIterable responses = client.listCompatibleImagesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.snowball.paginators.ListCompatibleImagesIterable responses = client
.listCompatibleImagesPaginator(request);
for (software.amazon.awssdk.services.snowball.model.ListCompatibleImagesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.snowball.paginators.ListCompatibleImagesIterable responses = client.listCompatibleImagesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCompatibleImages(software.amazon.awssdk.services.snowball.model.ListCompatibleImagesRequest)
operation.
InvalidNextTokenException - The NextToken string was altered unexpectedly, and the operation has stopped. Run the
operation without changing the NextToken string, and try again.Ec2RequestFailedException - Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.AwsServiceExceptionlistCompatibleImagesPaginator(ListCompatibleImagesRequest),
AWS
API Documentationdefault ListCompatibleImagesIterable listCompatibleImagesPaginator(ListCompatibleImagesRequest listCompatibleImagesRequest) throws InvalidNextTokenException, Ec2RequestFailedException, AwsServiceException, SdkClientException, SnowballException
This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VM Import/Export and running locally in AMIs.
This is a variant of
listCompatibleImages(software.amazon.awssdk.services.snowball.model.ListCompatibleImagesRequest)
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.ListCompatibleImagesIterable responses = client.listCompatibleImagesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.snowball.paginators.ListCompatibleImagesIterable responses = client
.listCompatibleImagesPaginator(request);
for (software.amazon.awssdk.services.snowball.model.ListCompatibleImagesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.snowball.paginators.ListCompatibleImagesIterable responses = client.listCompatibleImagesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCompatibleImages(software.amazon.awssdk.services.snowball.model.ListCompatibleImagesRequest)
operation.
listCompatibleImagesRequest - InvalidNextTokenException - The NextToken string was altered unexpectedly, and the operation has stopped. Run the
operation without changing the NextToken string, and try again.Ec2RequestFailedException - Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.AwsServiceExceptiondefault ListCompatibleImagesIterable listCompatibleImagesPaginator(Consumer<ListCompatibleImagesRequest.Builder> listCompatibleImagesRequest) throws InvalidNextTokenException, Ec2RequestFailedException, AwsServiceException, SdkClientException, SnowballException
This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VM Import/Export and running locally in AMIs.
This is a variant of
listCompatibleImages(software.amazon.awssdk.services.snowball.model.ListCompatibleImagesRequest)
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.ListCompatibleImagesIterable responses = client.listCompatibleImagesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.snowball.paginators.ListCompatibleImagesIterable responses = client
.listCompatibleImagesPaginator(request);
for (software.amazon.awssdk.services.snowball.model.ListCompatibleImagesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.snowball.paginators.ListCompatibleImagesIterable responses = client.listCompatibleImagesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCompatibleImages(software.amazon.awssdk.services.snowball.model.ListCompatibleImagesRequest)
operation.
This is a convenience which creates an instance of the ListCompatibleImagesRequest.Builder avoiding the
need to create one manually via ListCompatibleImagesRequest.builder()
listCompatibleImagesRequest - A Consumer that will call methods on ListCompatibleImagesRequest.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.Ec2RequestFailedException - Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptiondefault 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.AwsServiceExceptionlistJobs(ListJobsRequest),
AWS API
Documentationdefault 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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.AwsServiceExceptionlistJobsPaginator(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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.AwsServiceExceptiondefault 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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.AwsServiceExceptiondefault ListLongTermPricingResponse listLongTermPricing(ListLongTermPricingRequest listLongTermPricingRequest) throws InvalidResourceException, InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException
Lists all long-term pricing types.
listLongTermPricingRequest - 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.AwsServiceExceptiondefault ListLongTermPricingResponse listLongTermPricing(Consumer<ListLongTermPricingRequest.Builder> listLongTermPricingRequest) throws InvalidResourceException, InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException
Lists all long-term pricing types.
This is a convenience which creates an instance of the ListLongTermPricingRequest.Builder avoiding the
need to create one manually via ListLongTermPricingRequest.builder()
listLongTermPricingRequest - A Consumer that will call methods on ListLongTermPricingRequest.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.AwsServiceExceptiondefault ListLongTermPricingIterable listLongTermPricingPaginator(ListLongTermPricingRequest listLongTermPricingRequest) throws InvalidResourceException, InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException
Lists all long-term pricing types.
This is a variant of
listLongTermPricing(software.amazon.awssdk.services.snowball.model.ListLongTermPricingRequest)
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.ListLongTermPricingIterable responses = client.listLongTermPricingPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.snowball.paginators.ListLongTermPricingIterable responses = client
.listLongTermPricingPaginator(request);
for (software.amazon.awssdk.services.snowball.model.ListLongTermPricingResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.snowball.paginators.ListLongTermPricingIterable responses = client.listLongTermPricingPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLongTermPricing(software.amazon.awssdk.services.snowball.model.ListLongTermPricingRequest)
operation.
listLongTermPricingRequest - 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.AwsServiceExceptiondefault ListLongTermPricingIterable listLongTermPricingPaginator(Consumer<ListLongTermPricingRequest.Builder> listLongTermPricingRequest) throws InvalidResourceException, InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException
Lists all long-term pricing types.
This is a variant of
listLongTermPricing(software.amazon.awssdk.services.snowball.model.ListLongTermPricingRequest)
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.ListLongTermPricingIterable responses = client.listLongTermPricingPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.snowball.paginators.ListLongTermPricingIterable responses = client
.listLongTermPricingPaginator(request);
for (software.amazon.awssdk.services.snowball.model.ListLongTermPricingResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.snowball.paginators.ListLongTermPricingIterable responses = client.listLongTermPricingPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLongTermPricing(software.amazon.awssdk.services.snowball.model.ListLongTermPricingRequest)
operation.
This is a convenience which creates an instance of the ListLongTermPricingRequest.Builder avoiding the
need to create one manually via ListLongTermPricingRequest.builder()
listLongTermPricingRequest - A Consumer that will call methods on ListLongTermPricingRequest.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.AwsServiceExceptiondefault ListServiceVersionsResponse listServiceVersions(ListServiceVersionsRequest listServiceVersionsRequest) throws InvalidNextTokenException, InvalidResourceException, AwsServiceException, SdkClientException, SnowballException
Lists all supported versions for Snow on-device services. Returns an array of ServiceVersion object
containing the supported versions for a particular service.
listServiceVersionsRequest - InvalidNextTokenException - The NextToken string was altered unexpectedly, and the operation has stopped. Run the
operation without changing the NextToken string, and try again.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.AwsServiceExceptiondefault ListServiceVersionsResponse listServiceVersions(Consumer<ListServiceVersionsRequest.Builder> listServiceVersionsRequest) throws InvalidNextTokenException, InvalidResourceException, AwsServiceException, SdkClientException, SnowballException
Lists all supported versions for Snow on-device services. Returns an array of ServiceVersion object
containing the supported versions for a particular service.
This is a convenience which creates an instance of the ListServiceVersionsRequest.Builder avoiding the
need to create one manually via ListServiceVersionsRequest.builder()
listServiceVersionsRequest - A Consumer that will call methods on ListServiceVersionsRequest.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.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.AwsServiceExceptiondefault UpdateClusterResponse updateCluster(UpdateClusterRequest updateClusterRequest) throws InvalidResourceException, InvalidJobStateException, KmsRequestFailedException, InvalidInputCombinationException, Ec2RequestFailedException, 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 Key Management Service key lacks the permissions to perform the specified CreateJob
or UpdateJob action.InvalidInputCombinationException - Job or cluster creation failed. One or more inputs were invalid. Confirm that the
CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and
try again.Ec2RequestFailedException - Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.AwsServiceExceptiondefault UpdateClusterResponse updateCluster(Consumer<UpdateClusterRequest.Builder> updateClusterRequest) throws InvalidResourceException, InvalidJobStateException, KmsRequestFailedException, InvalidInputCombinationException, Ec2RequestFailedException, 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 Key Management Service key lacks the permissions to perform the specified CreateJob
or UpdateJob action.InvalidInputCombinationException - Job or cluster creation failed. One or more inputs were invalid. Confirm that the
CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and
try again.Ec2RequestFailedException - Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.AwsServiceExceptiondefault UpdateJobResponse updateJob(UpdateJobRequest updateJobRequest) throws InvalidResourceException, InvalidJobStateException, KmsRequestFailedException, InvalidInputCombinationException, ClusterLimitExceededException, Ec2RequestFailedException, 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 Key Management Service key lacks the permissions to perform the specified CreateJob
or UpdateJob action.InvalidInputCombinationException - Job or cluster creation failed. One or 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 fewer than five nodes for your
cluster and you have more nodes to create for this cluster, try again and create jobs until your cluster
has exactly five nodes.Ec2RequestFailedException - Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.AwsServiceExceptiondefault UpdateJobResponse updateJob(Consumer<UpdateJobRequest.Builder> updateJobRequest) throws InvalidResourceException, InvalidJobStateException, KmsRequestFailedException, InvalidInputCombinationException, ClusterLimitExceededException, Ec2RequestFailedException, 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 Key Management Service key lacks the permissions to perform the specified CreateJob
or UpdateJob action.InvalidInputCombinationException - Job or cluster creation failed. One or 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 fewer than five nodes for your
cluster and you have more nodes to create for this cluster, try again and create jobs until your cluster
has exactly five nodes.Ec2RequestFailedException - Your user lacks the necessary Amazon EC2 permissions to perform the attempted 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.AwsServiceExceptiondefault UpdateJobShipmentStateResponse updateJobShipmentState(UpdateJobShipmentStateRequest updateJobShipmentStateRequest) throws InvalidResourceException, InvalidJobStateException, AwsServiceException, SdkClientException, SnowballException
Updates the state when a shipment state changes to a different state.
updateJobShipmentStateRequest - 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.AwsServiceExceptiondefault UpdateJobShipmentStateResponse updateJobShipmentState(Consumer<UpdateJobShipmentStateRequest.Builder> updateJobShipmentStateRequest) throws InvalidResourceException, InvalidJobStateException, AwsServiceException, SdkClientException, SnowballException
Updates the state when a shipment state changes to a different state.
This is a convenience which creates an instance of the UpdateJobShipmentStateRequest.Builder avoiding the
need to create one manually via UpdateJobShipmentStateRequest.builder()
updateJobShipmentStateRequest - A Consumer that will call methods on UpdateJobShipmentStateRequest.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.AwsServiceExceptiondefault UpdateLongTermPricingResponse updateLongTermPricing(UpdateLongTermPricingRequest updateLongTermPricingRequest) throws InvalidResourceException, AwsServiceException, SdkClientException, SnowballException
Updates the long-term pricing type.
updateLongTermPricingRequest - 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.AwsServiceExceptiondefault UpdateLongTermPricingResponse updateLongTermPricing(Consumer<UpdateLongTermPricingRequest.Builder> updateLongTermPricingRequest) throws InvalidResourceException, AwsServiceException, SdkClientException, SnowballException
Updates the long-term pricing type.
This is a convenience which creates an instance of the UpdateLongTermPricingRequest.Builder avoiding the
need to create one manually via UpdateLongTermPricingRequest.builder()
updateLongTermPricingRequest - A Consumer that will call methods on UpdateLongTermPricingRequest.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.AwsServiceExceptionstatic SnowballClient create()
SnowballClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static SnowballClientBuilder builder()
SnowballClient.static ServiceMetadata serviceMetadata()
default SnowballServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.