Interface SnowballClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic SnowballClientBuilder
builder()
Create a builder that can be used to configure and create aSnowballClient
.default CancelClusterResponse
cancelCluster
(Consumer<CancelClusterRequest.Builder> cancelClusterRequest) Cancels a cluster job.default CancelClusterResponse
cancelCluster
(CancelClusterRequest cancelClusterRequest) Cancels a cluster job.default CancelJobResponse
cancelJob
(Consumer<CancelJobRequest.Builder> cancelJobRequest) Cancels the specified job.default CancelJobResponse
cancelJob
(CancelJobRequest cancelJobRequest) Cancels the specified job.static SnowballClient
create()
Create aSnowballClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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.createReturnShippingLabel
(Consumer<CreateReturnShippingLabelRequest.Builder> createReturnShippingLabelRequest) Creates a shipping label that will be used to return the Snow device to Amazon Web Services.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 anAddressId
and returns specific details about that address in the form of anAddress
object.default DescribeAddressResponse
describeAddress
(DescribeAddressRequest describeAddressRequest) Takes anAddressId
and returns specific details about that address in the form of anAddress
object.default DescribeAddressesResponse
Returns a specified number ofADDRESS
objects.default DescribeAddressesResponse
describeAddresses
(Consumer<DescribeAddressesRequest.Builder> describeAddressesRequest) Returns a specified number ofADDRESS
objects.default DescribeAddressesResponse
describeAddresses
(DescribeAddressesRequest describeAddressesRequest) Returns a specified number ofADDRESS
objects.default DescribeAddressesIterable
This is a variant ofdescribeAddresses(software.amazon.awssdk.services.snowball.model.DescribeAddressesRequest)
operation.default DescribeAddressesIterable
describeAddressesPaginator
(Consumer<DescribeAddressesRequest.Builder> describeAddressesRequest) This is a variant ofdescribeAddresses(software.amazon.awssdk.services.snowball.model.DescribeAddressesRequest)
operation.default DescribeAddressesIterable
describeAddressesPaginator
(DescribeAddressesRequest describeAddressesRequest) This is a variant ofdescribeAddresses(software.amazon.awssdk.services.snowball.model.DescribeAddressesRequest)
operation.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.describeReturnShippingLabel
(Consumer<DescribeReturnShippingLabelRequest.Builder> describeReturnShippingLabelRequest) Information on the shipping label of a Snow device that is being returned to Amazon Web Services.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 specifiedJobId
value.default GetJobManifestResponse
getJobManifest
(GetJobManifestRequest getJobManifestRequest) Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specifiedJobId
value.default GetJobUnlockCodeResponse
getJobUnlockCode
(Consumer<GetJobUnlockCodeRequest.Builder> getJobUnlockCodeRequest) Returns theUnlockCode
code value for the specified job.default GetJobUnlockCodeResponse
getJobUnlockCode
(GetJobUnlockCodeRequest getJobUnlockCodeRequest) Returns theUnlockCode
code value for the specified job.default GetSnowballUsageResponse
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 specifiedJobId
.default GetSoftwareUpdatesResponse
getSoftwareUpdates
(GetSoftwareUpdatesRequest getSoftwareUpdatesRequest) Returns an Amazon S3 presigned URL for an update file associated with a specifiedJobId
.default ListClusterJobsResponse
listClusterJobs
(Consumer<ListClusterJobsRequest.Builder> listClusterJobsRequest) Returns an array ofJobListEntry
objects of the specified length.default ListClusterJobsResponse
listClusterJobs
(ListClusterJobsRequest listClusterJobsRequest) Returns an array ofJobListEntry
objects of the specified length.default ListClusterJobsIterable
listClusterJobsPaginator
(Consumer<ListClusterJobsRequest.Builder> listClusterJobsRequest) This is a variant oflistClusterJobs(software.amazon.awssdk.services.snowball.model.ListClusterJobsRequest)
operation.default ListClusterJobsIterable
listClusterJobsPaginator
(ListClusterJobsRequest listClusterJobsRequest) This is a variant oflistClusterJobs(software.amazon.awssdk.services.snowball.model.ListClusterJobsRequest)
operation.default ListClustersResponse
Returns an array ofClusterListEntry
objects of the specified length.default ListClustersResponse
listClusters
(Consumer<ListClustersRequest.Builder> listClustersRequest) Returns an array ofClusterListEntry
objects of the specified length.default ListClustersResponse
listClusters
(ListClustersRequest listClustersRequest) Returns an array ofClusterListEntry
objects of the specified length.default ListClustersIterable
This is a variant oflistClusters(software.amazon.awssdk.services.snowball.model.ListClustersRequest)
operation.default ListClustersIterable
listClustersPaginator
(Consumer<ListClustersRequest.Builder> listClustersRequest) This is a variant oflistClusters(software.amazon.awssdk.services.snowball.model.ListClustersRequest)
operation.default ListClustersIterable
listClustersPaginator
(ListClustersRequest listClustersRequest) This is a variant oflistClusters(software.amazon.awssdk.services.snowball.model.ListClustersRequest)
operation.default ListCompatibleImagesResponse
This action returns a list of the different Amazon EC2-compatible Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device.default ListCompatibleImagesResponse
listCompatibleImages
(Consumer<ListCompatibleImagesRequest.Builder> listCompatibleImagesRequest) This action returns a list of the different Amazon EC2-compatible Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device.default ListCompatibleImagesResponse
listCompatibleImages
(ListCompatibleImagesRequest listCompatibleImagesRequest) This action returns a list of the different Amazon EC2-compatible Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device.default ListCompatibleImagesIterable
This is a variant oflistCompatibleImages(software.amazon.awssdk.services.snowball.model.ListCompatibleImagesRequest)
operation.default ListCompatibleImagesIterable
listCompatibleImagesPaginator
(Consumer<ListCompatibleImagesRequest.Builder> listCompatibleImagesRequest) This is a variant oflistCompatibleImages(software.amazon.awssdk.services.snowball.model.ListCompatibleImagesRequest)
operation.default ListCompatibleImagesIterable
listCompatibleImagesPaginator
(ListCompatibleImagesRequest listCompatibleImagesRequest) This is a variant oflistCompatibleImages(software.amazon.awssdk.services.snowball.model.ListCompatibleImagesRequest)
operation.default ListJobsResponse
listJobs()
Returns an array ofJobListEntry
objects of the specified length.default ListJobsResponse
listJobs
(Consumer<ListJobsRequest.Builder> listJobsRequest) Returns an array ofJobListEntry
objects of the specified length.default ListJobsResponse
listJobs
(ListJobsRequest listJobsRequest) Returns an array ofJobListEntry
objects of the specified length.default ListJobsIterable
This is a variant oflistJobs(software.amazon.awssdk.services.snowball.model.ListJobsRequest)
operation.default ListJobsIterable
listJobsPaginator
(Consumer<ListJobsRequest.Builder> listJobsRequest) This is a variant oflistJobs(software.amazon.awssdk.services.snowball.model.ListJobsRequest)
operation.default ListJobsIterable
listJobsPaginator
(ListJobsRequest listJobsRequest) This is a variant oflistJobs(software.amazon.awssdk.services.snowball.model.ListJobsRequest)
operation.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) This is a variant oflistLongTermPricing(software.amazon.awssdk.services.snowball.model.ListLongTermPricingRequest)
operation.default ListLongTermPricingIterable
listLongTermPricingPaginator
(ListLongTermPricingRequest listLongTermPricingRequest) This is a variant oflistLongTermPricing(software.amazon.awssdk.services.snowball.model.ListLongTermPricingRequest)
operation.default ListPickupLocationsResponse
listPickupLocations
(Consumer<ListPickupLocationsRequest.Builder> listPickupLocationsRequest) A list of locations from which the customer can choose to pickup a device.default ListPickupLocationsResponse
listPickupLocations
(ListPickupLocationsRequest listPickupLocationsRequest) A list of locations from which the customer can choose to pickup a device.default ListPickupLocationsIterable
listPickupLocationsPaginator
(Consumer<ListPickupLocationsRequest.Builder> listPickupLocationsRequest) This is a variant oflistPickupLocations(software.amazon.awssdk.services.snowball.model.ListPickupLocationsRequest)
operation.default ListPickupLocationsIterable
listPickupLocationsPaginator
(ListPickupLocationsRequest listPickupLocationsRequest) This is a variant oflistPickupLocations(software.amazon.awssdk.services.snowball.model.ListPickupLocationsRequest)
operation.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.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default UpdateClusterResponse
updateCluster
(Consumer<UpdateClusterRequest.Builder> updateClusterRequest) While a cluster'sClusterState
value is in theAwaitingQuorum
state, you can update some of the information associated with a cluster.default UpdateClusterResponse
updateCluster
(UpdateClusterRequest updateClusterRequest) While a cluster'sClusterState
value is in theAwaitingQuorum
state, you can update some of the information associated with a cluster.default UpdateJobResponse
updateJob
(Consumer<UpdateJobRequest.Builder> updateJobRequest) While a job'sJobState
value isNew
, you can update some of the information associated with a job.default UpdateJobResponse
updateJob
(UpdateJobRequest updateJobRequest) While a job'sJobState
value isNew
, 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.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
cancelCluster
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.- Parameters:
cancelClusterRequest
-- Returns:
- Result of the CancelCluster operation returned by the service.
- See Also:
-
cancelCluster
default CancelClusterResponse cancelCluster(Consumer<CancelClusterRequest.Builder> cancelClusterRequest) throws KmsRequestFailedException, InvalidJobStateException, InvalidResourceException, AwsServiceException, SdkClientException, SnowballException Cancels a cluster job. You can only cancel a cluster job while it's in the
AwaitingQuorum
status. You'll have at least an hour after creating a cluster job to cancel it.
This is a convenience which creates an instance of the
CancelClusterRequest.Builder
avoiding the need to create one manually viaCancelClusterRequest.builder()
- Parameters:
cancelClusterRequest
- AConsumer
that will call methods onCancelClusterRequest.Builder
to create a request.- Returns:
- Result of the CancelCluster operation returned by the service.
- See Also:
-
cancelJob
default CancelJobResponse cancelJob(CancelJobRequest cancelJobRequest) throws InvalidResourceException, InvalidJobStateException, KmsRequestFailedException, AwsServiceException, SdkClientException, SnowballException Cancels the specified job. You can only cancel a job before its
JobState
value changes toPreparingAppliance
. Requesting theListJobs
orDescribeJob
action returns a job'sJobState
as part of the response element data returned.- Parameters:
cancelJobRequest
-- Returns:
- Result of the CancelJob operation returned by the service.
- See Also:
-
cancelJob
default CancelJobResponse cancelJob(Consumer<CancelJobRequest.Builder> cancelJobRequest) throws InvalidResourceException, InvalidJobStateException, KmsRequestFailedException, AwsServiceException, SdkClientException, SnowballException Cancels the specified job. You can only cancel a job before its
JobState
value changes toPreparingAppliance
. Requesting theListJobs
orDescribeJob
action returns a job'sJobState
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 viaCancelJobRequest.builder()
- Parameters:
cancelJobRequest
- AConsumer
that will call methods onCancelJobRequest.Builder
to create a request.- Returns:
- Result of the CancelJob operation returned by the service.
- See Also:
-
createAddress
default 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. If providing an address as a JSON file through the
cli-input-json
option, include the full file path. For example,--cli-input-json file://create-address.json
.- Parameters:
createAddressRequest
-- Returns:
- Result of the CreateAddress operation returned by the service.
- See Also:
-
createAddress
default 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. If providing an address as a JSON file through the
cli-input-json
option, include the full file path. For example,--cli-input-json file://create-address.json
.
This is a convenience which creates an instance of the
CreateAddressRequest.Builder
avoiding the need to create one manually viaCreateAddressRequest.builder()
- Parameters:
createAddressRequest
- AConsumer
that will call methods onCreateAddressRequest.Builder
to create a request.- Returns:
- Result of the CreateAddress operation returned by the service.
- See Also:
-
createCluster
default 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.
- Parameters:
createClusterRequest
-- Returns:
- Result of the CreateCluster operation returned by the service.
- See Also:
-
createCluster
default 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 viaCreateClusterRequest.builder()
- Parameters:
createClusterRequest
- AConsumer
that will call methods onCreateClusterRequest.Builder
to create a request.- Returns:
- Result of the CreateCluster operation returned by the service.
- See Also:
-
createJob
default 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
This device is replaced with T98.
-
-
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.
-
-
Snow Family device type: RACK_5U_C
-
Capacity: T13
-
Description: Snowblade.
-
-
Device type: V3_5S
-
Capacity: T240
-
Description: Snowball Edge Storage Optimized 210TB
-
- Parameters:
createJobRequest
-- Returns:
- Result of the CreateJob operation returned by the service.
- See Also:
-
-
createJob
default 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
This device is replaced with T98.
-
-
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.
-
-
Snow Family device type: RACK_5U_C
-
Capacity: T13
-
Description: Snowblade.
-
-
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 viaCreateJobRequest.builder()
- Parameters:
createJobRequest
- AConsumer
that will call methods onCreateJobRequest.Builder
to create a request.- Returns:
- Result of the CreateJob operation returned by the service.
- See Also:
-
-
createLongTermPricing
default 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.
- Parameters:
createLongTermPricingRequest
-- Returns:
- Result of the CreateLongTermPricing operation returned by the service.
- See Also:
-
createLongTermPricing
default 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 viaCreateLongTermPricingRequest.builder()
- Parameters:
createLongTermPricingRequest
- AConsumer
that will call methods onCreateLongTermPricingRequest.Builder
to create a request.- Returns:
- Result of the CreateLongTermPricing operation returned by the service.
- See Also:
-
createReturnShippingLabel
default 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.
- Parameters:
createReturnShippingLabelRequest
-- Returns:
- Result of the CreateReturnShippingLabel operation returned by the service.
- See Also:
-
createReturnShippingLabel
default 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 viaCreateReturnShippingLabelRequest.builder()
- Parameters:
createReturnShippingLabelRequest
- AConsumer
that will call methods onCreateReturnShippingLabelRequest.Builder
to create a request.- Returns:
- Result of the CreateReturnShippingLabel operation returned by the service.
- See Also:
-
describeAddress
default DescribeAddressResponse describeAddress(DescribeAddressRequest describeAddressRequest) throws InvalidResourceException, AwsServiceException, SdkClientException, SnowballException Takes an
AddressId
and returns specific details about that address in the form of anAddress
object.- Parameters:
describeAddressRequest
-- Returns:
- Result of the DescribeAddress operation returned by the service.
- See Also:
-
describeAddress
default DescribeAddressResponse describeAddress(Consumer<DescribeAddressRequest.Builder> describeAddressRequest) throws InvalidResourceException, AwsServiceException, SdkClientException, SnowballException Takes an
AddressId
and returns specific details about that address in the form of anAddress
object.
This is a convenience which creates an instance of the
DescribeAddressRequest.Builder
avoiding the need to create one manually viaDescribeAddressRequest.builder()
- Parameters:
describeAddressRequest
- AConsumer
that will call methods onDescribeAddressRequest.Builder
to create a request.- Returns:
- Result of the DescribeAddress operation returned by the service.
- See Also:
-
describeAddresses
default 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.- Parameters:
describeAddressesRequest
-- Returns:
- Result of the DescribeAddresses operation returned by the service.
- See Also:
-
describeAddresses
default DescribeAddressesResponse describeAddresses(Consumer<DescribeAddressesRequest.Builder> describeAddressesRequest) throws InvalidResourceException, InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException Returns a specified number of
ADDRESS
objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.
This is a convenience which creates an instance of the
DescribeAddressesRequest.Builder
avoiding the need to create one manually viaDescribeAddressesRequest.builder()
- Parameters:
describeAddressesRequest
- AConsumer
that will call methods onDescribeAddressesRequest.Builder
to create a request.- Returns:
- Result of the DescribeAddresses operation returned by the service.
- See Also:
-
describeAddresses
default DescribeAddressesResponse describeAddresses() throws InvalidResourceException, InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballExceptionReturns 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.- Returns:
- Result of the DescribeAddresses operation returned by the service.
- See Also:
-
describeAddressesPaginator
default DescribeAddressesIterable describeAddressesPaginator() throws InvalidResourceException, InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballExceptionThis 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 Streamsoftware.amazon.awssdk.services.snowball.paginators.DescribeAddressesIterable responses = client.describeAddressesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeAddressesPaginator
default DescribeAddressesIterable describeAddressesPaginator(DescribeAddressesRequest describeAddressesRequest) throws InvalidResourceException, InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException 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 Streamsoftware.amazon.awssdk.services.snowball.paginators.DescribeAddressesIterable responses = client.describeAddressesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeAddressesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeAddressesPaginator
default DescribeAddressesIterable describeAddressesPaginator(Consumer<DescribeAddressesRequest.Builder> describeAddressesRequest) throws InvalidResourceException, InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException 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 Streamsoftware.amazon.awssdk.services.snowball.paginators.DescribeAddressesIterable responses = client.describeAddressesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeAddressesRequest.builder()
- Parameters:
describeAddressesRequest
- AConsumer
that will call methods onDescribeAddressesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCluster
default DescribeClusterResponse describeCluster(DescribeClusterRequest describeClusterRequest) throws InvalidResourceException, AwsServiceException, SdkClientException, SnowballException Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
- Parameters:
describeClusterRequest
-- Returns:
- Result of the DescribeCluster operation returned by the service.
- See Also:
-
describeCluster
default DescribeClusterResponse describeCluster(Consumer<DescribeClusterRequest.Builder> describeClusterRequest) throws InvalidResourceException, AwsServiceException, SdkClientException, SnowballException Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
This is a convenience which creates an instance of the
DescribeClusterRequest.Builder
avoiding the need to create one manually viaDescribeClusterRequest.builder()
- Parameters:
describeClusterRequest
- AConsumer
that will call methods onDescribeClusterRequest.Builder
to create a request.- Returns:
- Result of the DescribeCluster operation returned by the service.
- See Also:
-
describeJob
default DescribeJobResponse describeJob(DescribeJobRequest describeJobRequest) throws InvalidResourceException, AwsServiceException, SdkClientException, SnowballException Returns information about a specific job including shipping information, job status, and other important metadata.
- Parameters:
describeJobRequest
-- Returns:
- Result of the DescribeJob operation returned by the service.
- See Also:
-
describeJob
default DescribeJobResponse describeJob(Consumer<DescribeJobRequest.Builder> describeJobRequest) throws InvalidResourceException, AwsServiceException, SdkClientException, SnowballException Returns information about a specific job including shipping information, job status, and other important metadata.
This is a convenience which creates an instance of the
DescribeJobRequest.Builder
avoiding the need to create one manually viaDescribeJobRequest.builder()
- Parameters:
describeJobRequest
- AConsumer
that will call methods onDescribeJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeJob operation returned by the service.
- See Also:
-
describeReturnShippingLabel
default 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.
- Parameters:
describeReturnShippingLabelRequest
-- Returns:
- Result of the DescribeReturnShippingLabel operation returned by the service.
- See Also:
-
describeReturnShippingLabel
default 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 viaDescribeReturnShippingLabelRequest.builder()
- Parameters:
describeReturnShippingLabelRequest
- AConsumer
that will call methods onDescribeReturnShippingLabelRequest.Builder
to create a request.- Returns:
- Result of the DescribeReturnShippingLabel operation returned by the service.
- See Also:
-
getJobManifest
default GetJobManifestResponse getJobManifest(GetJobManifestRequest getJobManifestRequest) throws InvalidResourceException, InvalidJobStateException, AwsServiceException, SdkClientException, SnowballException Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified
JobId
value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to theGetJobManifest
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 andUnlockCode
code value are used for securing your device and should only be used when you have the device. The manifest is decrypted by using theUnlockCode
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.
- Parameters:
getJobManifestRequest
-- Returns:
- Result of the GetJobManifest operation returned by the service.
- See Also:
-
getJobManifest
default GetJobManifestResponse getJobManifest(Consumer<GetJobManifestRequest.Builder> getJobManifestRequest) throws InvalidResourceException, InvalidJobStateException, AwsServiceException, SdkClientException, SnowballException Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified
JobId
value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to theGetJobManifest
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 andUnlockCode
code value are used for securing your device and should only be used when you have the device. The manifest is decrypted by using theUnlockCode
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 viaGetJobManifestRequest.builder()
- Parameters:
getJobManifestRequest
- AConsumer
that will call methods onGetJobManifestRequest.Builder
to create a request.- Returns:
- Result of the GetJobManifest operation returned by the service.
- See Also:
-
getJobUnlockCode
default GetJobUnlockCodeResponse getJobUnlockCode(GetJobUnlockCodeRequest getJobUnlockCodeRequest) throws InvalidResourceException, InvalidJobStateException, AwsServiceException, SdkClientException, SnowballException Returns the
UnlockCode
code value for the specified job. A particularUnlockCode
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 isWithCustomer
as the manifest andUnlock
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.- Parameters:
getJobUnlockCodeRequest
-- Returns:
- Result of the GetJobUnlockCode operation returned by the service.
- See Also:
-
getJobUnlockCode
default GetJobUnlockCodeResponse getJobUnlockCode(Consumer<GetJobUnlockCodeRequest.Builder> getJobUnlockCodeRequest) throws InvalidResourceException, InvalidJobStateException, AwsServiceException, SdkClientException, SnowballException Returns the
UnlockCode
code value for the specified job. A particularUnlockCode
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 isWithCustomer
as the manifest andUnlock
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 viaGetJobUnlockCodeRequest.builder()
- Parameters:
getJobUnlockCodeRequest
- AConsumer
that will call methods onGetJobUnlockCodeRequest.Builder
to create a request.- Returns:
- Result of the GetJobUnlockCode operation returned by the service.
- See Also:
-
getSnowballUsage
default 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.
- Parameters:
getSnowballUsageRequest
-- Returns:
- Result of the GetSnowballUsage operation returned by the service.
- See Also:
-
getSnowballUsage
default 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 viaGetSnowballUsageRequest.builder()
- Parameters:
getSnowballUsageRequest
- AConsumer
that will call methods onGetSnowballUsageRequest.Builder
to create a request.- Returns:
- Result of the GetSnowballUsage operation returned by the service.
- See Also:
-
getSnowballUsage
default GetSnowballUsageResponse getSnowballUsage() throws AwsServiceException, SdkClientException, SnowballExceptionReturns 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.
- Returns:
- Result of the GetSnowballUsage operation returned by the service.
- See Also:
-
getSoftwareUpdates
default 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
.- Parameters:
getSoftwareUpdatesRequest
-- Returns:
- Result of the GetSoftwareUpdates operation returned by the service.
- See Also:
-
getSoftwareUpdates
default 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 viaGetSoftwareUpdatesRequest.builder()
- Parameters:
getSoftwareUpdatesRequest
- AConsumer
that will call methods onGetSoftwareUpdatesRequest.Builder
to create a request.- Returns:
- Result of the GetSoftwareUpdates operation returned by the service.
- See Also:
-
listClusterJobs
default ListClusterJobsResponse listClusterJobs(ListClusterJobsRequest listClusterJobsRequest) throws InvalidResourceException, InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException Returns an array of
JobListEntry
objects of the specified length. EachJobListEntry
object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.- Parameters:
listClusterJobsRequest
-- Returns:
- Result of the ListClusterJobs operation returned by the service.
- See Also:
-
listClusterJobs
default ListClusterJobsResponse listClusterJobs(Consumer<ListClusterJobsRequest.Builder> listClusterJobsRequest) throws InvalidResourceException, InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException Returns an array of
JobListEntry
objects of the specified length. EachJobListEntry
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 viaListClusterJobsRequest.builder()
- Parameters:
listClusterJobsRequest
- AConsumer
that will call methods onListClusterJobsRequest.Builder
to create a request.- Returns:
- Result of the ListClusterJobs operation returned by the service.
- See Also:
-
listClusterJobsPaginator
default ListClusterJobsIterable listClusterJobsPaginator(ListClusterJobsRequest listClusterJobsRequest) throws InvalidResourceException, InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException 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 Streamsoftware.amazon.awssdk.services.snowball.paginators.ListClusterJobsIterable responses = client.listClusterJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listClusterJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listClusterJobsPaginator
default ListClusterJobsIterable listClusterJobsPaginator(Consumer<ListClusterJobsRequest.Builder> listClusterJobsRequest) throws InvalidResourceException, InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException 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 Streamsoftware.amazon.awssdk.services.snowball.paginators.ListClusterJobsIterable responses = client.listClusterJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListClusterJobsRequest.builder()
- Parameters:
listClusterJobsRequest
- AConsumer
that will call methods onListClusterJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listClusters
default ListClustersResponse listClusters(ListClustersRequest listClustersRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException Returns an array of
ClusterListEntry
objects of the specified length. EachClusterListEntry
object contains a cluster's state, a cluster's ID, and other important status information.- Parameters:
listClustersRequest
-- Returns:
- Result of the ListClusters operation returned by the service.
- See Also:
-
listClusters
default ListClustersResponse listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException Returns an array of
ClusterListEntry
objects of the specified length. EachClusterListEntry
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 viaListClustersRequest.builder()
- Parameters:
listClustersRequest
- AConsumer
that will call methods onListClustersRequest.Builder
to create a request.- Returns:
- Result of the ListClusters operation returned by the service.
- See Also:
-
listClusters
default ListClustersResponse listClusters() throws InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballExceptionReturns an array of
ClusterListEntry
objects of the specified length. EachClusterListEntry
object contains a cluster's state, a cluster's ID, and other important status information.- Returns:
- Result of the ListClusters operation returned by the service.
- See Also:
-
listClustersPaginator
default ListClustersIterable listClustersPaginator() throws InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballExceptionThis 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 Streamsoftware.amazon.awssdk.services.snowball.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listClustersPaginator
default ListClustersIterable listClustersPaginator(ListClustersRequest listClustersRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException 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 Streamsoftware.amazon.awssdk.services.snowball.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listClustersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listClustersPaginator
default ListClustersIterable listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException 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 Streamsoftware.amazon.awssdk.services.snowball.paginators.ListClustersIterable responses = client.listClustersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListClustersRequest.builder()
- Parameters:
listClustersRequest
- AConsumer
that will call methods onListClustersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCompatibleImages
default ListCompatibleImagesResponse listCompatibleImages(ListCompatibleImagesRequest listCompatibleImagesRequest) throws InvalidNextTokenException, Ec2RequestFailedException, AwsServiceException, SdkClientException, SnowballException This action returns a list of the different Amazon EC2-compatible Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VM Import/Export and running locally in AMIs.
- Parameters:
listCompatibleImagesRequest
-- Returns:
- Result of the ListCompatibleImages operation returned by the service.
- See Also:
-
listCompatibleImages
default ListCompatibleImagesResponse listCompatibleImages(Consumer<ListCompatibleImagesRequest.Builder> listCompatibleImagesRequest) throws InvalidNextTokenException, Ec2RequestFailedException, AwsServiceException, SdkClientException, SnowballException This action returns a list of the different Amazon EC2-compatible Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VM Import/Export and running locally in AMIs.
This is a convenience which creates an instance of the
ListCompatibleImagesRequest.Builder
avoiding the need to create one manually viaListCompatibleImagesRequest.builder()
- Parameters:
listCompatibleImagesRequest
- AConsumer
that will call methods onListCompatibleImagesRequest.Builder
to create a request.- Returns:
- Result of the ListCompatibleImages operation returned by the service.
- See Also:
-
listCompatibleImages
default ListCompatibleImagesResponse listCompatibleImages() throws InvalidNextTokenException, Ec2RequestFailedException, AwsServiceException, SdkClientException, SnowballExceptionThis action returns a list of the different Amazon EC2-compatible Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VM Import/Export and running locally in AMIs.
- Returns:
- Result of the ListCompatibleImages operation returned by the service.
- See Also:
-
listCompatibleImagesPaginator
default ListCompatibleImagesIterable listCompatibleImagesPaginator() throws InvalidNextTokenException, Ec2RequestFailedException, AwsServiceException, SdkClientException, SnowballExceptionThis 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 Streamsoftware.amazon.awssdk.services.snowball.paginators.ListCompatibleImagesIterable responses = client.listCompatibleImagesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCompatibleImagesPaginator
default ListCompatibleImagesIterable listCompatibleImagesPaginator(ListCompatibleImagesRequest listCompatibleImagesRequest) throws InvalidNextTokenException, Ec2RequestFailedException, AwsServiceException, SdkClientException, SnowballException 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 Streamsoftware.amazon.awssdk.services.snowball.paginators.ListCompatibleImagesIterable responses = client.listCompatibleImagesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listCompatibleImagesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCompatibleImagesPaginator
default ListCompatibleImagesIterable listCompatibleImagesPaginator(Consumer<ListCompatibleImagesRequest.Builder> listCompatibleImagesRequest) throws InvalidNextTokenException, Ec2RequestFailedException, AwsServiceException, SdkClientException, SnowballException 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 Streamsoftware.amazon.awssdk.services.snowball.paginators.ListCompatibleImagesIterable responses = client.listCompatibleImagesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListCompatibleImagesRequest.builder()
- Parameters:
listCompatibleImagesRequest
- AConsumer
that will call methods onListCompatibleImagesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listJobs
default ListJobsResponse listJobs(ListJobsRequest listJobsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException Returns an array of
JobListEntry
objects of the specified length. EachJobListEntry
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.- Parameters:
listJobsRequest
-- Returns:
- Result of the ListJobs operation returned by the service.
- See Also:
-
listJobs
default ListJobsResponse listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException Returns an array of
JobListEntry
objects of the specified length. EachJobListEntry
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 viaListJobsRequest.builder()
- Parameters:
listJobsRequest
- AConsumer
that will call methods onListJobsRequest.Builder
to create a request.- Returns:
- Result of the ListJobs operation returned by the service.
- See Also:
-
listJobs
default ListJobsResponse listJobs() throws InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballExceptionReturns an array of
JobListEntry
objects of the specified length. EachJobListEntry
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.- Returns:
- Result of the ListJobs operation returned by the service.
- See Also:
-
listJobsPaginator
default ListJobsIterable listJobsPaginator() throws InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballExceptionThis 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 Streamsoftware.amazon.awssdk.services.snowball.paginators.ListJobsIterable responses = client.listJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listJobsPaginator
default ListJobsIterable listJobsPaginator(ListJobsRequest listJobsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException 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 Streamsoftware.amazon.awssdk.services.snowball.paginators.ListJobsIterable responses = client.listJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listJobsPaginator
default ListJobsIterable listJobsPaginator(Consumer<ListJobsRequest.Builder> listJobsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException 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 Streamsoftware.amazon.awssdk.services.snowball.paginators.ListJobsIterable responses = client.listJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListJobsRequest.builder()
- Parameters:
listJobsRequest
- AConsumer
that will call methods onListJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listLongTermPricing
default ListLongTermPricingResponse listLongTermPricing(ListLongTermPricingRequest listLongTermPricingRequest) throws InvalidResourceException, InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException Lists all long-term pricing types.
- Parameters:
listLongTermPricingRequest
-- Returns:
- Result of the ListLongTermPricing operation returned by the service.
- See Also:
-
listLongTermPricing
default 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 viaListLongTermPricingRequest.builder()
- Parameters:
listLongTermPricingRequest
- AConsumer
that will call methods onListLongTermPricingRequest.Builder
to create a request.- Returns:
- Result of the ListLongTermPricing operation returned by the service.
- See Also:
-
listLongTermPricingPaginator
default ListLongTermPricingIterable listLongTermPricingPaginator(ListLongTermPricingRequest listLongTermPricingRequest) throws InvalidResourceException, InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException 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 Streamsoftware.amazon.awssdk.services.snowball.paginators.ListLongTermPricingIterable responses = client.listLongTermPricingPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listLongTermPricingRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listLongTermPricingPaginator
default ListLongTermPricingIterable listLongTermPricingPaginator(Consumer<ListLongTermPricingRequest.Builder> listLongTermPricingRequest) throws InvalidResourceException, InvalidNextTokenException, AwsServiceException, SdkClientException, SnowballException 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 Streamsoftware.amazon.awssdk.services.snowball.paginators.ListLongTermPricingIterable responses = client.listLongTermPricingPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListLongTermPricingRequest.builder()
- Parameters:
listLongTermPricingRequest
- AConsumer
that will call methods onListLongTermPricingRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPickupLocations
default ListPickupLocationsResponse listPickupLocations(ListPickupLocationsRequest listPickupLocationsRequest) throws InvalidResourceException, AwsServiceException, SdkClientException, SnowballException A list of locations from which the customer can choose to pickup a device.
- Parameters:
listPickupLocationsRequest
-- Returns:
- Result of the ListPickupLocations operation returned by the service.
- See Also:
-
listPickupLocations
default ListPickupLocationsResponse listPickupLocations(Consumer<ListPickupLocationsRequest.Builder> listPickupLocationsRequest) throws InvalidResourceException, AwsServiceException, SdkClientException, SnowballException A list of locations from which the customer can choose to pickup a device.
This is a convenience which creates an instance of the
ListPickupLocationsRequest.Builder
avoiding the need to create one manually viaListPickupLocationsRequest.builder()
- Parameters:
listPickupLocationsRequest
- AConsumer
that will call methods onListPickupLocationsRequest.Builder
to create a request.- Returns:
- Result of the ListPickupLocations operation returned by the service.
- See Also:
-
listPickupLocationsPaginator
default ListPickupLocationsIterable listPickupLocationsPaginator(ListPickupLocationsRequest listPickupLocationsRequest) throws InvalidResourceException, AwsServiceException, SdkClientException, SnowballException This is a variant of
listPickupLocations(software.amazon.awssdk.services.snowball.model.ListPickupLocationsRequest)
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 Streamsoftware.amazon.awssdk.services.snowball.paginators.ListPickupLocationsIterable responses = client.listPickupLocationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.snowball.paginators.ListPickupLocationsIterable responses = client .listPickupLocationsPaginator(request); for (software.amazon.awssdk.services.snowball.model.ListPickupLocationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.snowball.paginators.ListPickupLocationsIterable responses = client.listPickupLocationsPaginator(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
listPickupLocations(software.amazon.awssdk.services.snowball.model.ListPickupLocationsRequest)
operation.- Parameters:
listPickupLocationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPickupLocationsPaginator
default ListPickupLocationsIterable listPickupLocationsPaginator(Consumer<ListPickupLocationsRequest.Builder> listPickupLocationsRequest) throws InvalidResourceException, AwsServiceException, SdkClientException, SnowballException This is a variant of
listPickupLocations(software.amazon.awssdk.services.snowball.model.ListPickupLocationsRequest)
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 Streamsoftware.amazon.awssdk.services.snowball.paginators.ListPickupLocationsIterable responses = client.listPickupLocationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.snowball.paginators.ListPickupLocationsIterable responses = client .listPickupLocationsPaginator(request); for (software.amazon.awssdk.services.snowball.model.ListPickupLocationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.snowball.paginators.ListPickupLocationsIterable responses = client.listPickupLocationsPaginator(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
listPickupLocations(software.amazon.awssdk.services.snowball.model.ListPickupLocationsRequest)
operation.
This is a convenience which creates an instance of the
ListPickupLocationsRequest.Builder
avoiding the need to create one manually viaListPickupLocationsRequest.builder()
- Parameters:
listPickupLocationsRequest
- AConsumer
that will call methods onListPickupLocationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listServiceVersions
default 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.- Parameters:
listServiceVersionsRequest
-- Returns:
- Result of the ListServiceVersions operation returned by the service.
- See Also:
-
listServiceVersions
default 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 viaListServiceVersionsRequest.builder()
- Parameters:
listServiceVersionsRequest
- AConsumer
that will call methods onListServiceVersionsRequest.Builder
to create a request.- Returns:
- Result of the ListServiceVersions operation returned by the service.
- See Also:
-
updateCluster
default UpdateClusterResponse updateCluster(UpdateClusterRequest updateClusterRequest) throws InvalidResourceException, InvalidJobStateException, KmsRequestFailedException, InvalidInputCombinationException, Ec2RequestFailedException, AwsServiceException, SdkClientException, SnowballException While a cluster's
ClusterState
value is in theAwaitingQuorum
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.- Parameters:
updateClusterRequest
-- Returns:
- Result of the UpdateCluster operation returned by the service.
- See Also:
-
updateCluster
default UpdateClusterResponse updateCluster(Consumer<UpdateClusterRequest.Builder> updateClusterRequest) throws InvalidResourceException, InvalidJobStateException, KmsRequestFailedException, InvalidInputCombinationException, Ec2RequestFailedException, AwsServiceException, SdkClientException, SnowballException While a cluster's
ClusterState
value is in theAwaitingQuorum
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 viaUpdateClusterRequest.builder()
- Parameters:
updateClusterRequest
- AConsumer
that will call methods onUpdateClusterRequest.Builder
to create a request.- Returns:
- Result of the UpdateCluster operation returned by the service.
- See Also:
-
updateJob
default UpdateJobResponse updateJob(UpdateJobRequest updateJobRequest) throws InvalidResourceException, InvalidJobStateException, KmsRequestFailedException, InvalidInputCombinationException, ClusterLimitExceededException, Ec2RequestFailedException, AwsServiceException, SdkClientException, SnowballException While a job's
JobState
value isNew
, 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.- Parameters:
updateJobRequest
-- Returns:
- Result of the UpdateJob operation returned by the service.
- See Also:
-
updateJob
default UpdateJobResponse updateJob(Consumer<UpdateJobRequest.Builder> updateJobRequest) throws InvalidResourceException, InvalidJobStateException, KmsRequestFailedException, InvalidInputCombinationException, ClusterLimitExceededException, Ec2RequestFailedException, AwsServiceException, SdkClientException, SnowballException While a job's
JobState
value isNew
, 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 viaUpdateJobRequest.builder()
- Parameters:
updateJobRequest
- AConsumer
that will call methods onUpdateJobRequest.Builder
to create a request.- Returns:
- Result of the UpdateJob operation returned by the service.
- See Also:
-
updateJobShipmentState
default UpdateJobShipmentStateResponse updateJobShipmentState(UpdateJobShipmentStateRequest updateJobShipmentStateRequest) throws InvalidResourceException, InvalidJobStateException, AwsServiceException, SdkClientException, SnowballException Updates the state when a shipment state changes to a different state.
- Parameters:
updateJobShipmentStateRequest
-- Returns:
- Result of the UpdateJobShipmentState operation returned by the service.
- See Also:
-
updateJobShipmentState
default 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 viaUpdateJobShipmentStateRequest.builder()
- Parameters:
updateJobShipmentStateRequest
- AConsumer
that will call methods onUpdateJobShipmentStateRequest.Builder
to create a request.- Returns:
- Result of the UpdateJobShipmentState operation returned by the service.
- See Also:
-
updateLongTermPricing
default UpdateLongTermPricingResponse updateLongTermPricing(UpdateLongTermPricingRequest updateLongTermPricingRequest) throws InvalidResourceException, AwsServiceException, SdkClientException, SnowballException Updates the long-term pricing type.
- Parameters:
updateLongTermPricingRequest
-- Returns:
- Result of the UpdateLongTermPricing operation returned by the service.
- See Also:
-
updateLongTermPricing
default 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 viaUpdateLongTermPricingRequest.builder()
- Parameters:
updateLongTermPricingRequest
- AConsumer
that will call methods onUpdateLongTermPricingRequest.Builder
to create a request.- Returns:
- Result of the UpdateLongTermPricing operation returned by the service.
- See Also:
-
create
Create aSnowballClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aSnowballClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-