Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
   /*
    * Copyright 2010-2015 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.storagegateway;
  
  import java.net.*;
  import java.util.*;
  
  
  import com.amazonaws.*;
  
Client for accessing AWSStorageGateway. All service calls made using this client are blocking, and will not return until the service call completes.

AWS Storage Gateway Service

AWS Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization's on-premises IT environment and AWS's storage infrastructure. The service enables you to securely upload data to the AWS cloud for cost effective backup and rapid disaster recovery.

Use the following links to get started using the AWS Storage Gateway Service API Reference :

  • AWS Storage Gateway Required Request Headers : Describes the required headers that you must send with every POST request to AWS Storage Gateway.
  • Signing Requests : AWS Storage Gateway requires that you authenticate every request you send; this topic describes how sign such a request.
  • Error Responses : Provides reference information about AWS Storage Gateway errors.
  • Operations in AWS Storage Gateway : Contains detailed descriptions of all AWS Storage Gateway operations, their request parameters, response elements, possible errors, and examples of requests and responses.
  • AWS Storage Gateway Regions and Endpoints : Provides a list of each of the regions and endpoints available for use with AWS Storage Gateway.
  
  public class AWSStorageGatewayClient extends AmazonWebServiceClient implements AWSStorageGateway {

    
Provider for AWS credentials.
  
  
      private static final Log log = LogFactory.getLog(AWSStorageGateway.class);

    
List of exception unmarshallers for all AWSStorageGateway exceptions.
  
      protected List<JsonErrorUnmarshallerjsonErrorUnmarshallers;

    
Constructs a new client to invoke service methods on AWSStorageGateway. 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.

 
     public AWSStorageGatewayClient() {
         this(new DefaultAWSCredentialsProviderChain(), new ClientConfiguration());
     }

    
Constructs a new client to invoke service methods on AWSStorageGateway. 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.

Parameters:
clientConfiguration The client configuration options controlling how this client connects to AWSStorageGateway (ex: proxy settings, retry counts, etc.).
See also:
com.amazonaws.auth.DefaultAWSCredentialsProviderChain
 
     public AWSStorageGatewayClient(ClientConfiguration clientConfiguration) {
         this(new DefaultAWSCredentialsProviderChain(), clientConfiguration);
     }

    
Constructs a new client to invoke service methods on AWSStorageGateway 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.

Parameters:
awsCredentials The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
 
     public AWSStorageGatewayClient(AWSCredentials awsCredentials) {
         this(awsCredentialsnew ClientConfiguration());
     }

    
Constructs a new client to invoke service methods on AWSStorageGateway 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.

Parameters:
awsCredentials The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
clientConfiguration The client configuration options controlling how this client connects to AWSStorageGateway (ex: proxy settings, retry counts, etc.).
 
     public AWSStorageGatewayClient(AWSCredentials awsCredentialsClientConfiguration clientConfiguration) {
         super(adjustClientConfiguration(clientConfiguration));
         
         this. = new StaticCredentialsProvider(awsCredentials);
         
         init();
     }

    
Constructs a new client to invoke service methods on AWSStorageGateway 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.

Parameters:
awsCredentialsProvider The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
 
     public AWSStorageGatewayClient(AWSCredentialsProvider awsCredentialsProvider) {
         this(awsCredentialsProvidernew ClientConfiguration());
     }

    
Constructs a new client to invoke service methods on AWSStorageGateway 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.

Parameters:
awsCredentialsProvider The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
clientConfiguration The client configuration options controlling how this client connects to AWSStorageGateway (ex: proxy settings, retry counts, etc.).
 
     public AWSStorageGatewayClient(AWSCredentialsProvider awsCredentialsProviderClientConfiguration clientConfiguration) {
         this(awsCredentialsProviderclientConfigurationnull);
     }

    
Constructs a new client to invoke service methods on AWSStorageGateway 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.

Parameters:
awsCredentialsProvider The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
clientConfiguration The client configuration options controlling how this client connects to AWSStorageGateway (ex: proxy settings, retry counts, etc.).
requestMetricCollector optional request metric collector
 
     public AWSStorageGatewayClient(AWSCredentialsProvider awsCredentialsProvider,
             ClientConfiguration clientConfiguration,
             RequestMetricCollector requestMetricCollector) {
         super(adjustClientConfiguration(clientConfiguration), requestMetricCollector);
         
         this. = awsCredentialsProvider;
         
         init();
     }
 
     private void init() {
         
         
         // calling this.setEndPoint(...) will also modify the signer accordingly
         this.setEndpoint("storagegateway.us-east-1.amazonaws.com");
         
         HandlerChainFactory chainFactory = new HandlerChainFactory();
         .addAll(chainFactory.newRequestHandlerChain(
                 "/com/amazonaws/services/storagegateway/request.handlers"));
         .addAll(chainFactory.newRequestHandler2Chain(
                 "/com/amazonaws/services/storagegateway/request.handler2s"));
     }
 
         ClientConfiguration config = orig;
         
         return config;
     }

    

This operation deletes a snapshot of a volume.

You can take snapshots of your gateway volumes on a scheduled or ad-hoc basis. This API enables you to delete a snapshot schedule for a volume. For more information, see Working with Snapshots . In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN).

NOTE: To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference.

Parameters:
deleteSnapshotScheduleRequest Container for the necessary parameters to execute the DeleteSnapshotSchedule service method on AWSStorageGateway.
Returns:
The response from the DeleteSnapshotSchedule service method, as returned by AWSStorageGateway.
Throws:
com.amazonaws.services.storagegateway.model.InternalServerErrorException
com.amazonaws.services.storagegateway.model.InvalidGatewayRequestException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.
 
     public DeleteSnapshotScheduleResult deleteSnapshotSchedule(DeleteSnapshotScheduleRequest deleteSnapshotScheduleRequest) {
         ExecutionContext executionContext = createExecutionContext(deleteSnapshotScheduleRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<DeleteSnapshotScheduleRequestrequest = null;
         Response<DeleteSnapshotScheduleResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new DeleteSnapshotScheduleRequestMarshaller().marshall(super.beforeMarshalling(deleteSnapshotScheduleRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             Unmarshaller<DeleteSnapshotScheduleResultJsonUnmarshallerContextunmarshaller =
                 new DeleteSnapshotScheduleResultJsonUnmarshaller();
             JsonResponseHandler<DeleteSnapshotScheduleResultresponseHandler =
                 new JsonResponseHandler<DeleteSnapshotScheduleResult>(unmarshaller);
 
             response = invoke(requestresponseHandlerexecutionContext);
 
             return response.getAwsResponse();
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }

    

This operation returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone.

Parameters:
describeMaintenanceStartTimeRequest Container for the necessary parameters to execute the DescribeMaintenanceStartTime service method on AWSStorageGateway.
Returns:
The response from the DescribeMaintenanceStartTime service method, as returned by AWSStorageGateway.
Throws:
com.amazonaws.services.storagegateway.model.InternalServerErrorException
com.amazonaws.services.storagegateway.model.InvalidGatewayRequestException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.
 
         ExecutionContext executionContext = createExecutionContext(describeMaintenanceStartTimeRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<DescribeMaintenanceStartTimeRequestrequest = null;
         Response<DescribeMaintenanceStartTimeResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new DescribeMaintenanceStartTimeRequestMarshaller().marshall(super.beforeMarshalling(describeMaintenanceStartTimeRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             Unmarshaller<DescribeMaintenanceStartTimeResultJsonUnmarshallerContextunmarshaller =
                 new DescribeMaintenanceStartTimeResultJsonUnmarshaller();
             JsonResponseHandler<DescribeMaintenanceStartTimeResultresponseHandler =
                 new JsonResponseHandler<DescribeMaintenanceStartTimeResult>(unmarshaller);
 
             response = invoke(requestresponseHandlerexecutionContext);
 
             return response.getAwsResponse();
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }

    

This operation creates a volume on a specified gateway. This operation is supported only for the gateway-stored volume architecture.

The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased.

In the request you must specify the gateway and the disk information on which you are creating the volume. In response, AWS Storage Gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

Parameters:
createStorediSCSIVolumeRequest Container for the necessary parameters to execute the CreateStorediSCSIVolume service method on AWSStorageGateway.
Returns:
The response from the CreateStorediSCSIVolume service method, as returned by AWSStorageGateway.
Throws:
com.amazonaws.services.storagegateway.model.InternalServerErrorException
com.amazonaws.services.storagegateway.model.InvalidGatewayRequestException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.
 
     public CreateStorediSCSIVolumeResult createStorediSCSIVolume(CreateStorediSCSIVolumeRequest createStorediSCSIVolumeRequest) {
         ExecutionContext executionContext = createExecutionContext(createStorediSCSIVolumeRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<CreateStorediSCSIVolumeRequestrequest = null;
         Response<CreateStorediSCSIVolumeResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new CreateStorediSCSIVolumeRequestMarshaller().marshall(super.beforeMarshalling(createStorediSCSIVolumeRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             Unmarshaller<CreateStorediSCSIVolumeResultJsonUnmarshallerContextunmarshaller =
                 new CreateStorediSCSIVolumeResultJsonUnmarshaller();
             JsonResponseHandler<CreateStorediSCSIVolumeResultresponseHandler =
                 new JsonResponseHandler<CreateStorediSCSIVolumeResult>(unmarshaller);
 
             response = invoke(requestresponseHandlerexecutionContext);
 
             return response.getAwsResponse();
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }

    

This operation initiates a snapshot of a volume.

AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad-hoc basis. This API enables you to take ad-hoc snapshot. For more information, see Working With Snapshots in the AWS Storage Gateway Console .

In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.

NOTE:To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the EC2 API reference.

Parameters:
createSnapshotRequest Container for the necessary parameters to execute the CreateSnapshot service method on AWSStorageGateway.
Returns:
The response from the CreateSnapshot service method, as returned by AWSStorageGateway.
Throws:
com.amazonaws.services.storagegateway.model.InternalServerErrorException
com.amazonaws.services.storagegateway.model.InvalidGatewayRequestException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.
 
     public CreateSnapshotResult createSnapshot(CreateSnapshotRequest createSnapshotRequest) {
         ExecutionContext executionContext = createExecutionContext(createSnapshotRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<CreateSnapshotRequestrequest = null;
         Response<CreateSnapshotResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new CreateSnapshotRequestMarshaller().marshall(super.beforeMarshalling(createSnapshotRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             Unmarshaller<CreateSnapshotResultJsonUnmarshallerContextunmarshaller =
                 new CreateSnapshotResultJsonUnmarshaller();
             JsonResponseHandler<CreateSnapshotResultresponseHandler =
                 new JsonResponseHandler<CreateSnapshotResult>(unmarshaller);
 
             response = invoke(requestresponseHandlerexecutionContext);
 
             return response.getAwsResponse();
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }

    

This operation configures one or more gateway local disks as working storage for a gateway. This operation is supported only for the gateway-stored volume architecture. This operation is deprecated method in cached-volumes API version (20120630). Use AddUploadBuffer instead.

NOTE: Working storage is also referred to as upload buffer. You can also use the AddUploadBuffer operation to add upload buffer to a stored-volume gateway.

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage.

Parameters:
addWorkingStorageRequest Container for the necessary parameters to execute the AddWorkingStorage service method on AWSStorageGateway.
Returns:
The response from the AddWorkingStorage service method, as returned by AWSStorageGateway.
Throws:
com.amazonaws.services.storagegateway.model.InternalServerErrorException
com.amazonaws.services.storagegateway.model.InvalidGatewayRequestException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.
 
     public AddWorkingStorageResult addWorkingStorage(AddWorkingStorageRequest addWorkingStorageRequest) {
         ExecutionContext executionContext = createExecutionContext(addWorkingStorageRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<AddWorkingStorageRequestrequest = null;
         Response<AddWorkingStorageResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new AddWorkingStorageRequestMarshaller().marshall(super.beforeMarshalling(addWorkingStorageRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             Unmarshaller<AddWorkingStorageResultJsonUnmarshallerContextunmarshaller =
                 new AddWorkingStorageResultJsonUnmarshaller();
             JsonResponseHandler<AddWorkingStorageResultresponseHandler =
                 new JsonResponseHandler<AddWorkingStorageResult>(unmarshaller);
 
             response = invoke(requestresponseHandlerexecutionContext);
 
             return response.getAwsResponse();
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }

    

Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS.

Parameters:
cancelRetrievalRequest Container for the necessary parameters to execute the CancelRetrieval service method on AWSStorageGateway.
Returns:
The response from the CancelRetrieval service method, as returned by AWSStorageGateway.
Throws:
com.amazonaws.services.storagegateway.model.InternalServerErrorException
com.amazonaws.services.storagegateway.model.InvalidGatewayRequestException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.
 
     public CancelRetrievalResult cancelRetrieval(CancelRetrievalRequest cancelRetrievalRequest) {
         ExecutionContext executionContext = createExecutionContext(cancelRetrievalRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<CancelRetrievalRequestrequest = null;
         Response<CancelRetrievalResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new CancelRetrievalRequestMarshaller().marshall(super.beforeMarshalling(cancelRetrievalRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             Unmarshaller<CancelRetrievalResultJsonUnmarshallerContextunmarshaller =
                 new CancelRetrievalResultJsonUnmarshaller();
             JsonResponseHandler<CancelRetrievalResultresponseHandler =
                 new JsonResponseHandler<CancelRetrievalResult>(unmarshaller);
 
             response = invoke(requestresponseHandlerexecutionContext);
 
             return response.getAwsResponse();
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }

    

This operation returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect.

This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

Parameters:
describeBandwidthRateLimitRequest Container for the necessary parameters to execute the DescribeBandwidthRateLimit service method on AWSStorageGateway.
Returns:
The response from the DescribeBandwidthRateLimit service method, as returned by AWSStorageGateway.
Throws:
com.amazonaws.services.storagegateway.model.InternalServerErrorException
com.amazonaws.services.storagegateway.model.InvalidGatewayRequestException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.
 
         ExecutionContext executionContext = createExecutionContext(describeBandwidthRateLimitRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<DescribeBandwidthRateLimitRequestrequest = null;
         Response<DescribeBandwidthRateLimitResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new DescribeBandwidthRateLimitRequestMarshaller().marshall(super.beforeMarshalling(describeBandwidthRateLimitRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             Unmarshaller<DescribeBandwidthRateLimitResultJsonUnmarshallerContextunmarshaller =
                 new DescribeBandwidthRateLimitResultJsonUnmarshaller();
             JsonResponseHandler<DescribeBandwidthRateLimitResultresponseHandler =
                 new JsonResponseHandler<DescribeBandwidthRateLimitResult>(unmarshaller);
 
             response = invoke(requestresponseHandlerexecutionContext);
 
             return response.getAwsResponse();
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }

    

Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes associated with the specified gateway.

Parameters:
describeTapesRequest Container for the necessary parameters to execute the DescribeTapes service method on AWSStorageGateway.
Returns:
The response from the DescribeTapes service method, as returned by AWSStorageGateway.
Throws:
com.amazonaws.services.storagegateway.model.InternalServerErrorException
com.amazonaws.services.storagegateway.model.InvalidGatewayRequestException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.
 
     public DescribeTapesResult describeTapes(DescribeTapesRequest describeTapesRequest) {
         ExecutionContext executionContext = createExecutionContext(describeTapesRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<DescribeTapesRequestrequest = null;
         Response<DescribeTapesResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new DescribeTapesRequestMarshaller().marshall(super.beforeMarshalling(describeTapesRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             Unmarshaller<DescribeTapesResultJsonUnmarshallerContextunmarshaller =
                 new DescribeTapesResultJsonUnmarshaller();
             JsonResponseHandler<DescribeTapesResultresponseHandler =
                 new JsonResponseHandler<DescribeTapesResult>(unmarshaller);
 
             response = invoke(requestresponseHandlerexecutionContext);
 
             return response.getAwsResponse();
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }

    

Retrieves the recovery point for the specified virtual tape.

A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.

NOTE:The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a gateway-VTL. There is no charge for retrieving recovery points.

Parameters:
retrieveTapeRecoveryPointRequest Container for the necessary parameters to execute the RetrieveTapeRecoveryPoint service method on AWSStorageGateway.
Returns:
The response from the RetrieveTapeRecoveryPoint service method, as returned by AWSStorageGateway.
Throws:
com.amazonaws.services.storagegateway.model.InternalServerErrorException
com.amazonaws.services.storagegateway.model.InvalidGatewayRequestException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.
 
         ExecutionContext executionContext = createExecutionContext(retrieveTapeRecoveryPointRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<RetrieveTapeRecoveryPointRequestrequest = null;
         Response<RetrieveTapeRecoveryPointResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new RetrieveTapeRecoveryPointRequestMarshaller().marshall(super.beforeMarshalling(retrieveTapeRecoveryPointRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             Unmarshaller<RetrieveTapeRecoveryPointResultJsonUnmarshallerContextunmarshaller =
                 new RetrieveTapeRecoveryPointResultJsonUnmarshaller();
             JsonResponseHandler<RetrieveTapeRecoveryPointResultresponseHandler =
                 new JsonResponseHandler<RetrieveTapeRecoveryPointResult>(unmarshaller);
 
             response = invoke(requestresponseHandlerexecutionContext);
 
             return response.getAwsResponse();
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }

    

Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes.

NOTE:Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache operation to add cache storage to a gateway.

Parameters:
createTapesRequest Container for the necessary parameters to execute the CreateTapes service method on AWSStorageGateway.
Returns:
The response from the CreateTapes service method, as returned by AWSStorageGateway.
Throws:
com.amazonaws.services.storagegateway.model.InternalServerErrorException
com.amazonaws.services.storagegateway.model.InvalidGatewayRequestException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.
 
     public CreateTapesResult createTapes(CreateTapesRequest createTapesRequest) {
         ExecutionContext executionContext = createExecutionContext(createTapesRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<CreateTapesRequestrequest = null;
         Response<CreateTapesResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new CreateTapesRequestMarshaller().marshall(super.beforeMarshalling(createTapesRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             Unmarshaller<CreateTapesResultJsonUnmarshallerContextunmarshaller =
                 new CreateTapesResultJsonUnmarshaller();
             JsonResponseHandler<CreateTapesResultresponseHandler =
                 new JsonResponseHandler<CreateTapesResult>(unmarshaller);
 
             response = invoke(requestresponseHandlerexecutionContext);
 
             return response.getAwsResponse();
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }

    

This operation returns information about the upload buffer of a gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures.

The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.

Parameters:
describeUploadBufferRequest Container for the necessary parameters to execute the DescribeUploadBuffer service method on AWSStorageGateway.
Returns:
The response from the DescribeUploadBuffer service method, as returned by AWSStorageGateway.
Throws:
com.amazonaws.services.storagegateway.model.InternalServerErrorException
com.amazonaws.services.storagegateway.model.InvalidGatewayRequestException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.
 
     public DescribeUploadBufferResult describeUploadBuffer(DescribeUploadBufferRequest describeUploadBufferRequest) {
         ExecutionContext executionContext = createExecutionContext(describeUploadBufferRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<DescribeUploadBufferRequestrequest = null;
         Response<DescribeUploadBufferResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new DescribeUploadBufferRequestMarshaller().marshall(super.beforeMarshalling(describeUploadBufferRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             Unmarshaller<DescribeUploadBufferResultJsonUnmarshallerContextunmarshaller =
                 new DescribeUploadBufferResultJsonUnmarshaller();
             JsonResponseHandler<DescribeUploadBufferResultresponseHandler =
                 new JsonResponseHandler<DescribeUploadBufferResult>(unmarshaller);
 
             response = invoke(requestresponseHandlerexecutionContext);
 
             return response.getAwsResponse();
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }

    

This operation deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.

Parameters:
deleteChapCredentialsRequest Container for the necessary parameters to execute the DeleteChapCredentials service method on AWSStorageGateway.
Returns:
The response from the DeleteChapCredentials service method, as returned by AWSStorageGateway.
Throws:
com.amazonaws.services.storagegateway.model.InternalServerErrorException
com.amazonaws.services.storagegateway.model.InvalidGatewayRequestException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.
 
     public DeleteChapCredentialsResult deleteChapCredentials(DeleteChapCredentialsRequest deleteChapCredentialsRequest) {
         ExecutionContext executionContext = createExecutionContext(deleteChapCredentialsRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<DeleteChapCredentialsRequestrequest = null;
         Response<DeleteChapCredentialsResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new DeleteChapCredentialsRequestMarshaller().marshall(super.beforeMarshalling(deleteChapCredentialsRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             Unmarshaller<DeleteChapCredentialsResultJsonUnmarshallerContextunmarshaller =
                new DeleteChapCredentialsResultJsonUnmarshaller();
            JsonResponseHandler<DeleteChapCredentialsResultresponseHandler =
                new JsonResponseHandler<DeleteChapCredentialsResult>(unmarshaller);
            response = invoke(requestresponseHandlerexecutionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }

    

This operation configures one or more gateway local disks as cache for a cached-volume gateway. This operation is supported only for the gateway-cached volume architecture (see Storage Gateway Concepts ).

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.

Parameters:
addCacheRequest Container for the necessary parameters to execute the AddCache service method on AWSStorageGateway.
Returns:
The response from the AddCache service method, as returned by AWSStorageGateway.
Throws:
com.amazonaws.services.storagegateway.model.InternalServerErrorException
com.amazonaws.services.storagegateway.model.InvalidGatewayRequestException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.
    public AddCacheResult addCache(AddCacheRequest addCacheRequest) {
        ExecutionContext executionContext = createExecutionContext(addCacheRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<AddCacheRequestrequest = null;
        Response<AddCacheResultresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new AddCacheRequestMarshaller().marshall(super.beforeMarshalling(addCacheRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            Unmarshaller<AddCacheResultJsonUnmarshallerContextunmarshaller =
                new AddCacheResultJsonUnmarshaller();
            JsonResponseHandler<AddCacheResultresponseHandler =
                new JsonResponseHandler<AddCacheResult>(unmarshaller);
            response = invoke(requestresponseHandlerexecutionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }

    

This operation returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

Parameters:
describeGatewayInformationRequest Container for the necessary parameters to execute the DescribeGatewayInformation service method on AWSStorageGateway.
Returns:
The response from the DescribeGatewayInformation service method, as returned by AWSStorageGateway.
Throws:
com.amazonaws.services.storagegateway.model.InternalServerErrorException
com.amazonaws.services.storagegateway.model.InvalidGatewayRequestException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.
        ExecutionContext executionContext = createExecutionContext(describeGatewayInformationRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<DescribeGatewayInformationRequestrequest = null;
        Response<DescribeGatewayInformationResultresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new DescribeGatewayInformationRequestMarshaller().marshall(super.beforeMarshalling(describeGatewayInformationRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
                new DescribeGatewayInformationResultJsonUnmarshaller();
            JsonResponseHandler<DescribeGatewayInformationResultresponseHandler =
                new JsonResponseHandler<DescribeGatewayInformationResult>(unmarshaller);
            response = invoke(requestresponseHandlerexecutionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }

    

This operation lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not.

Parameters:
listVolumeInitiatorsRequest Container for the necessary parameters to execute the ListVolumeInitiators service method on AWSStorageGateway.
Returns:
The response from the ListVolumeInitiators service method, as returned by AWSStorageGateway.
Throws:
com.amazonaws.services.storagegateway.model.InternalServerErrorException
com.amazonaws.services.storagegateway.model.InvalidGatewayRequestException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.
    public ListVolumeInitiatorsResult listVolumeInitiators(ListVolumeInitiatorsRequest listVolumeInitiatorsRequest) {
        ExecutionContext executionContext = createExecutionContext(listVolumeInitiatorsRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<ListVolumeInitiatorsRequestrequest = null;
        Response<ListVolumeInitiatorsResultresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new ListVolumeInitiatorsRequestMarshaller().marshall(super.beforeMarshalling(listVolumeInitiatorsRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            Unmarshaller<ListVolumeInitiatorsResultJsonUnmarshallerContextunmarshaller =
                new ListVolumeInitiatorsResultJsonUnmarshaller();
            JsonResponseHandler<ListVolumeInitiatorsResultresponseHandler =
                new JsonResponseHandler<ListVolumeInitiatorsResult>(unmarshaller);
            response = invoke(requestresponseHandlerexecutionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }

    

This operation returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request.

The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a DiskStatus field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted).

Parameters:
listLocalDisksRequest Container for the necessary parameters to execute the ListLocalDisks service method on AWSStorageGateway.
Returns:
The response from the ListLocalDisks service method, as returned by AWSStorageGateway.
Throws:
com.amazonaws.services.storagegateway.model.InternalServerErrorException
com.amazonaws.services.storagegateway.model.InvalidGatewayRequestException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.
    public ListLocalDisksResult listLocalDisks(ListLocalDisksRequest listLocalDisksRequest) {
        ExecutionContext executionContext = createExecutionContext(listLocalDisksRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<ListLocalDisksRequestrequest = null;
        Response<ListLocalDisksResultresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new ListLocalDisksRequestMarshaller().marshall(super.beforeMarshalling(listLocalDisksRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            Unmarshaller<ListLocalDisksResultJsonUnmarshallerContextunmarshaller =
                new ListLocalDisksResultJsonUnmarshaller();
            JsonResponseHandler<ListLocalDisksResultresponseHandler =
                new JsonResponseHandler<ListLocalDisksResult>(unmarshaller);
            response = invoke(requestresponseHandlerexecutionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }

    

This operation returns information about the cache of a gateway. This operation is supported only for the gateway-cached volume architecture.

The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.

Parameters:
describeCacheRequest Container for the necessary parameters to execute the DescribeCache service method on AWSStorageGateway.
Returns:
The response from the DescribeCache service method, as returned by AWSStorageGateway.
Throws:
com.amazonaws.services.storagegateway.model.InternalServerErrorException
com.amazonaws.services.storagegateway.model.InvalidGatewayRequestException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.
    public DescribeCacheResult describeCache(DescribeCacheRequest describeCacheRequest) {
        ExecutionContext executionContext = createExecutionContext(describeCacheRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<DescribeCacheRequestrequest = null;
        Response<DescribeCacheResultresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new DescribeCacheRequestMarshaller().marshall(super.beforeMarshalling(describeCacheRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            Unmarshaller<DescribeCacheResultJsonUnmarshallerContextunmarshaller =
                new DescribeCacheResultJsonUnmarshaller();
            JsonResponseHandler<DescribeCacheResultresponseHandler =
                new JsonResponseHandler<DescribeCacheResult>(unmarshaller);
            response = invoke(requestresponseHandlerexecutionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }

    

Disables a gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.

Use this operation for a gateway-VTL that is not reachable or not functioning.

IMPORTANT:Once a gateway is disabled it cannot be enabled.

Parameters:
disableGatewayRequest Container for the necessary parameters to execute the DisableGateway service method on AWSStorageGateway.
Returns:
The response from the DisableGateway service method, as returned by AWSStorageGateway.
Throws:
com.amazonaws.services.storagegateway.model.InternalServerErrorException
com.amazonaws.services.storagegateway.model.InvalidGatewayRequestException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.
    public DisableGatewayResult disableGateway(DisableGatewayRequest disableGatewayRequest) {
        ExecutionContext executionContext = createExecutionContext(disableGatewayRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<DisableGatewayRequestrequest = null;
        Response<DisableGatewayResultresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new DisableGatewayRequestMarshaller().marshall(super.beforeMarshalling(disableGatewayRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            Unmarshaller<DisableGatewayResultJsonUnmarshallerContextunmarshaller =
                new DisableGatewayResultJsonUnmarshaller();
            JsonResponseHandler<DisableGatewayResultresponseHandler =
                new JsonResponseHandler<DisableGatewayResult>(unmarshaller);
            response = invoke(requestresponseHandlerexecutionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }

    

Deletes the specified virtual tape.

Parameters:
deleteTapeRequest Container for the necessary parameters to execute the DeleteTape service method on AWSStorageGateway.
Returns:
The response from the DeleteTape service method, as returned by AWSStorageGateway.
Throws:
com.amazonaws.services.storagegateway.model.InternalServerErrorException
com.amazonaws.services.storagegateway.model.InvalidGatewayRequestException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.
    public DeleteTapeResult deleteTape(DeleteTapeRequest deleteTapeRequest) {
        ExecutionContext executionContext = createExecutionContext(deleteTapeRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<DeleteTapeRequestrequest = null;
        Response<DeleteTapeResultresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new DeleteTapeRequestMarshaller().marshall(super.beforeMarshalling(deleteTapeRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            Unmarshaller<DeleteTapeResultJsonUnmarshallerContextunmarshaller =
                new DeleteTapeResultJsonUnmarshaller();
            JsonResponseHandler<DeleteTapeResultresponseHandler =
                new JsonResponseHandler<DeleteTapeResult>(unmarshaller);
            response = invoke(requestresponseHandlerexecutionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }

    

This operation starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups.

NOTE:When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any additional API calls. For more information, see ActivateGateway.

To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.

Parameters:
startGatewayRequest Container for the necessary parameters to execute the StartGateway service method on AWSStorageGateway.
Returns:
The response from the StartGateway service method, as returned by AWSStorageGateway.
Throws:
com.amazonaws.services.storagegateway.model.InternalServerErrorException
com.amazonaws.services.storagegateway.model.InvalidGatewayRequestException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.
    public StartGatewayResult startGateway(StartGatewayRequest startGatewayRequest) {
        ExecutionContext executionContext = createExecutionContext(startGatewayRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<StartGatewayRequestrequest = null;
        Response<StartGatewayResultresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new StartGatewayRequestMarshaller().marshall(super.beforeMarshalling(startGatewayRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            Unmarshaller<StartGatewayResultJsonUnmarshallerContextunmarshaller =
                new StartGatewayResultJsonUnmarshaller();
            JsonResponseHandler<StartGatewayResultresponseHandler =
                new JsonResponseHandler<StartGatewayResult>(unmarshaller);
            response = invoke(requestresponseHandlerexecutionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }

    

This operation initiates a snapshot of a gateway from a volume recovery point. This operation is supported only for the gateway-cached volume architecture (see ).

A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for gateway-cached volumes, use ListVolumeRecoveryPoints.

In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When AWS Storage Gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.

NOTE: To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference.

Parameters:
createSnapshotFromVolumeRecoveryPointRequest Container for the necessary parameters to execute the CreateSnapshotFromVolumeRecoveryPoint service method on AWSStorageGateway.
Returns:
The response from the CreateSnapshotFromVolumeRecoveryPoint service method, as returned by AWSStorageGateway.
Throws:
com.amazonaws.services.storagegateway.model.InternalServerErrorException
com.amazonaws.services.storagegateway.model.InvalidGatewayRequestException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.
        ExecutionContext executionContext = createExecutionContext(createSnapshotFromVolumeRecoveryPointRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<CreateSnapshotFromVolumeRecoveryPointRequestrequest = null;
        Response<CreateSnapshotFromVolumeRecoveryPointResultresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new CreateSnapshotFromVolumeRecoveryPointRequestMarshaller().marshall(super.beforeMarshalling(createSnapshotFromVolumeRecoveryPointRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            JsonResponseHandler<CreateSnapshotFromVolumeRecoveryPointResultresponseHandler =
                new JsonResponseHandler<CreateSnapshotFromVolumeRecoveryPointResult>(unmarshaller);
            response = invoke(requestresponseHandlerexecutionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }

    

This operation creates a cached volume on a specified cached gateway. This operation is supported only for the gateway-cached volume architecture.

NOTE:Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway.

In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, AWS Storage Gateway creates the volume and returns information about it such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

Parameters:
createCachediSCSIVolumeRequest Container for the necessary parameters to execute the CreateCachediSCSIVolume service method on AWSStorageGateway.
Returns:
The response from the CreateCachediSCSIVolume service method, as returned by AWSStorageGateway.
Throws:
com.amazonaws.services.storagegateway.model.InternalServerErrorException
com.amazonaws.services.storagegateway.model.InvalidGatewayRequestException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.
        ExecutionContext executionContext = createExecutionContext(createCachediSCSIVolumeRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<CreateCachediSCSIVolumeRequestrequest = null;
        Response<CreateCachediSCSIVolumeResultresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new CreateCachediSCSIVolumeRequestMarshaller().marshall(super.beforeMarshalling(createCachediSCSIVolumeRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            Unmarshaller<CreateCachediSCSIVolumeResultJsonUnmarshallerContextunmarshaller =
                new CreateCachediSCSIVolumeResultJsonUnmarshaller();
            JsonResponseHandler<CreateCachediSCSIVolumeResultresponseHandler =
                new JsonResponseHandler<CreateCachediSCSIVolumeResult>(unmarshaller);
            response = invoke(requestresponseHandlerexecutionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }

    

This operation shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.

The operation shuts down the gateway service component running in the storage gateway's virtual machine (VM) and not the VM.

NOTE:If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.

After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.

NOTE:When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway.

If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.

Parameters:
shutdownGatewayRequest Container for the necessary parameters to execute the ShutdownGateway service method on AWSStorageGateway.
Returns:
The response from the ShutdownGateway service method, as returned by AWSStorageGateway.
Throws:
com.amazonaws.services.storagegateway.model.InternalServerErrorException
com.amazonaws.services.storagegateway.model.InvalidGatewayRequestException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.
    public ShutdownGatewayResult shutdownGateway(ShutdownGatewayRequest shutdownGatewayRequest) {
        ExecutionContext executionContext = createExecutionContext(shutdownGatewayRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<ShutdownGatewayRequestrequest = null;
        Response<ShutdownGatewayResultresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new ShutdownGatewayRequestMarshaller().marshall(super.beforeMarshalling(shutdownGatewayRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            Unmarshaller<ShutdownGatewayResultJsonUnmarshallerContextunmarshaller =
                new ShutdownGatewayResultJsonUnmarshaller();
            JsonResponseHandler<ShutdownGatewayResultresponseHandler =
                new JsonResponseHandler<ShutdownGatewayResult>(unmarshaller);
            response = invoke(requestresponseHandlerexecutionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }

    

Returns a list of virtual tape recovery points that are available for the specified gateway-VTL.

A recovery point is a point in time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.

Parameters:
describeTapeRecoveryPointsRequest Container for the necessary parameters to execute the DescribeTapeRecoveryPoints service method on AWSStorageGateway.
Returns:
The response from the DescribeTapeRecoveryPoints service method, as returned by AWSStorageGateway.
Throws:
com.amazonaws.services.storagegateway.model.InternalServerErrorException
com.amazonaws.services.storagegateway.model.InvalidGatewayRequestException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSStorageGateway indicating either a problem with the data in the request, or a server side issue.
        ExecutionContext executionContext = createExecutionContext(describeTapeRecoveryPointsRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<DescribeTapeRecoveryPointsRequestrequest = null;
        Response<DescribeTapeRecoveryPointsResultresponse = null;