com.amazonaws.services.snowball.AmazonSnowballClient Maven / Gradle / Ivy
Show all versions of aws-java-sdk-snowball Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.snowball;
import org.w3c.dom.*;
import java.net.*;
import java.util.*;
import javax.annotation.Generated;
import org.apache.commons.logging.*;
import com.amazonaws.*;
import com.amazonaws.annotation.SdkInternalApi;
import com.amazonaws.auth.*;
import com.amazonaws.handlers.*;
import com.amazonaws.http.*;
import com.amazonaws.internal.*;
import com.amazonaws.internal.auth.*;
import com.amazonaws.metrics.*;
import com.amazonaws.regions.*;
import com.amazonaws.transform.*;
import com.amazonaws.util.*;
import com.amazonaws.protocol.json.*;
import com.amazonaws.util.AWSRequestMetrics.Field;
import com.amazonaws.annotation.ThreadSafe;
import com.amazonaws.client.AwsSyncClientParams;
import com.amazonaws.client.builder.AdvancedConfig;
import com.amazonaws.services.snowball.AmazonSnowballClientBuilder;
import com.amazonaws.AmazonServiceException;
import com.amazonaws.services.snowball.model.*;
import com.amazonaws.services.snowball.model.transform.*;
/**
* Client for accessing Amazon Snowball. All service calls made using this client are blocking, and will not return
* until the service call completes.
*
*
* 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.
*
*/
@ThreadSafe
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AmazonSnowballClient extends AmazonWebServiceClient implements AmazonSnowball {
/** Provider for AWS credentials. */
private final AWSCredentialsProvider awsCredentialsProvider;
private static final Log log = LogFactory.getLog(AmazonSnowball.class);
/** Default signing name for the service. */
private static final String DEFAULT_SIGNING_NAME = "snowball";
/** Client configuration factory providing ClientConfigurations tailored to this client */
protected static final ClientConfigurationFactory configFactory = new ClientConfigurationFactory();
private final AdvancedConfig advancedConfig;
private static final com.amazonaws.protocol.json.SdkJsonProtocolFactory protocolFactory = new com.amazonaws.protocol.json.SdkJsonProtocolFactory(
new JsonClientMetadata()
.withProtocolVersion("1.1")
.withSupportsCbor(false)
.withSupportsIon(false)
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("InvalidJobStateException").withExceptionUnmarshaller(
com.amazonaws.services.snowball.model.transform.InvalidJobStateExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("ReturnShippingLabelAlreadyExistsException").withExceptionUnmarshaller(
com.amazonaws.services.snowball.model.transform.ReturnShippingLabelAlreadyExistsExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("KMSRequestFailedException").withExceptionUnmarshaller(
com.amazonaws.services.snowball.model.transform.KMSRequestFailedExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("UnsupportedAddressException").withExceptionUnmarshaller(
com.amazonaws.services.snowball.model.transform.UnsupportedAddressExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("Ec2RequestFailedException").withExceptionUnmarshaller(
com.amazonaws.services.snowball.model.transform.Ec2RequestFailedExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("InvalidNextTokenException").withExceptionUnmarshaller(
com.amazonaws.services.snowball.model.transform.InvalidNextTokenExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("InvalidAddressException").withExceptionUnmarshaller(
com.amazonaws.services.snowball.model.transform.InvalidAddressExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("ConflictException").withExceptionUnmarshaller(
com.amazonaws.services.snowball.model.transform.ConflictExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("InvalidResourceException").withExceptionUnmarshaller(
com.amazonaws.services.snowball.model.transform.InvalidResourceExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("ClusterLimitExceededException").withExceptionUnmarshaller(
com.amazonaws.services.snowball.model.transform.ClusterLimitExceededExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("InvalidInputCombinationException").withExceptionUnmarshaller(
com.amazonaws.services.snowball.model.transform.InvalidInputCombinationExceptionUnmarshaller.getInstance()))
.withBaseServiceExceptionClass(com.amazonaws.services.snowball.model.AmazonSnowballException.class));
/**
* Constructs a new client to invoke service methods on Amazon Snowball. A credentials provider chain will be used
* that searches for credentials in this order:
*
* - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
* - Java System Properties - aws.accessKeyId and aws.secretKey
* - Instance profile credentials delivered through the Amazon EC2 metadata service
*
*
*
* All service calls made using this new client object are blocking, and will not return until the service call
* completes.
*
* @see DefaultAWSCredentialsProviderChain
* @deprecated use {@link AmazonSnowballClientBuilder#defaultClient()}
*/
@Deprecated
public AmazonSnowballClient() {
this(DefaultAWSCredentialsProviderChain.getInstance(), configFactory.getConfig());
}
/**
* Constructs a new client to invoke service methods on Amazon Snowball. A credentials provider chain will be used
* that searches for credentials in this order:
*
* - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
* - Java System Properties - aws.accessKeyId and aws.secretKey
* - Instance profile credentials delivered through the Amazon EC2 metadata service
*
*
*
* All service calls made using this new client object are blocking, and will not return until the service call
* completes.
*
* @param clientConfiguration
* The client configuration options controlling how this client connects to Amazon Snowball (ex: proxy
* settings, retry counts, etc.).
*
* @see DefaultAWSCredentialsProviderChain
* @deprecated use {@link AmazonSnowballClientBuilder#withClientConfiguration(ClientConfiguration)}
*/
@Deprecated
public AmazonSnowballClient(ClientConfiguration clientConfiguration) {
this(DefaultAWSCredentialsProviderChain.getInstance(), clientConfiguration);
}
/**
* Constructs a new client to invoke service methods on Amazon Snowball using the specified AWS account credentials.
*
*
* All service calls made using this new client object are blocking, and will not return until the service call
* completes.
*
* @param awsCredentials
* The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
* @deprecated use {@link AmazonSnowballClientBuilder#withCredentials(AWSCredentialsProvider)} for example:
* {@code AmazonSnowballClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();}
*/
@Deprecated
public AmazonSnowballClient(AWSCredentials awsCredentials) {
this(awsCredentials, configFactory.getConfig());
}
/**
* Constructs a new client to invoke service methods on Amazon Snowball using the specified AWS account credentials
* and client configuration options.
*
*
* All service calls made using this new client object are blocking, and will not return until the service call
* completes.
*
* @param awsCredentials
* The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
* @param clientConfiguration
* The client configuration options controlling how this client connects to Amazon Snowball (ex: proxy
* settings, retry counts, etc.).
* @deprecated use {@link AmazonSnowballClientBuilder#withCredentials(AWSCredentialsProvider)} and
* {@link AmazonSnowballClientBuilder#withClientConfiguration(ClientConfiguration)}
*/
@Deprecated
public AmazonSnowballClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) {
super(clientConfiguration);
this.awsCredentialsProvider = new StaticCredentialsProvider(awsCredentials);
this.advancedConfig = AdvancedConfig.EMPTY;
init();
}
/**
* Constructs a new client to invoke service methods on Amazon Snowball using the specified AWS account credentials
* provider.
*
*
* All service calls made using this new client object are blocking, and will not return until the service call
* completes.
*
* @param awsCredentialsProvider
* The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
* @deprecated use {@link AmazonSnowballClientBuilder#withCredentials(AWSCredentialsProvider)}
*/
@Deprecated
public AmazonSnowballClient(AWSCredentialsProvider awsCredentialsProvider) {
this(awsCredentialsProvider, configFactory.getConfig());
}
/**
* Constructs a new client to invoke service methods on Amazon Snowball using the specified AWS account credentials
* provider and client configuration options.
*
*
* All service calls made using this new client object are blocking, and will not return until the service call
* completes.
*
* @param awsCredentialsProvider
* The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
* @param clientConfiguration
* The client configuration options controlling how this client connects to Amazon Snowball (ex: proxy
* settings, retry counts, etc.).
* @deprecated use {@link AmazonSnowballClientBuilder#withCredentials(AWSCredentialsProvider)} and
* {@link AmazonSnowballClientBuilder#withClientConfiguration(ClientConfiguration)}
*/
@Deprecated
public AmazonSnowballClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) {
this(awsCredentialsProvider, clientConfiguration, null);
}
/**
* Constructs a new client to invoke service methods on Amazon Snowball using the specified AWS account credentials
* provider, client configuration options, and request metric collector.
*
*
* All service calls made using this new client object are blocking, and will not return until the service call
* completes.
*
* @param awsCredentialsProvider
* The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
* @param clientConfiguration
* The client configuration options controlling how this client connects to Amazon Snowball (ex: proxy
* settings, retry counts, etc.).
* @param requestMetricCollector
* optional request metric collector
* @deprecated use {@link AmazonSnowballClientBuilder#withCredentials(AWSCredentialsProvider)} and
* {@link AmazonSnowballClientBuilder#withClientConfiguration(ClientConfiguration)} and
* {@link AmazonSnowballClientBuilder#withMetricsCollector(RequestMetricCollector)}
*/
@Deprecated
public AmazonSnowballClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector) {
super(clientConfiguration, requestMetricCollector);
this.awsCredentialsProvider = awsCredentialsProvider;
this.advancedConfig = AdvancedConfig.EMPTY;
init();
}
public static AmazonSnowballClientBuilder builder() {
return AmazonSnowballClientBuilder.standard();
}
/**
* Constructs a new client to invoke service methods on Amazon Snowball using the specified parameters.
*
*
* All service calls made using this new client object are blocking, and will not return until the service call
* completes.
*
* @param clientParams
* Object providing client parameters.
*/
AmazonSnowballClient(AwsSyncClientParams clientParams) {
this(clientParams, false);
}
/**
* Constructs a new client to invoke service methods on Amazon Snowball using the specified parameters.
*
*
* All service calls made using this new client object are blocking, and will not return until the service call
* completes.
*
* @param clientParams
* Object providing client parameters.
*/
AmazonSnowballClient(AwsSyncClientParams clientParams, boolean endpointDiscoveryEnabled) {
super(clientParams);
this.awsCredentialsProvider = clientParams.getCredentialsProvider();
this.advancedConfig = clientParams.getAdvancedConfig();
init();
}
private void init() {
setServiceNameIntern(DEFAULT_SIGNING_NAME);
setEndpointPrefix(ENDPOINT_PREFIX);
// calling this.setEndPoint(...) will also modify the signer accordingly
setEndpoint("snowball.us-east-1.amazonaws.com/");
HandlerChainFactory chainFactory = new HandlerChainFactory();
requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/snowball/request.handlers"));
requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/snowball/request.handler2s"));
requestHandler2s.addAll(chainFactory.getGlobalHandlers());
}
/**
*
* 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.
*
*
* @param cancelClusterRequest
* @return Result of the CancelCluster operation returned by the service.
* @throws KMSRequestFailedException
* The provided Key Management Service key lacks the permissions to perform the specified CreateJob
* or UpdateJob action.
* @throws InvalidJobStateException
* The action can't be performed because the job's current state doesn't allow that action to be performed.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you provided in your last request, and try
* again.
* @sample AmazonSnowball.CancelCluster
* @see AWS API
* Documentation
*/
@Override
public CancelClusterResult cancelCluster(CancelClusterRequest request) {
request = beforeClientExecution(request);
return executeCancelCluster(request);
}
@SdkInternalApi
final CancelClusterResult executeCancelCluster(CancelClusterRequest cancelClusterRequest) {
ExecutionContext executionContext = createExecutionContext(cancelClusterRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new CancelClusterRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(cancelClusterRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "CancelCluster");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new CancelClusterResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Cancels the specified job. You can only cancel a job before its JobState value changes to
* PreparingAppliance. Requesting the ListJobs or DescribeJob action returns
* a job's JobState as part of the response element data returned.
*
*
* @param cancelJobRequest
* @return Result of the CancelJob operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you provided in your last request, and try
* again.
* @throws InvalidJobStateException
* The action can't be performed because the job's current state doesn't allow that action to be performed.
* @throws KMSRequestFailedException
* The provided Key Management Service key lacks the permissions to perform the specified CreateJob
* or UpdateJob action.
* @sample AmazonSnowball.CancelJob
* @see AWS API
* Documentation
*/
@Override
public CancelJobResult cancelJob(CancelJobRequest request) {
request = beforeClientExecution(request);
return executeCancelJob(request);
}
@SdkInternalApi
final CancelJobResult executeCancelJob(CancelJobRequest cancelJobRequest) {
ExecutionContext executionContext = createExecutionContext(cancelJobRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new CancelJobRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(cancelJobRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "CancelJob");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(new JsonOperationMetadata()
.withPayloadJson(true).withHasStreamingSuccessResponse(false), new CancelJobResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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.
*
*
* @param createAddressRequest
* @return Result of the CreateAddress operation returned by the service.
* @throws InvalidAddressException
* The address provided was invalid. Check the address with your region's carrier, and try again.
* @throws UnsupportedAddressException
* The address is either outside the serviceable area for your region, or an error occurred. Check the
* address with your region's carrier and try again. If the issue persists, contact Amazon Web Services
* Support.
* @sample AmazonSnowball.CreateAddress
* @see AWS API
* Documentation
*/
@Override
public CreateAddressResult createAddress(CreateAddressRequest request) {
request = beforeClientExecution(request);
return executeCreateAddress(request);
}
@SdkInternalApi
final CreateAddressResult executeCreateAddress(CreateAddressRequest createAddressRequest) {
ExecutionContext executionContext = createExecutionContext(createAddressRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new CreateAddressRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(createAddressRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "CreateAddress");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new CreateAddressResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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.
*
*
* @param createClusterRequest
* @return Result of the CreateCluster operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you provided in your last request, and try
* again.
* @throws KMSRequestFailedException
* The provided Key Management Service key lacks the permissions to perform the specified CreateJob
* or UpdateJob action.
* @throws InvalidInputCombinationException
* Job or cluster creation failed. One or more inputs were invalid. Confirm that the
* CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try
* again.
* @throws Ec2RequestFailedException
* Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.
* @sample AmazonSnowball.CreateCluster
* @see AWS API
* Documentation
*/
@Override
public CreateClusterResult createCluster(CreateClusterRequest request) {
request = beforeClientExecution(request);
return executeCreateCluster(request);
}
@SdkInternalApi
final CreateClusterResult executeCreateCluster(CreateClusterRequest createClusterRequest) {
ExecutionContext executionContext = createExecutionContext(createClusterRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new CreateClusterRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(createClusterRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "CreateCluster");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new CreateClusterResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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
*
*
*
*
*
*
* @param createJobRequest
* @return Result of the CreateJob operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you provided in your last request, and try
* again.
* @throws KMSRequestFailedException
* The provided Key Management Service key lacks the permissions to perform the specified CreateJob
* or UpdateJob action.
* @throws InvalidInputCombinationException
* Job or cluster creation failed. One or more inputs were invalid. Confirm that the
* CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try
* again.
* @throws ClusterLimitExceededException
* Job creation failed. Currently, clusters support five nodes. If you have fewer than five nodes for your
* cluster and you have more nodes to create for this cluster, try again and create jobs until your cluster
* has exactly five nodes.
* @throws Ec2RequestFailedException
* Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.
* @sample AmazonSnowball.CreateJob
* @see AWS API
* Documentation
*/
@Override
public CreateJobResult createJob(CreateJobRequest request) {
request = beforeClientExecution(request);
return executeCreateJob(request);
}
@SdkInternalApi
final CreateJobResult executeCreateJob(CreateJobRequest createJobRequest) {
ExecutionContext executionContext = createExecutionContext(createJobRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new CreateJobRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(createJobRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "CreateJob");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(new JsonOperationMetadata()
.withPayloadJson(true).withHasStreamingSuccessResponse(false), new CreateJobResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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.
*
*
* @param createLongTermPricingRequest
* @return Result of the CreateLongTermPricing operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you provided in your last request, and try
* again.
* @sample AmazonSnowball.CreateLongTermPricing
* @see AWS
* API Documentation
*/
@Override
public CreateLongTermPricingResult createLongTermPricing(CreateLongTermPricingRequest request) {
request = beforeClientExecution(request);
return executeCreateLongTermPricing(request);
}
@SdkInternalApi
final CreateLongTermPricingResult executeCreateLongTermPricing(CreateLongTermPricingRequest createLongTermPricingRequest) {
ExecutionContext executionContext = createExecutionContext(createLongTermPricingRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new CreateLongTermPricingRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(createLongTermPricingRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "CreateLongTermPricing");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory
.createResponseHandler(new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false),
new CreateLongTermPricingResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
*
*
* @param createReturnShippingLabelRequest
* @return Result of the CreateReturnShippingLabel operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you provided in your last request, and try
* again.
* @throws InvalidJobStateException
* The action can't be performed because the job's current state doesn't allow that action to be performed.
* @throws InvalidInputCombinationException
* Job or cluster creation failed. One or more inputs were invalid. Confirm that the
* CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try
* again.
* @throws ConflictException
* You get this exception when you call CreateReturnShippingLabel more than once when other
* requests are not completed.
* @throws ReturnShippingLabelAlreadyExistsException
* You get this exception if you call CreateReturnShippingLabel and a valid return shipping
* label already exists. In this case, use DescribeReturnShippingLabel to get the URL.
* @sample AmazonSnowball.CreateReturnShippingLabel
* @see AWS API Documentation
*/
@Override
public CreateReturnShippingLabelResult createReturnShippingLabel(CreateReturnShippingLabelRequest request) {
request = beforeClientExecution(request);
return executeCreateReturnShippingLabel(request);
}
@SdkInternalApi
final CreateReturnShippingLabelResult executeCreateReturnShippingLabel(CreateReturnShippingLabelRequest createReturnShippingLabelRequest) {
ExecutionContext executionContext = createExecutionContext(createReturnShippingLabelRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new CreateReturnShippingLabelRequestProtocolMarshaller(protocolFactory).marshall(super
.beforeMarshalling(createReturnShippingLabelRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "CreateReturnShippingLabel");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false),
new CreateReturnShippingLabelResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Takes an AddressId and returns specific details about that address in the form of an
* Address object.
*
*
* @param describeAddressRequest
* @return Result of the DescribeAddress operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you provided in your last request, and try
* again.
* @sample AmazonSnowball.DescribeAddress
* @see AWS API
* Documentation
*/
@Override
public DescribeAddressResult describeAddress(DescribeAddressRequest request) {
request = beforeClientExecution(request);
return executeDescribeAddress(request);
}
@SdkInternalApi
final DescribeAddressResult executeDescribeAddress(DescribeAddressRequest describeAddressRequest) {
ExecutionContext executionContext = createExecutionContext(describeAddressRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DescribeAddressRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(describeAddressRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "DescribeAddress");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new DescribeAddressResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Returns a specified number of ADDRESS objects. Calling this API in one of the US regions will return
* addresses from the list of all addresses associated with this account in all US regions.
*
*
* @param describeAddressesRequest
* @return Result of the DescribeAddresses operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you provided in your last request, and try
* again.
* @throws InvalidNextTokenException
* The NextToken string was altered unexpectedly, and the operation has stopped. Run the
* operation without changing the NextToken string, and try again.
* @sample AmazonSnowball.DescribeAddresses
* @see AWS API
* Documentation
*/
@Override
public DescribeAddressesResult describeAddresses(DescribeAddressesRequest request) {
request = beforeClientExecution(request);
return executeDescribeAddresses(request);
}
@SdkInternalApi
final DescribeAddressesResult executeDescribeAddresses(DescribeAddressesRequest describeAddressesRequest) {
ExecutionContext executionContext = createExecutionContext(describeAddressesRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DescribeAddressesRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(describeAddressesRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "DescribeAddresses");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new DescribeAddressesResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Returns information about a specific cluster including shipping information, cluster status, and other important
* metadata.
*
*
* @param describeClusterRequest
* @return Result of the DescribeCluster operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you provided in your last request, and try
* again.
* @sample AmazonSnowball.DescribeCluster
* @see AWS API
* Documentation
*/
@Override
public DescribeClusterResult describeCluster(DescribeClusterRequest request) {
request = beforeClientExecution(request);
return executeDescribeCluster(request);
}
@SdkInternalApi
final DescribeClusterResult executeDescribeCluster(DescribeClusterRequest describeClusterRequest) {
ExecutionContext executionContext = createExecutionContext(describeClusterRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DescribeClusterRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(describeClusterRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "DescribeCluster");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new DescribeClusterResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Returns information about a specific job including shipping information, job status, and other important
* metadata.
*
*
* @param describeJobRequest
* @return Result of the DescribeJob operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you provided in your last request, and try
* again.
* @sample AmazonSnowball.DescribeJob
* @see AWS API
* Documentation
*/
@Override
public DescribeJobResult describeJob(DescribeJobRequest request) {
request = beforeClientExecution(request);
return executeDescribeJob(request);
}
@SdkInternalApi
final DescribeJobResult executeDescribeJob(DescribeJobRequest describeJobRequest) {
ExecutionContext executionContext = createExecutionContext(describeJobRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DescribeJobRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(describeJobRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "DescribeJob");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new DescribeJobResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Information on the shipping label of a Snow device that is being returned to Amazon Web Services.
*
*
* @param describeReturnShippingLabelRequest
* @return Result of the DescribeReturnShippingLabel operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you provided in your last request, and try
* again.
* @throws InvalidJobStateException
* The action can't be performed because the job's current state doesn't allow that action to be performed.
* @throws ConflictException
* You get this exception when you call CreateReturnShippingLabel more than once when other
* requests are not completed.
* @sample AmazonSnowball.DescribeReturnShippingLabel
* @see AWS API Documentation
*/
@Override
public DescribeReturnShippingLabelResult describeReturnShippingLabel(DescribeReturnShippingLabelRequest request) {
request = beforeClientExecution(request);
return executeDescribeReturnShippingLabel(request);
}
@SdkInternalApi
final DescribeReturnShippingLabelResult executeDescribeReturnShippingLabel(DescribeReturnShippingLabelRequest describeReturnShippingLabelRequest) {
ExecutionContext executionContext = createExecutionContext(describeReturnShippingLabelRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DescribeReturnShippingLabelRequestProtocolMarshaller(protocolFactory).marshall(super
.beforeMarshalling(describeReturnShippingLabelRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "DescribeReturnShippingLabel");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false),
new DescribeReturnShippingLabelResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified
* JobId value. You can access the manifest file for up to 60 minutes after this request has been made.
* To access the manifest file after 60 minutes have passed, you'll have to make another call to the
* GetJobManifest action.
*
*
* The manifest is an encrypted file that you can download after your job enters the WithCustomer
* status. This is the only valid status for calling this API as the manifest and UnlockCode code value
* are used for securing your device and should only be used when you have the device. The manifest is decrypted by
* using the UnlockCode code value, when you pass both values to the Snow device through the Snowball
* client when the client is started for the first time.
*
*
* As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same
* location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from
* gaining access to the Snow device associated with that job.
*
*
* The credentials of a given job, including its manifest file and unlock code, expire 360 days after the job is
* created.
*
*
* @param getJobManifestRequest
* @return Result of the GetJobManifest operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you provided in your last request, and try
* again.
* @throws InvalidJobStateException
* The action can't be performed because the job's current state doesn't allow that action to be performed.
* @sample AmazonSnowball.GetJobManifest
* @see AWS API
* Documentation
*/
@Override
public GetJobManifestResult getJobManifest(GetJobManifestRequest request) {
request = beforeClientExecution(request);
return executeGetJobManifest(request);
}
@SdkInternalApi
final GetJobManifestResult executeGetJobManifest(GetJobManifestRequest getJobManifestRequest) {
ExecutionContext executionContext = createExecutionContext(getJobManifestRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new GetJobManifestRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(getJobManifestRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "GetJobManifest");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new GetJobManifestResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Returns the UnlockCode code value for the specified job. A particular UnlockCode value
* can be accessed for up to 360 days after the associated job has been created.
*
*
* The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code
* is used to decrypt the manifest file when it is passed along with the manifest to the Snow device through the
* Snowball client when the client is started for the first time. The only valid status for calling this API is
* WithCustomer as the manifest and Unlock code values are used for securing your device
* and should only be used when you have the device.
*
*
* As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location
* as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access
* to the Snow device associated with that job.
*
*
* @param getJobUnlockCodeRequest
* @return Result of the GetJobUnlockCode operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you provided in your last request, and try
* again.
* @throws InvalidJobStateException
* The action can't be performed because the job's current state doesn't allow that action to be performed.
* @sample AmazonSnowball.GetJobUnlockCode
* @see AWS API
* Documentation
*/
@Override
public GetJobUnlockCodeResult getJobUnlockCode(GetJobUnlockCodeRequest request) {
request = beforeClientExecution(request);
return executeGetJobUnlockCode(request);
}
@SdkInternalApi
final GetJobUnlockCodeResult executeGetJobUnlockCode(GetJobUnlockCodeRequest getJobUnlockCodeRequest) {
ExecutionContext executionContext = createExecutionContext(getJobUnlockCodeRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new GetJobUnlockCodeRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(getJobUnlockCodeRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "GetJobUnlockCode");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new GetJobUnlockCodeResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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.
*
*
* @param getSnowballUsageRequest
* @return Result of the GetSnowballUsage operation returned by the service.
* @sample AmazonSnowball.GetSnowballUsage
* @see AWS API
* Documentation
*/
@Override
public GetSnowballUsageResult getSnowballUsage(GetSnowballUsageRequest request) {
request = beforeClientExecution(request);
return executeGetSnowballUsage(request);
}
@SdkInternalApi
final GetSnowballUsageResult executeGetSnowballUsage(GetSnowballUsageRequest getSnowballUsageRequest) {
ExecutionContext executionContext = createExecutionContext(getSnowballUsageRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new GetSnowballUsageRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(getSnowballUsageRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "GetSnowballUsage");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new GetSnowballUsageResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.
*
*
* @param getSoftwareUpdatesRequest
* @return Result of the GetSoftwareUpdates operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you provided in your last request, and try
* again.
* @throws InvalidJobStateException
* The action can't be performed because the job's current state doesn't allow that action to be performed.
* @sample AmazonSnowball.GetSoftwareUpdates
* @see AWS
* API Documentation
*/
@Override
public GetSoftwareUpdatesResult getSoftwareUpdates(GetSoftwareUpdatesRequest request) {
request = beforeClientExecution(request);
return executeGetSoftwareUpdates(request);
}
@SdkInternalApi
final GetSoftwareUpdatesResult executeGetSoftwareUpdates(GetSoftwareUpdatesRequest getSoftwareUpdatesRequest) {
ExecutionContext executionContext = createExecutionContext(getSoftwareUpdatesRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new GetSoftwareUpdatesRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(getSoftwareUpdatesRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "GetSoftwareUpdates");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new GetSoftwareUpdatesResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Returns an array of JobListEntry objects of the specified length. Each JobListEntry
* object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.
*
*
* @param listClusterJobsRequest
* @return Result of the ListClusterJobs operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you provided in your last request, and try
* again.
* @throws InvalidNextTokenException
* The NextToken string was altered unexpectedly, and the operation has stopped. Run the
* operation without changing the NextToken string, and try again.
* @sample AmazonSnowball.ListClusterJobs
* @see AWS API
* Documentation
*/
@Override
public ListClusterJobsResult listClusterJobs(ListClusterJobsRequest request) {
request = beforeClientExecution(request);
return executeListClusterJobs(request);
}
@SdkInternalApi
final ListClusterJobsResult executeListClusterJobs(ListClusterJobsRequest listClusterJobsRequest) {
ExecutionContext executionContext = createExecutionContext(listClusterJobsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new ListClusterJobsRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(listClusterJobsRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "ListClusterJobs");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new ListClusterJobsResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Returns an array of ClusterListEntry objects of the specified length. Each
* ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status
* information.
*
*
* @param listClustersRequest
* @return Result of the ListClusters operation returned by the service.
* @throws InvalidNextTokenException
* The NextToken string was altered unexpectedly, and the operation has stopped. Run the
* operation without changing the NextToken string, and try again.
* @sample AmazonSnowball.ListClusters
* @see AWS API
* Documentation
*/
@Override
public ListClustersResult listClusters(ListClustersRequest request) {
request = beforeClientExecution(request);
return executeListClusters(request);
}
@SdkInternalApi
final ListClustersResult executeListClusters(ListClustersRequest listClustersRequest) {
ExecutionContext executionContext = createExecutionContext(listClustersRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new ListClustersRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(listClustersRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "ListClusters");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new ListClustersResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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.
*
*
* @param listCompatibleImagesRequest
* @return Result of the ListCompatibleImages operation returned by the service.
* @throws InvalidNextTokenException
* The NextToken string was altered unexpectedly, and the operation has stopped. Run the
* operation without changing the NextToken string, and try again.
* @throws Ec2RequestFailedException
* Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.
* @sample AmazonSnowball.ListCompatibleImages
* @see AWS
* API Documentation
*/
@Override
public ListCompatibleImagesResult listCompatibleImages(ListCompatibleImagesRequest request) {
request = beforeClientExecution(request);
return executeListCompatibleImages(request);
}
@SdkInternalApi
final ListCompatibleImagesResult executeListCompatibleImages(ListCompatibleImagesRequest listCompatibleImagesRequest) {
ExecutionContext executionContext = createExecutionContext(listCompatibleImagesRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new ListCompatibleImagesRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(listCompatibleImagesRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "ListCompatibleImages");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new ListCompatibleImagesResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Returns an array of JobListEntry objects of the specified length. Each JobListEntry
* object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case
* of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs
* associated with this account in all US regions.
*
*
* @param listJobsRequest
* @return Result of the ListJobs operation returned by the service.
* @throws InvalidNextTokenException
* The NextToken string was altered unexpectedly, and the operation has stopped. Run the
* operation without changing the NextToken string, and try again.
* @sample AmazonSnowball.ListJobs
* @see AWS API
* Documentation
*/
@Override
public ListJobsResult listJobs(ListJobsRequest request) {
request = beforeClientExecution(request);
return executeListJobs(request);
}
@SdkInternalApi
final ListJobsResult executeListJobs(ListJobsRequest listJobsRequest) {
ExecutionContext executionContext = createExecutionContext(listJobsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new ListJobsRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(listJobsRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "ListJobs");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(new JsonOperationMetadata()
.withPayloadJson(true).withHasStreamingSuccessResponse(false), new ListJobsResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Lists all long-term pricing types.
*
*
* @param listLongTermPricingRequest
* @return Result of the ListLongTermPricing operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you provided in your last request, and try
* again.
* @throws InvalidNextTokenException
* The NextToken string was altered unexpectedly, and the operation has stopped. Run the
* operation without changing the NextToken string, and try again.
* @sample AmazonSnowball.ListLongTermPricing
* @see AWS
* API Documentation
*/
@Override
public ListLongTermPricingResult listLongTermPricing(ListLongTermPricingRequest request) {
request = beforeClientExecution(request);
return executeListLongTermPricing(request);
}
@SdkInternalApi
final ListLongTermPricingResult executeListLongTermPricing(ListLongTermPricingRequest listLongTermPricingRequest) {
ExecutionContext executionContext = createExecutionContext(listLongTermPricingRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new ListLongTermPricingRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(listLongTermPricingRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "ListLongTermPricing");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new ListLongTermPricingResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* A list of locations from which the customer can choose to pickup a device.
*
*
* @param listPickupLocationsRequest
* @return Result of the ListPickupLocations operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you provided in your last request, and try
* again.
* @sample AmazonSnowball.ListPickupLocations
* @see AWS
* API Documentation
*/
@Override
public ListPickupLocationsResult listPickupLocations(ListPickupLocationsRequest request) {
request = beforeClientExecution(request);
return executeListPickupLocations(request);
}
@SdkInternalApi
final ListPickupLocationsResult executeListPickupLocations(ListPickupLocationsRequest listPickupLocationsRequest) {
ExecutionContext executionContext = createExecutionContext(listPickupLocationsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new ListPickupLocationsRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(listPickupLocationsRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "ListPickupLocations");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new ListPickupLocationsResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Lists all supported versions for Snow on-device services. Returns an array of ServiceVersion object
* containing the supported versions for a particular service.
*
*
* @param listServiceVersionsRequest
* @return Result of the ListServiceVersions operation returned by the service.
* @throws InvalidNextTokenException
* The NextToken string was altered unexpectedly, and the operation has stopped. Run the
* operation without changing the NextToken string, and try again.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you provided in your last request, and try
* again.
* @sample AmazonSnowball.ListServiceVersions
* @see AWS
* API Documentation
*/
@Override
public ListServiceVersionsResult listServiceVersions(ListServiceVersionsRequest request) {
request = beforeClientExecution(request);
return executeListServiceVersions(request);
}
@SdkInternalApi
final ListServiceVersionsResult executeListServiceVersions(ListServiceVersionsRequest listServiceVersionsRequest) {
ExecutionContext executionContext = createExecutionContext(listServiceVersionsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new ListServiceVersionsRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(listServiceVersionsRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "ListServiceVersions");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new ListServiceVersionsResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* While a cluster's ClusterState value is in the AwaitingQuorum state, you can update
* some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60
* minutes after the cluster being created, this action is no longer available.
*
*
* @param updateClusterRequest
* @return Result of the UpdateCluster operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you provided in your last request, and try
* again.
* @throws InvalidJobStateException
* The action can't be performed because the job's current state doesn't allow that action to be performed.
* @throws KMSRequestFailedException
* The provided Key Management Service key lacks the permissions to perform the specified CreateJob
* or UpdateJob action.
* @throws InvalidInputCombinationException
* Job or cluster creation failed. One or more inputs were invalid. Confirm that the
* CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try
* again.
* @throws Ec2RequestFailedException
* Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.
* @sample AmazonSnowball.UpdateCluster
* @see AWS API
* Documentation
*/
@Override
public UpdateClusterResult updateCluster(UpdateClusterRequest request) {
request = beforeClientExecution(request);
return executeUpdateCluster(request);
}
@SdkInternalApi
final UpdateClusterResult executeUpdateCluster(UpdateClusterRequest updateClusterRequest) {
ExecutionContext executionContext = createExecutionContext(updateClusterRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new UpdateClusterRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(updateClusterRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "UpdateCluster");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new UpdateClusterResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* While a job's JobState value is New, you can update some of the information associated
* with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created,
* this action is no longer available.
*
*
* @param updateJobRequest
* @return Result of the UpdateJob operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you provided in your last request, and try
* again.
* @throws InvalidJobStateException
* The action can't be performed because the job's current state doesn't allow that action to be performed.
* @throws KMSRequestFailedException
* The provided Key Management Service key lacks the permissions to perform the specified CreateJob
* or UpdateJob action.
* @throws InvalidInputCombinationException
* Job or cluster creation failed. One or more inputs were invalid. Confirm that the
* CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try
* again.
* @throws ClusterLimitExceededException
* Job creation failed. Currently, clusters support five nodes. If you have fewer than five nodes for your
* cluster and you have more nodes to create for this cluster, try again and create jobs until your cluster
* has exactly five nodes.
* @throws Ec2RequestFailedException
* Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.
* @sample AmazonSnowball.UpdateJob
* @see AWS API
* Documentation
*/
@Override
public UpdateJobResult updateJob(UpdateJobRequest request) {
request = beforeClientExecution(request);
return executeUpdateJob(request);
}
@SdkInternalApi
final UpdateJobResult executeUpdateJob(UpdateJobRequest updateJobRequest) {
ExecutionContext executionContext = createExecutionContext(updateJobRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new UpdateJobRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(updateJobRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "UpdateJob");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(new JsonOperationMetadata()
.withPayloadJson(true).withHasStreamingSuccessResponse(false), new UpdateJobResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Updates the state when a shipment state changes to a different state.
*
*
* @param updateJobShipmentStateRequest
* @return Result of the UpdateJobShipmentState operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you provided in your last request, and try
* again.
* @throws InvalidJobStateException
* The action can't be performed because the job's current state doesn't allow that action to be performed.
* @sample AmazonSnowball.UpdateJobShipmentState
* @see AWS API Documentation
*/
@Override
public UpdateJobShipmentStateResult updateJobShipmentState(UpdateJobShipmentStateRequest request) {
request = beforeClientExecution(request);
return executeUpdateJobShipmentState(request);
}
@SdkInternalApi
final UpdateJobShipmentStateResult executeUpdateJobShipmentState(UpdateJobShipmentStateRequest updateJobShipmentStateRequest) {
ExecutionContext executionContext = createExecutionContext(updateJobShipmentStateRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new UpdateJobShipmentStateRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(updateJobShipmentStateRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "UpdateJobShipmentState");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false),
new UpdateJobShipmentStateResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Updates the long-term pricing type.
*
*
* @param updateLongTermPricingRequest
* @return Result of the UpdateLongTermPricing operation returned by the service.
* @throws InvalidResourceException
* The specified resource can't be found. Check the information you provided in your last request, and try
* again.
* @sample AmazonSnowball.UpdateLongTermPricing
* @see AWS
* API Documentation
*/
@Override
public UpdateLongTermPricingResult updateLongTermPricing(UpdateLongTermPricingRequest request) {
request = beforeClientExecution(request);
return executeUpdateLongTermPricing(request);
}
@SdkInternalApi
final UpdateLongTermPricingResult executeUpdateLongTermPricing(UpdateLongTermPricingRequest updateLongTermPricingRequest) {
ExecutionContext executionContext = createExecutionContext(updateLongTermPricingRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new UpdateLongTermPricingRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(updateLongTermPricingRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Snowball");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "UpdateLongTermPricing");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory
.createResponseHandler(new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false),
new UpdateLongTermPricingResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
* Returns additional metadata for a previously executed successful, request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing the request.
*
* @param request
* The originally executed request
*
* @return The response metadata for the specified request, or null if none is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return client.getResponseMetadataForRequest(request);
}
/**
* Normal invoke with authentication. Credentials are required and may be overriden at the request level.
**/
private Response invoke(Request request, HttpResponseHandler> responseHandler,
ExecutionContext executionContext) {
return invoke(request, responseHandler, executionContext, null, null);
}
/**
* Normal invoke with authentication. Credentials are required and may be overriden at the request level.
**/
private Response invoke(Request request, HttpResponseHandler> responseHandler,
ExecutionContext executionContext, URI cachedEndpoint, URI uriFromEndpointTrait) {
executionContext.setCredentialsProvider(CredentialUtils.getCredentialsProvider(request.getOriginalRequest(), awsCredentialsProvider));
return doInvoke(request, responseHandler, executionContext, cachedEndpoint, uriFromEndpointTrait);
}
/**
* Invoke with no authentication. Credentials are not required and any credentials set on the client or request will
* be ignored for this operation.
**/
private Response anonymousInvoke(Request request,
HttpResponseHandler> responseHandler, ExecutionContext executionContext) {
return doInvoke(request, responseHandler, executionContext, null, null);
}
/**
* Invoke the request using the http client. Assumes credentials (or lack thereof) have been configured in the
* ExecutionContext beforehand.
**/
private Response doInvoke(Request request, HttpResponseHandler> responseHandler,
ExecutionContext executionContext, URI discoveredEndpoint, URI uriFromEndpointTrait) {
if (discoveredEndpoint != null) {
request.setEndpoint(discoveredEndpoint);
request.getOriginalRequest().getRequestClientOptions().appendUserAgent("endpoint-discovery");
} else if (uriFromEndpointTrait != null) {
request.setEndpoint(uriFromEndpointTrait);
} else {
request.setEndpoint(endpoint);
}
request.setTimeOffset(timeOffset);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler(new JsonErrorResponseMetadata());
return client.execute(request, responseHandler, errorResponseHandler, executionContext);
}
@com.amazonaws.annotation.SdkInternalApi
static com.amazonaws.protocol.json.SdkJsonProtocolFactory getProtocolFactory() {
return protocolFactory;
}
@Override
public void shutdown() {
super.shutdown();
}
}