@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSStorageGateway
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSStorageGateway instead.
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 the Amazon Web Services storage infrastructure. The service enables you to securely upload data to the Amazon Web Services Cloud for cost effective backup and rapid disaster recovery.
Use the following links to get started using the Storage Gateway Service API Reference:
Storage Gateway required request headers: Describes the required headers that you must send with every POST request to Storage Gateway.
Signing requests: Storage Gateway requires that you authenticate every request you send; this topic describes how sign such a request.
Error responses: Provides reference information about Storage Gateway errors.
Operations in Storage Gateway: Contains detailed descriptions of all Storage Gateway operations, their request parameters, response elements, possible errors, and examples of requests and responses.
Storage Gateway endpoints and quotas: Provides a list of each Amazon Web Services Region and the endpoints available for use with Storage Gateway.
Storage Gateway resource IDs are in uppercase. When you use these resource IDs with the Amazon EC2 API, EC2 expects
resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For example, in
Storage Gateway the ID for a volume might be vol-AA22BB012345DAF670. When you use this ID with the EC2
API, you must change it to vol-aa22bb012345daf670. Otherwise, the EC2 API might not behave as expected.
IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes are changing to a longer format. Starting in December 2016, all new volumes and snapshots will be created with a 17-character string. Starting in April 2016, you will be able to use these longer IDs so you can test your systems with the new format. For more information, see Longer EC2 and EBS resource IDs.
For example, a volume Amazon Resource Name (ARN) with the longer volume ID format looks like the following:
arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.
A snapshot ID with the longer ID format looks like the following: snap-78e226633445566ee.
For more information, see Announcement: Heads-up – Longer Storage Gateway volume and snapshot IDs coming in 2016.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
ActivateGatewayResult |
activateGateway(ActivateGatewayRequest activateGatewayRequest)
Activates the gateway you previously deployed on your host.
|
AddCacheResult |
addCache(AddCacheRequest addCacheRequest)
Configures one or more gateway local disks as cache for a gateway.
|
AddTagsToResourceResult |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds one or more tags to the specified resource.
|
AddUploadBufferResult |
addUploadBuffer(AddUploadBufferRequest addUploadBufferRequest)
Configures one or more gateway local disks as upload buffer for a specified gateway.
|
AddWorkingStorageResult |
addWorkingStorage(AddWorkingStorageRequest addWorkingStorageRequest)
Configures one or more gateway local disks as working storage for a gateway.
|
AssignTapePoolResult |
assignTapePool(AssignTapePoolRequest assignTapePoolRequest)
Assigns a tape to a tape pool for archiving.
|
AssociateFileSystemResult |
associateFileSystem(AssociateFileSystemRequest associateFileSystemRequest)
Associate an Amazon FSx file system with the FSx File Gateway.
|
AttachVolumeResult |
attachVolume(AttachVolumeRequest attachVolumeRequest)
Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway.
|
CancelArchivalResult |
cancelArchival(CancelArchivalRequest cancelArchivalRequest)
Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.
|
CancelRetrievalResult |
cancelRetrieval(CancelRetrievalRequest cancelRetrievalRequest)
Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is
initiated.
|
CreateCachediSCSIVolumeResult |
createCachediSCSIVolume(CreateCachediSCSIVolumeRequest createCachediSCSIVolumeRequest)
Creates a cached volume on a specified cached volume gateway.
|
CreateNFSFileShareResult |
createNFSFileShare(CreateNFSFileShareRequest createNFSFileShareRequest)
Creates a Network File System (NFS) file share on an existing S3 File Gateway.
|
CreateSMBFileShareResult |
createSMBFileShare(CreateSMBFileShareRequest createSMBFileShareRequest)
Creates a Server Message Block (SMB) file share on an existing S3 File Gateway.
|
CreateSnapshotResult |
createSnapshot(CreateSnapshotRequest createSnapshotRequest)
Initiates a snapshot of a volume.
|
CreateSnapshotFromVolumeRecoveryPointResult |
createSnapshotFromVolumeRecoveryPoint(CreateSnapshotFromVolumeRecoveryPointRequest createSnapshotFromVolumeRecoveryPointRequest)
Initiates a snapshot of a gateway from a volume recovery point.
|
CreateStorediSCSIVolumeResult |
createStorediSCSIVolume(CreateStorediSCSIVolumeRequest createStorediSCSIVolumeRequest)
Creates a volume on a specified gateway.
|
CreateTapePoolResult |
createTapePool(CreateTapePoolRequest createTapePoolRequest)
Creates a new custom tape pool.
|
CreateTapesResult |
createTapes(CreateTapesRequest createTapesRequest)
Creates one or more virtual tapes.
|
CreateTapeWithBarcodeResult |
createTapeWithBarcode(CreateTapeWithBarcodeRequest createTapeWithBarcodeRequest)
Creates a virtual tape by using your own barcode.
|
DeleteAutomaticTapeCreationPolicyResult |
deleteAutomaticTapeCreationPolicy(DeleteAutomaticTapeCreationPolicyRequest deleteAutomaticTapeCreationPolicyRequest)
Deletes the automatic tape creation policy of a gateway.
|
DeleteBandwidthRateLimitResult |
deleteBandwidthRateLimit(DeleteBandwidthRateLimitRequest deleteBandwidthRateLimitRequest)
Deletes the bandwidth rate limits of a gateway.
|
DeleteChapCredentialsResult |
deleteChapCredentials(DeleteChapCredentialsRequest deleteChapCredentialsRequest)
Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator
pair.
|
DeleteFileShareResult |
deleteFileShare(DeleteFileShareRequest deleteFileShareRequest)
Deletes a file share from an S3 File Gateway.
|
DeleteGatewayResult |
deleteGateway(DeleteGatewayRequest deleteGatewayRequest)
Deletes a gateway.
|
DeleteSnapshotScheduleResult |
deleteSnapshotSchedule(DeleteSnapshotScheduleRequest deleteSnapshotScheduleRequest)
Deletes a snapshot of a volume.
|
DeleteTapeResult |
deleteTape(DeleteTapeRequest deleteTapeRequest)
Deletes the specified virtual tape.
|
DeleteTapeArchiveResult |
deleteTapeArchive(DeleteTapeArchiveRequest deleteTapeArchiveRequest)
Deletes the specified virtual tape from the virtual tape shelf (VTS).
|
DeleteTapePoolResult |
deleteTapePool(DeleteTapePoolRequest deleteTapePoolRequest)
Delete a custom tape pool.
|
DeleteVolumeResult |
deleteVolume(DeleteVolumeRequest deleteVolumeRequest)
Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or
CreateStorediSCSIVolume API.
|
DescribeAvailabilityMonitorTestResult |
describeAvailabilityMonitorTest(DescribeAvailabilityMonitorTestRequest describeAvailabilityMonitorTestRequest)
Returns information about the most recent high availability monitoring test that was performed on the host in a
cluster.
|
DescribeBandwidthRateLimitResult |
describeBandwidthRateLimit(DescribeBandwidthRateLimitRequest describeBandwidthRateLimitRequest)
Returns the bandwidth rate limits of a gateway.
|
DescribeBandwidthRateLimitScheduleResult |
describeBandwidthRateLimitSchedule(DescribeBandwidthRateLimitScheduleRequest describeBandwidthRateLimitScheduleRequest)
Returns information about the bandwidth rate limit schedule of a gateway.
|
DescribeCacheResult |
describeCache(DescribeCacheRequest describeCacheRequest)
Returns information about the cache of a gateway.
|
DescribeCachediSCSIVolumesResult |
describeCachediSCSIVolumes(DescribeCachediSCSIVolumesRequest describeCachediSCSIVolumesRequest)
Returns a description of the gateway volumes specified in the request.
|
DescribeChapCredentialsResult |
describeChapCredentials(DescribeChapCredentialsRequest describeChapCredentialsRequest)
Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified
iSCSI target, one for each target-initiator pair.
|
DescribeFileSystemAssociationsResult |
describeFileSystemAssociations(DescribeFileSystemAssociationsRequest describeFileSystemAssociationsRequest)
Gets the file system association information.
|
DescribeGatewayInformationResult |
describeGatewayInformation(DescribeGatewayInformationRequest describeGatewayInformationRequest)
Returns metadata about a gateway such as its name, network interfaces, time zone, status, and software version.
|
DescribeMaintenanceStartTimeResult |
describeMaintenanceStartTime(DescribeMaintenanceStartTimeRequest describeMaintenanceStartTimeRequest)
Returns your gateway's weekly maintenance start time including the day and time of the week.
|
DescribeNFSFileSharesResult |
describeNFSFileShares(DescribeNFSFileSharesRequest describeNFSFileSharesRequest)
Gets a description for one or more Network File System (NFS) file shares from an S3 File Gateway.
|
DescribeSMBFileSharesResult |
describeSMBFileShares(DescribeSMBFileSharesRequest describeSMBFileSharesRequest)
Gets a description for one or more Server Message Block (SMB) file shares from a S3 File Gateway.
|
DescribeSMBSettingsResult |
describeSMBSettings(DescribeSMBSettingsRequest describeSMBSettingsRequest)
Gets a description of a Server Message Block (SMB) file share settings from a file gateway.
|
DescribeSnapshotScheduleResult |
describeSnapshotSchedule(DescribeSnapshotScheduleRequest describeSnapshotScheduleRequest)
Describes the snapshot schedule for the specified gateway volume.
|
DescribeStorediSCSIVolumesResult |
describeStorediSCSIVolumes(DescribeStorediSCSIVolumesRequest describeStorediSCSIVolumesRequest)
Returns the description of the gateway volumes specified in the request.
|
DescribeTapeArchivesResult |
describeTapeArchives()
Simplified method form for invoking the DescribeTapeArchives operation.
|
DescribeTapeArchivesResult |
describeTapeArchives(DescribeTapeArchivesRequest describeTapeArchivesRequest)
Returns a description of specified virtual tapes in the virtual tape shelf (VTS).
|
DescribeTapeRecoveryPointsResult |
describeTapeRecoveryPoints(DescribeTapeRecoveryPointsRequest describeTapeRecoveryPointsRequest)
Returns a list of virtual tape recovery points that are available for the specified tape gateway.
|
DescribeTapesResult |
describeTapes(DescribeTapesRequest describeTapesRequest)
Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes.
|
DescribeUploadBufferResult |
describeUploadBuffer(DescribeUploadBufferRequest describeUploadBufferRequest)
Returns information about the upload buffer of a gateway.
|
DescribeVTLDevicesResult |
describeVTLDevices(DescribeVTLDevicesRequest describeVTLDevicesRequest)
Returns a description of virtual tape library (VTL) devices for the specified tape gateway.
|
DescribeWorkingStorageResult |
describeWorkingStorage(DescribeWorkingStorageRequest describeWorkingStorageRequest)
Returns information about the working storage of a gateway.
|
DetachVolumeResult |
detachVolume(DetachVolumeRequest detachVolumeRequest)
Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway.
|
DisableGatewayResult |
disableGateway(DisableGatewayRequest disableGatewayRequest)
Disables a tape gateway when the gateway is no longer functioning.
|
DisassociateFileSystemResult |
disassociateFileSystem(DisassociateFileSystemRequest disassociateFileSystemRequest)
Disassociates an Amazon FSx file system from the specified gateway.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
JoinDomainResult |
joinDomain(JoinDomainRequest joinDomainRequest)
Adds a file gateway to an Active Directory domain.
|
ListAutomaticTapeCreationPoliciesResult |
listAutomaticTapeCreationPolicies(ListAutomaticTapeCreationPoliciesRequest listAutomaticTapeCreationPoliciesRequest)
Lists the automatic tape creation policies for a gateway.
|
ListFileSharesResult |
listFileShares(ListFileSharesRequest listFileSharesRequest)
Gets a list of the file shares for a specific S3 File Gateway, or the list of file shares that belong to the
calling Amazon Web Services account.
|
ListFileSystemAssociationsResult |
listFileSystemAssociations(ListFileSystemAssociationsRequest listFileSystemAssociationsRequest)
Gets a list of
FileSystemAssociationSummary objects. |
ListGatewaysResult |
listGateways()
Simplified method form for invoking the ListGateways operation.
|
ListGatewaysResult |
listGateways(ListGatewaysRequest listGatewaysRequest)
Lists gateways owned by an Amazon Web Services account in an Amazon Web Services Region specified in the request.
|
ListLocalDisksResult |
listLocalDisks(ListLocalDisksRequest listLocalDisksRequest)
Returns a list of the gateway's local disks.
|
ListTagsForResourceResult |
listTagsForResource()
Simplified method form for invoking the ListTagsForResource operation.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags that have been added to the specified resource.
|
ListTapePoolsResult |
listTapePools(ListTapePoolsRequest listTapePoolsRequest)
Lists custom tape pools.
|
ListTapesResult |
listTapes(ListTapesRequest listTapesRequest)
Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS).
|
ListVolumeInitiatorsResult |
listVolumeInitiators(ListVolumeInitiatorsRequest listVolumeInitiatorsRequest)
Lists iSCSI initiators that are connected to a volume.
|
ListVolumeRecoveryPointsResult |
listVolumeRecoveryPoints(ListVolumeRecoveryPointsRequest listVolumeRecoveryPointsRequest)
Lists the recovery points for a specified gateway.
|
ListVolumesResult |
listVolumes(ListVolumesRequest listVolumesRequest)
Lists the iSCSI stored volumes of a gateway.
|
NotifyWhenUploadedResult |
notifyWhenUploaded(NotifyWhenUploadedRequest notifyWhenUploadedRequest)
Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to
S3.
|
RefreshCacheResult |
refreshCache(RefreshCacheRequest refreshCacheRequest)
Refreshes the cached inventory of objects for the specified file share.
|
RemoveTagsFromResourceResult |
removeTagsFromResource()
Simplified method form for invoking the RemoveTagsFromResource operation.
|
RemoveTagsFromResourceResult |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes one or more tags from the specified resource.
|
ResetCacheResult |
resetCache(ResetCacheRequest resetCacheRequest)
Resets all cache disks that have encountered an error and makes the disks available for reconfiguration as cache
storage.
|
RetrieveTapeArchiveResult |
retrieveTapeArchive(RetrieveTapeArchiveRequest retrieveTapeArchiveRequest)
Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway.
|
RetrieveTapeRecoveryPointResult |
retrieveTapeRecoveryPoint(RetrieveTapeRecoveryPointRequest retrieveTapeRecoveryPointRequest)
Retrieves the recovery point for the specified virtual tape.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
SetLocalConsolePasswordResult |
setLocalConsolePassword(SetLocalConsolePasswordRequest setLocalConsolePasswordRequest)
Sets the password for your VM local console.
|
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
SetSMBGuestPasswordResult |
setSMBGuestPassword(SetSMBGuestPasswordRequest setSMBGuestPasswordRequest)
Sets the password for the guest user
smbguest. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
ShutdownGatewayResult |
shutdownGateway(ShutdownGatewayRequest shutdownGatewayRequest)
Shuts down a gateway.
|
StartAvailabilityMonitorTestResult |
startAvailabilityMonitorTest(StartAvailabilityMonitorTestRequest startAvailabilityMonitorTestRequest)
Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host
environment.
|
StartGatewayResult |
startGateway(StartGatewayRequest startGatewayRequest)
Starts a gateway that you previously shut down (see ShutdownGateway).
|
UpdateAutomaticTapeCreationPolicyResult |
updateAutomaticTapeCreationPolicy(UpdateAutomaticTapeCreationPolicyRequest updateAutomaticTapeCreationPolicyRequest)
Updates the automatic tape creation policy of a gateway.
|
UpdateBandwidthRateLimitResult |
updateBandwidthRateLimit(UpdateBandwidthRateLimitRequest updateBandwidthRateLimitRequest)
Updates the bandwidth rate limits of a gateway.
|
UpdateBandwidthRateLimitScheduleResult |
updateBandwidthRateLimitSchedule(UpdateBandwidthRateLimitScheduleRequest updateBandwidthRateLimitScheduleRequest)
Updates the bandwidth rate limit schedule for a specified gateway.
|
UpdateChapCredentialsResult |
updateChapCredentials(UpdateChapCredentialsRequest updateChapCredentialsRequest)
Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target.
|
UpdateFileSystemAssociationResult |
updateFileSystemAssociation(UpdateFileSystemAssociationRequest updateFileSystemAssociationRequest)
Updates a file system association.
|
UpdateGatewayInformationResult |
updateGatewayInformation(UpdateGatewayInformationRequest updateGatewayInformationRequest)
Updates a gateway's metadata, which includes the gateway's name and time zone.
|
UpdateGatewaySoftwareNowResult |
updateGatewaySoftwareNow(UpdateGatewaySoftwareNowRequest updateGatewaySoftwareNowRequest)
Updates the gateway virtual machine (VM) software.
|
UpdateMaintenanceStartTimeResult |
updateMaintenanceStartTime(UpdateMaintenanceStartTimeRequest updateMaintenanceStartTimeRequest)
Updates a gateway's weekly maintenance start time information, including day and time of the week.
|
UpdateNFSFileShareResult |
updateNFSFileShare(UpdateNFSFileShareRequest updateNFSFileShareRequest)
Updates a Network File System (NFS) file share.
|
UpdateSMBFileShareResult |
updateSMBFileShare(UpdateSMBFileShareRequest updateSMBFileShareRequest)
Updates a Server Message Block (SMB) file share.
|
UpdateSMBFileShareVisibilityResult |
updateSMBFileShareVisibility(UpdateSMBFileShareVisibilityRequest updateSMBFileShareVisibilityRequest)
Controls whether the shares on an S3 File Gateway are visible in a net view or browse list.
|
UpdateSMBLocalGroupsResult |
updateSMBLocalGroups(UpdateSMBLocalGroupsRequest updateSMBLocalGroupsRequest)
Updates the list of Active Directory users and groups that have special permissions for SMB file shares on the
gateway.
|
UpdateSMBSecurityStrategyResult |
updateSMBSecurityStrategy(UpdateSMBSecurityStrategyRequest updateSMBSecurityStrategyRequest)
Updates the SMB security strategy on a file gateway.
|
UpdateSnapshotScheduleResult |
updateSnapshotSchedule(UpdateSnapshotScheduleRequest updateSnapshotScheduleRequest)
Updates a snapshot schedule configured for a gateway volume.
|
UpdateVTLDeviceTypeResult |
updateVTLDeviceType(UpdateVTLDeviceTypeRequest updateVTLDeviceTypeRequest)
Updates the type of medium changer in a tape gateway.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
Callers can pass in just the endpoint (ex: "storagegateway.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "https://storagegateway.us-east-1.amazonaws.com"). If the protocol is not specified here, the
default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint - The endpoint (ex: "storagegateway.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://storagegateway.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will
communicate with.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)setEndpoint(String), sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)ActivateGatewayResult activateGateway(ActivateGatewayRequest activateGatewayRequest)
Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the Amazon Web Services Region that you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account. For more information, see UpdateGatewayInformation.
You must turn on the gateway VM before you can activate your gateway.
activateGatewayRequest - A JSON object containing one or more of the following fields:
InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
ActivateGatewayRequest request = new ActivateGatewayRequest().withActivationKey("29AV1-3OFV9-VVIUB-NKT0I-LRO6V").withGatewayName("My_Gateway")
.withGatewayTimezone("GMT-12:00").withGatewayRegion("us-east-1").withGatewayType("STORED").withTapeDriveType("IBM-ULT3580-TD5")
.withMediumChangerType("AWS-Gateway-VTL");
ActivateGatewayResult response = client.activateGateway(request);AddCacheResult addCache(AddCacheRequest addCacheRequest)
Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape, and file gateway type (see How Storage Gateway works (architecture).
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.
addCacheRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
AddCacheRequest request = new AddCacheRequest().withGatewayARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B").withDiskIds(
"pci-0000:03:00.0-scsi-0:0:0:0", "pci-0000:03:00.0-scsi-0:0:1:0");
AddCacheResult response = client.addCache(request);AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following Storage Gateway resources:
Storage gateways of all types
Storage volumes
Virtual tapes
NFS and SMB file shares
File System associations
You can create a maximum of 50 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags.
addTagsToResourceRequest - AddTagsToResourceInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
AddTagsToResourceRequest request = new AddTagsToResourceRequest().withResourceARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B")
.withTags(new Tag().withKey("Dev Gatgeway Region").withValue("East Coast"));
AddTagsToResourceResult response = client.addTagsToResource(request);AddUploadBufferResult addUploadBuffer(AddUploadBufferRequest addUploadBufferRequest)
Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for the stored volume, cached volume, and tape gateway types.
In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer.
addUploadBufferRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
AddUploadBufferRequest request = new AddUploadBufferRequest().withGatewayARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B")
.withDiskIds("pci-0000:03:00.0-scsi-0:0:0:0", "pci-0000:03:00.0-scsi-0:0:1:0");
AddUploadBufferResult response = client.addUploadBuffer(request);AddWorkingStorageResult addWorkingStorage(AddWorkingStorageRequest addWorkingStorageRequest)
Configures one or more gateway local disks as working storage for a gateway. This operation is only supported in the stored volume gateway type. This operation is deprecated in cached volume API version 20120630. Use AddUploadBuffer instead.
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.
addWorkingStorageRequest - A JSON object containing one or more of the following fields:
InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
AddWorkingStorageRequest request = new AddWorkingStorageRequest().withGatewayARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B")
.withDiskIds("pci-0000:03:00.0-scsi-0:0:0:0", "pci-0000:03:00.0-scsi-0:0:1:0");
AddWorkingStorageResult response = client.addWorkingStorage(request);AssignTapePoolResult assignTapePool(AssignTapePoolRequest assignTapePoolRequest)
Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
assignTapePoolRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AssociateFileSystemResult associateFileSystem(AssociateFileSystemRequest associateFileSystemRequest)
Associate an Amazon FSx file system with the FSx File Gateway. After the association process is complete, the file shares on the Amazon FSx file system are available for access through the gateway. This operation only supports the FSx File Gateway type.
associateFileSystemRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AttachVolumeResult attachVolume(AttachVolumeRequest attachVolumeRequest)
Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance.
attachVolumeRequest - AttachVolumeInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.CancelArchivalResult cancelArchival(CancelArchivalRequest cancelArchivalRequest)
Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. This operation is only supported in the tape gateway type.
cancelArchivalRequest - CancelArchivalInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
CancelArchivalRequest request = new CancelArchivalRequest().withGatewayARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B")
.withTapeARN("arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4");
CancelArchivalResult response = client.cancelArchival(request);CancelRetrievalResult cancelRetrieval(CancelRetrievalRequest cancelRetrievalRequest)
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. This operation is only supported in the tape gateway type.
cancelRetrievalRequest - CancelRetrievalInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
CancelRetrievalRequest request = new CancelRetrievalRequest().withGatewayARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B")
.withTapeARN("arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4");
CancelRetrievalResult response = client.cancelRetrieval(request);CreateCachediSCSIVolumeResult createCachediSCSIVolume(CreateCachediSCSIVolumeRequest createCachediSCSIVolumeRequest)
Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type.
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, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.
Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached
volume, which creates an exact copy of the existing volume’s latest recovery point. The
VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes.
createCachediSCSIVolumeRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
CreateCachediSCSIVolumeRequest request = new CreateCachediSCSIVolumeRequest()
.withGatewayARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B").withVolumeSizeInBytes(536870912000L)
.withSnapshotId("snap-f47b7b94").withTargetName("my-volume").withNetworkInterfaceId("10.1.1.1").withClientToken("cachedvol112233");
CreateCachediSCSIVolumeResult response = client.createCachediSCSIVolume(request);CreateNFSFileShareResult createNFSFileShare(CreateNFSFileShareRequest createNFSFileShareRequest)
Creates a Network File System (NFS) file share on an existing S3 File Gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using an NFS interface. This operation is only supported for S3 File Gateways.
S3 File gateway requires Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your S3 File Gateway in. If Amazon Web Services STS is not activated in the Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region in the Identity and Access Management User Guide.
S3 File Gateways do not support creating hard or symbolic links on a file share.
createNFSFileShareRequest - CreateNFSFileShareInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.CreateSMBFileShareResult createSMBFileShare(CreateSMBFileShareRequest createSMBFileShareRequest)
Creates a Server Message Block (SMB) file share on an existing S3 File Gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using an SMB interface. This operation is only supported for S3 File Gateways.
S3 File Gateways require Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure that Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your S3 File Gateway in. If Amazon Web Services STS is not activated in this Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region in the Identity and Access Management User Guide.
File gateways don't support creating hard or symbolic links on a file share.
createSMBFileShareRequest - CreateSMBFileShareInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.CreateSnapshotResult createSnapshot(CreateSnapshotRequest createSnapshotRequest)
Initiates a snapshot of a volume.
Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (Amazon S3) for durable off-site recovery, and also 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 an ad hoc snapshot. For more information, see Editing a snapshot schedule.
In the CreateSnapshot request, you identify the volume by providing its Amazon Resource Name (ARN).
You must also provide description for the snapshot. When Storage Gateway takes the snapshot of specified volume,
the snapshot and description appears in the Storage Gateway console. In response, 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. This operation is only supported in stored and cached volume gateway type.
To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the Amazon Elastic Compute Cloud API Reference.
Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page.
createSnapshotRequest - A JSON object containing one or more of the following fields:
InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.ServiceUnavailableErrorException - An internal server error has occurred because the service is unavailable. For more information, see the
error and message fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
CreateSnapshotRequest request = new CreateSnapshotRequest().withVolumeARN(
"arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB").withSnapshotDescription(
"My root volume snapshot as of 10/03/2017");
CreateSnapshotResult response = client.createSnapshot(request);CreateSnapshotFromVolumeRecoveryPointResult createSnapshotFromVolumeRecoveryPoint(CreateSnapshotFromVolumeRecoveryPointRequest createSnapshotFromVolumeRecoveryPointRequest)
Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type.
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 cached volume gateway, 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 the gateway takes a
snapshot of the specified volume, the snapshot and its description appear in the Storage Gateway console. In
response, the 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.
To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the Amazon Elastic Compute Cloud API Reference.
createSnapshotFromVolumeRecoveryPointRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.ServiceUnavailableErrorException - An internal server error has occurred because the service is unavailable. For more information, see the
error and message fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
CreateSnapshotFromVolumeRecoveryPointRequest request = new CreateSnapshotFromVolumeRecoveryPointRequest().withVolumeARN(
"arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB").withSnapshotDescription(
"My root volume snapshot as of 2017-06-30T10:10:10.000Z");
CreateSnapshotFromVolumeRecoveryPointResult response = client.createSnapshotFromVolumeRecoveryPoint(request);CreateStorediSCSIVolumeResult createStorediSCSIVolume(CreateStorediSCSIVolumeRequest createStorediSCSIVolumeRequest)
Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway type.
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, the 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.
createStorediSCSIVolumeRequest - A JSON object containing one or more of the following fields:
InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
CreateStorediSCSIVolumeRequest request = new CreateStorediSCSIVolumeRequest()
.withGatewayARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B").withDiskId("pci-0000:03:00.0-scsi-0:0:0:0")
.withSnapshotId("snap-f47b7b94").withPreserveExistingData(true).withTargetName("my-volume").withNetworkInterfaceId("10.1.1.1");
CreateStorediSCSIVolumeResult response = client.createStorediSCSIVolume(request);CreateTapePoolResult createTapePool(CreateTapePoolRequest createTapePoolRequest)
Creates a new custom tape pool. You can use custom tape pool to enable tape retention lock on tapes that are archived in the custom pool.
createTapePoolRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.CreateTapeWithBarcodeResult createTapeWithBarcode(CreateTapeWithBarcodeRequest createTapeWithBarcodeRequest)
Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and cannot be reused if it has already been used on a tape. This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type.
Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.
createTapeWithBarcodeRequest - CreateTapeWithBarcodeInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
CreateTapeWithBarcodeRequest request = new CreateTapeWithBarcodeRequest()
.withGatewayARN("arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B").withTapeSizeInBytes(107374182400L)
.withTapeBarcode("TEST12345");
CreateTapeWithBarcodeResult response = client.createTapeWithBarcode(request);CreateTapesResult createTapes(CreateTapesRequest createTapesRequest)
Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway type.
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.
createTapesRequest - CreateTapesInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
CreateTapesRequest request = new CreateTapesRequest().withGatewayARN("arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B")
.withTapeSizeInBytes(107374182400L).withClientToken("77777").withNumTapesToCreate(3).withTapeBarcodePrefix("TEST");
CreateTapesResult response = client.createTapes(request);DeleteAutomaticTapeCreationPolicyResult deleteAutomaticTapeCreationPolicy(DeleteAutomaticTapeCreationPolicyRequest deleteAutomaticTapeCreationPolicyRequest)
Deletes the automatic tape creation policy of a gateway. If you delete this policy, new virtual tapes must be created manually. Use the Amazon Resource Name (ARN) of the gateway in your request to remove the policy.
deleteAutomaticTapeCreationPolicyRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DeleteBandwidthRateLimitResult deleteBandwidthRateLimit(DeleteBandwidthRateLimitRequest deleteBandwidthRateLimitRequest)
Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request. This operation is supported only for the stored volume, cached volume, and tape gateway types.
deleteBandwidthRateLimitRequest - A JSON object containing the following fields:
InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
DeleteBandwidthRateLimitRequest request = new DeleteBandwidthRateLimitRequest().withGatewayARN(
"arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B").withBandwidthType("All");
DeleteBandwidthRateLimitResult response = client.deleteBandwidthRateLimit(request);DeleteChapCredentialsResult deleteChapCredentials(DeleteChapCredentialsRequest deleteChapCredentialsRequest)
Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair. This operation is supported in volume and tape gateway types.
deleteChapCredentialsRequest - A JSON object containing one or more of the following fields:
InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
DeleteChapCredentialsRequest request = new DeleteChapCredentialsRequest().withTargetARN(
"arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume").withInitiatorName(
"iqn.1991-05.com.microsoft:computername.domain.example.com");
DeleteChapCredentialsResult response = client.deleteChapCredentials(request);DeleteFileShareResult deleteFileShare(DeleteFileShareRequest deleteFileShareRequest)
Deletes a file share from an S3 File Gateway. This operation is only supported for S3 File Gateways.
deleteFileShareRequest - DeleteFileShareInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DeleteGatewayResult deleteGateway(DeleteGatewayRequest deleteGatewayRequest)
Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer.
After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment.
You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription. If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the Storage Gateway detail page.
deleteGatewayRequest - A JSON object containing the ID of the gateway to delete.InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
DeleteGatewayRequest request = new DeleteGatewayRequest().withGatewayARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B");
DeleteGatewayResult response = client.deleteGateway(request);DeleteSnapshotScheduleResult deleteSnapshotSchedule(DeleteSnapshotScheduleRequest deleteSnapshotScheduleRequest)
Deletes a snapshot of a volume.
You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to
delete a snapshot schedule for a volume. For more information, see Backing up your
volumes. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon
Resource Name (ARN). This operation is only supported for cached volume gateway types.
To list or delete a snapshot, you must use the Amazon EC2 API. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.
deleteSnapshotScheduleRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
DeleteSnapshotScheduleRequest request = new DeleteSnapshotScheduleRequest()
.withVolumeARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB");
DeleteSnapshotScheduleResult response = client.deleteSnapshotSchedule(request);DeleteTapeResult deleteTape(DeleteTapeRequest deleteTapeRequest)
Deletes the specified virtual tape. This operation is only supported in the tape gateway type.
deleteTapeRequest - DeleteTapeInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
DeleteTapeRequest request = new DeleteTapeRequest().withGatewayARN("arn:aws:storagegateway:us-east-1:204469490176:gateway/sgw-12A3456B").withTapeARN(
"arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0");
DeleteTapeResult response = client.deleteTape(request);DeleteTapeArchiveResult deleteTapeArchive(DeleteTapeArchiveRequest deleteTapeArchiveRequest)
Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.
deleteTapeArchiveRequest - DeleteTapeArchiveInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
DeleteTapeArchiveRequest request = new DeleteTapeArchiveRequest().withTapeARN("arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0");
DeleteTapeArchiveResult response = client.deleteTapeArchive(request);DeleteTapePoolResult deleteTapePool(DeleteTapePoolRequest deleteTapePoolRequest)
Delete a custom tape pool. A custom tape pool can only be deleted if there are no tapes in the pool and if there are no automatic tape creation policies that reference the custom tape pool.
deleteTapePoolRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DeleteVolumeResult deleteVolume(DeleteVolumeRequest deleteVolumeRequest)
Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This operation is only supported in the cached volume and stored volume types. For stored volume gateways, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume.
Before you delete a volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.
In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete.
deleteVolumeRequest - A JSON object containing the DeleteVolumeInput$VolumeARN to delete.InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
DeleteVolumeRequest request = new DeleteVolumeRequest()
.withVolumeARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB");
DeleteVolumeResult response = client.deleteVolume(request);DescribeAvailabilityMonitorTestResult describeAvailabilityMonitorTest(DescribeAvailabilityMonitorTestRequest describeAvailabilityMonitorTestRequest)
Returns information about the most recent high availability monitoring test that was performed on the host in a cluster. If a test isn't performed, the status and start time in the response would be null.
describeAvailabilityMonitorTestRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DescribeBandwidthRateLimitResult describeBandwidthRateLimit(DescribeBandwidthRateLimitRequest describeBandwidthRateLimitRequest)
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 is supported only for the stored volume, cached volume, and tape gateway types. To describe bandwidth rate limits for S3 file gateways, use DescribeBandwidthRateLimitSchedule.
This operation 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.
describeBandwidthRateLimitRequest - A JSON object containing the Amazon Resource Name (ARN) of the gateway.InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
DescribeBandwidthRateLimitRequest request = new DescribeBandwidthRateLimitRequest()
.withGatewayARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B");
DescribeBandwidthRateLimitResult response = client.describeBandwidthRateLimit(request);DescribeBandwidthRateLimitScheduleResult describeBandwidthRateLimitSchedule(DescribeBandwidthRateLimitScheduleRequest describeBandwidthRateLimitScheduleRequest)
Returns information about the bandwidth rate limit schedule of a gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. This operation is supported only for volume, tape and S3 file gateways. FSx file gateways do not support bandwidth rate limits.
This operation returns information about a gateway's bandwidth rate limit schedule. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.
A bandwidth rate limit interval consists of one or more days of the week, a start hour and minute, an ending hour and minute, and bandwidth rate limits for uploading and downloading
If no bandwidth rate limit schedule intervals are set for the gateway, this operation returns an empty response. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
describeBandwidthRateLimitScheduleRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DescribeCacheResult describeCache(DescribeCacheRequest describeCacheRequest)
Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape, and file gateway types.
The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.
describeCacheRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
DescribeCacheRequest request = new DescribeCacheRequest().withGatewayARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B");
DescribeCacheResult response = client.describeCache(request);DescribeCachediSCSIVolumesResult describeCachediSCSIVolumes(DescribeCachediSCSIVolumesRequest describeCachediSCSIVolumesRequest)
Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types.
The list of gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).
describeCachediSCSIVolumesRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
DescribeCachediSCSIVolumesRequest request = new DescribeCachediSCSIVolumesRequest()
.withVolumeARNs("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB");
DescribeCachediSCSIVolumesResult response = client.describeCachediSCSIVolumes(request);DescribeChapCredentialsResult describeChapCredentials(DescribeChapCredentialsRequest describeChapCredentialsRequest)
Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. This operation is supported in the volume and tape gateway types.
describeChapCredentialsRequest - A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
DescribeChapCredentialsRequest request = new DescribeChapCredentialsRequest()
.withTargetARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume");
DescribeChapCredentialsResult response = client.describeChapCredentials(request);DescribeFileSystemAssociationsResult describeFileSystemAssociations(DescribeFileSystemAssociationsRequest describeFileSystemAssociationsRequest)
Gets the file system association information. This operation is only supported for FSx File Gateways.
describeFileSystemAssociationsRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DescribeGatewayInformationResult describeGatewayInformation(DescribeGatewayInformationRequest describeGatewayInformationRequest)
Returns metadata about a gateway such as its name, network interfaces, time zone, status, and software version. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
describeGatewayInformationRequest - A JSON object containing the ID of the gateway.InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
DescribeGatewayInformationRequest request = new DescribeGatewayInformationRequest()
.withGatewayARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B");
DescribeGatewayInformationResult response = client.describeGatewayInformation(request);DescribeMaintenanceStartTimeResult describeMaintenanceStartTime(DescribeMaintenanceStartTimeRequest describeMaintenanceStartTimeRequest)
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.
describeMaintenanceStartTimeRequest - A JSON object containing the Amazon Resource Name (ARN) of the gateway.InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
DescribeMaintenanceStartTimeRequest request = new DescribeMaintenanceStartTimeRequest()
.withGatewayARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B");
DescribeMaintenanceStartTimeResult response = client.describeMaintenanceStartTime(request);DescribeNFSFileSharesResult describeNFSFileShares(DescribeNFSFileSharesRequest describeNFSFileSharesRequest)
Gets a description for one or more Network File System (NFS) file shares from an S3 File Gateway. This operation is only supported for S3 File Gateways.
describeNFSFileSharesRequest - DescribeNFSFileSharesInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DescribeSMBFileSharesResult describeSMBFileShares(DescribeSMBFileSharesRequest describeSMBFileSharesRequest)
Gets a description for one or more Server Message Block (SMB) file shares from a S3 File Gateway. This operation is only supported for S3 File Gateways.
describeSMBFileSharesRequest - DescribeSMBFileSharesInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DescribeSMBSettingsResult describeSMBSettings(DescribeSMBSettingsRequest describeSMBSettingsRequest)
Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.
describeSMBSettingsRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DescribeSnapshotScheduleResult describeSnapshotSchedule(DescribeSnapshotScheduleRequest describeSnapshotScheduleRequest)
Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. This operation is only supported in the cached volume and stored volume types.
describeSnapshotScheduleRequest - A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the volume.InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
DescribeSnapshotScheduleRequest request = new DescribeSnapshotScheduleRequest()
.withVolumeARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB");
DescribeSnapshotScheduleResult response = client.describeSnapshotSchedule(request);DescribeStorediSCSIVolumesResult describeStorediSCSIVolumes(DescribeStorediSCSIVolumesRequest describeStorediSCSIVolumesRequest)
Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.
describeStorediSCSIVolumesRequest - A JSON object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
DescribeStorediSCSIVolumesRequest request = new DescribeStorediSCSIVolumesRequest()
.withVolumeARNs("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB");
DescribeStorediSCSIVolumesResult response = client.describeStorediSCSIVolumes(request);DescribeTapeArchivesResult describeTapeArchives(DescribeTapeArchivesRequest describeTapeArchivesRequest)
Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.
If a specific TapeARN is not specified, Storage Gateway returns a description of all virtual tapes
found in the VTS associated with your account.
describeTapeArchivesRequest - DescribeTapeArchivesInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
DescribeTapeArchivesRequest request = new DescribeTapeArchivesRequest()
.withTapeARNs("arn:aws:storagegateway:us-east-1:999999999999:tape/AM08A1AD", "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4")
.withMarker("1").withLimit(123);
DescribeTapeArchivesResult response = client.describeTapeArchives(request);DescribeTapeArchivesResult describeTapeArchives()
DescribeTapeRecoveryPointsResult describeTapeRecoveryPoints(DescribeTapeRecoveryPointsRequest describeTapeRecoveryPointsRequest)
Returns a list of virtual tape recovery points that are available for the specified tape gateway.
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. This operation is only supported in the tape gateway type.
describeTapeRecoveryPointsRequest - DescribeTapeRecoveryPointsInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
DescribeTapeRecoveryPointsRequest request = new DescribeTapeRecoveryPointsRequest()
.withGatewayARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B").withMarker("1").withLimit(1);
DescribeTapeRecoveryPointsResult response = client.describeTapeRecoveryPoints(request);DescribeTapesResult describeTapes(DescribeTapesRequest describeTapesRequest)
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. This operation
is only supported in the tape gateway type.
describeTapesRequest - DescribeTapesInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
DescribeTapesRequest request = new DescribeTapesRequest().withGatewayARN("arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B")
.withTapeARNs("arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1", "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0")
.withMarker("1").withLimit(2);
DescribeTapesResult response = client.describeTapes(request);DescribeUploadBufferResult describeUploadBuffer(DescribeUploadBufferRequest describeUploadBufferRequest)
Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume, and tape gateway types.
The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.
describeUploadBufferRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
DescribeUploadBufferRequest request = new DescribeUploadBufferRequest()
.withGatewayARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B");
DescribeUploadBufferResult response = client.describeUploadBuffer(request);AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
DescribeUploadBufferRequest request = new DescribeUploadBufferRequest()
.withGatewayARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B");
DescribeUploadBufferResult response = client.describeUploadBuffer(request);DescribeVTLDevicesResult describeVTLDevices(DescribeVTLDevicesRequest describeVTLDevicesRequest)
Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, Storage Gateway returns VTL device information.
This operation is only supported in the tape gateway type.
describeVTLDevicesRequest - DescribeVTLDevicesInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
DescribeVTLDevicesRequest request = new DescribeVTLDevicesRequest()
.withGatewayARN("arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B").withVTLDeviceARNs(new ArrayList()).withMarker("1")
.withLimit(123);
DescribeVTLDevicesResult response = client.describeVTLDevices(request);DescribeWorkingStorageResult describeWorkingStorage(DescribeWorkingStorageRequest describeWorkingStorageRequest)
Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway type. This operation is deprecated in cached volumes API version (20120630). Use DescribeUploadBuffer instead.
Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored volume gateway.
The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.
describeWorkingStorageRequest - A JSON object containing the Amazon Resource Name (ARN) of the gateway.InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
DescribeWorkingStorageRequest request = new DescribeWorkingStorageRequest()
.withGatewayARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B");
DescribeWorkingStorageResult response = client.describeWorkingStorage(request);DetachVolumeResult detachVolume(DetachVolumeRequest detachVolumeRequest)
Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance. This operation is only supported in the volume gateway type.
detachVolumeRequest - AttachVolumeInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.DisableGatewayResult disableGateway(DisableGatewayRequest disableGatewayRequest)
Disables a tape 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 tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway type.
After a gateway is disabled, it cannot be enabled.
disableGatewayRequest - DisableGatewayInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
DisableGatewayRequest request = new DisableGatewayRequest().withGatewayARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B");
DisableGatewayResult response = client.disableGateway(request);DisassociateFileSystemResult disassociateFileSystem(DisassociateFileSystemRequest disassociateFileSystemRequest)
Disassociates an Amazon FSx file system from the specified gateway. After the disassociation process finishes, the gateway can no longer access the Amazon FSx file system. This operation is only supported in the FSx File Gateway type.
disassociateFileSystemRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.JoinDomainResult joinDomain(JoinDomainRequest joinDomainRequest)
Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.
Joining a domain creates an Active Directory computer account in the default organizational unit, using the gateway's Gateway ID as the account name (for example, SGW-1234ADE). If your Active Directory environment requires that you pre-stage accounts to facilitate the join domain process, you will need to create this account ahead of time.
To create the gateway's computer account in an organizational unit other than the default, you must specify the organizational unit when joining the domain.
joinDomainRequest - JoinDomainInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.ListAutomaticTapeCreationPoliciesResult listAutomaticTapeCreationPolicies(ListAutomaticTapeCreationPoliciesRequest listAutomaticTapeCreationPoliciesRequest)
Lists the automatic tape creation policies for a gateway. If there are no automatic tape creation policies for the gateway, it returns an empty list.
This operation is only supported for tape gateways.
listAutomaticTapeCreationPoliciesRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.ListFileSharesResult listFileShares(ListFileSharesRequest listFileSharesRequest)
Gets a list of the file shares for a specific S3 File Gateway, or the list of file shares that belong to the calling Amazon Web Services account. This operation is only supported for S3 File Gateways.
listFileSharesRequest - ListFileShareInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.ListFileSystemAssociationsResult listFileSystemAssociations(ListFileSystemAssociationsRequest listFileSystemAssociationsRequest)
Gets a list of FileSystemAssociationSummary objects. Each object contains a summary of a file system
association. This operation is only supported for FSx File Gateways.
listFileSystemAssociationsRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.ListGatewaysResult listGateways(ListGatewaysRequest listGatewaysRequest)
Lists gateways owned by an Amazon Web Services account in an Amazon Web Services Region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).
By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.
If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.
listGatewaysRequest - A JSON object containing zero or more of the following fields:
InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
ListGatewaysRequest request = new ListGatewaysRequest().withMarker("1").withLimit(2);
ListGatewaysResult response = client.listGateways(request);ListGatewaysResult listGateways()
listGateways(ListGatewaysRequest)ListLocalDisksResult listLocalDisks(ListLocalDisksRequest listLocalDisksRequest)
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).
listLocalDisksRequest - A JSON object containing the Amazon Resource Name (ARN) of the gateway.InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
ListLocalDisksRequest request = new ListLocalDisksRequest().withGatewayARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B");
ListLocalDisksResult response = client.listLocalDisks(request);ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags that have been added to the specified resource. This operation is supported in storage gateways of all types.
listTagsForResourceRequest - ListTagsForResourceInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
ListTagsForResourceRequest request = new ListTagsForResourceRequest()
.withResourceARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B").withMarker("1").withLimit(1);
ListTagsForResourceResult response = client.listTagsForResource(request);ListTagsForResourceResult listTagsForResource()
ListTapePoolsResult listTapePools(ListTapePoolsRequest listTapePoolsRequest)
Lists custom tape pools. You specify custom tape pools to list by specifying one or more custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN, the operation lists all custom tape pools.
This operation supports pagination. You can optionally specify the Limit parameter in the body to
limit the number of tape pools in the response. If the number of tape pools returned in the response is
truncated, the response includes a Marker element that you can use in your subsequent request to
retrieve the next set of tape pools.
listTapePoolsRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.ListTapesResult listTapes(ListTapesRequest listTapesRequest)
Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS.
This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can
optionally specify the Limit parameter in the body to limit the number of tapes in the response. If
the number of tapes returned in the response is truncated, the response includes a Marker element
that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported
in the tape gateway type.
listTapesRequest - A JSON object that contains one or more of the following fields:
InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.ListVolumeInitiatorsResult listVolumeInitiators(ListVolumeInitiatorsRequest listVolumeInitiatorsRequest)
Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. This operation is only supported in the cached volume and stored volume gateway types.
listVolumeInitiatorsRequest - ListVolumeInitiatorsInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.ListVolumeRecoveryPointsResult listVolumeRecoveryPoints(ListVolumeRecoveryPointsRequest listVolumeRecoveryPointsRequest)
Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type.
Each cache volume has one recovery point. 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 or clone a new cached volume from a source volume. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.
listVolumeRecoveryPointsRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
ListVolumeRecoveryPointsRequest request = new ListVolumeRecoveryPointsRequest()
.withGatewayARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B");
ListVolumeRecoveryPointsResult response = client.listVolumeRecoveryPoints(request);ListVolumesResult listVolumes(ListVolumesRequest listVolumesRequest)
Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the DescribeCachediSCSIVolumes API.
The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can
optionally specify the Limit field in the body to limit the number of volumes in the response. If
the number of volumes returned in the response is truncated, the response includes a Marker field. You can use
this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only
supported in the cached volume and stored volume gateway types.
listVolumesRequest - A JSON object that contains one or more of the following fields:
InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
ListVolumesRequest request = new ListVolumesRequest().withGatewayARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B")
.withMarker("1").withLimit(2);
ListVolumesResult response = client.listVolumes(request);NotifyWhenUploadedResult notifyWhenUploaded(NotifyWhenUploadedRequest notifyWhenUploadedRequest)
Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to S3. Amazon S3.
Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.
For more information, see Getting file upload notification in the Amazon S3 File Gateway User Guide.
notifyWhenUploadedRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.RefreshCacheResult refreshCache(RefreshCacheRequest refreshCacheRequest)
Refreshes the cached inventory of objects for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed, or replaced since the gateway last listed the bucket's contents and cached the results. This operation does not import files into the S3 File Gateway cache storage. It only updates the cached inventory to reflect changes in the inventory of the objects in the S3 bucket. This operation is only supported in the S3 File Gateway types.
You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation
completes. For more information, see Getting notified about file operations in the Storage Gateway User Guide. This operation is Only
supported for S3 File Gateways.
When this API is called, it only initiates the refresh operation. When the API call completes and returns a
success code, it doesn't necessarily mean that the file refresh has completed. You should use the
refresh-complete notification to determine that the operation has completed before you check for new files on the
gateway file share. You can subscribe to be notified through a CloudWatch event when your
RefreshCache operation completes.
Throttle limit: This API is asynchronous, so the gateway will accept no more than two refreshes at any time. We recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more information, see Getting notified about file operations in the Storage Gateway User Guide.
Wait at least 60 seconds between consecutive RefreshCache API requests.
If you invoke the RefreshCache API when two requests are already being processed, any new request will cause an
InvalidGatewayRequestException error because too many requests were sent to the server.
The S3 bucket name does not need to be included when entering the list of folders in the FolderList parameter.
For more information, see Getting notified about file operations in the Storage Gateway User Guide.
refreshCacheRequest - RefreshCacheInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes one or more tags from the specified resource. This operation is supported in storage gateways of all types.
removeTagsFromResourceRequest - RemoveTagsFromResourceInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
RemoveTagsFromResourceRequest request = new RemoveTagsFromResourceRequest().withResourceARN(
"arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B").withTagKeys("Dev Gatgeway Region", "East Coast");
RemoveTagsFromResourceResult response = client.removeTagsFromResource(request);RemoveTagsFromResourceResult removeTagsFromResource()
ResetCacheResult resetCache(ResetCacheRequest resetCacheRequest)
Resets all cache disks that have encountered an error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters an error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point, you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types.
If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.
resetCacheRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
ResetCacheRequest request = new ResetCacheRequest().withGatewayARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C");
ResetCacheResult response = client.resetCache(request);RetrieveTapeArchiveResult retrieveTapeArchive(RetrieveTapeArchiveRequest retrieveTapeArchiveRequest)
Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS, that is, archive. This operation is only supported in the tape gateway type.
Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway. This operation is only supported in the tape gateway type.
retrieveTapeArchiveRequest - RetrieveTapeArchiveInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
RetrieveTapeArchiveRequest request = new RetrieveTapeArchiveRequest().withTapeARN("arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF")
.withGatewayARN("arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B");
RetrieveTapeArchiveResult response = client.retrieveTapeArchive(request);RetrieveTapeRecoveryPointResult retrieveTapeRecoveryPoint(RetrieveTapeRecoveryPointRequest retrieveTapeRecoveryPointRequest)
Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway type.
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.
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 tape gateway. There is no charge for retrieving recovery points.
retrieveTapeRecoveryPointRequest - RetrieveTapeRecoveryPointInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
RetrieveTapeRecoveryPointRequest request = new RetrieveTapeRecoveryPointRequest().withTapeARN(
"arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF").withGatewayARN(
"arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B");
RetrieveTapeRecoveryPointResult response = client.retrieveTapeRecoveryPoint(request);SetLocalConsolePasswordResult setLocalConsolePassword(SetLocalConsolePasswordRequest setLocalConsolePasswordRequest)
Sets the password for your VM local console. When you log in to the local console for the first time, you log in to the VM with the default credentials. We recommend that you set a new password. You don't need to know the default password to set a new password.
setLocalConsolePasswordRequest - SetLocalConsolePasswordInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
SetLocalConsolePasswordRequest request = new SetLocalConsolePasswordRequest().withGatewayARN(
"arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B").withLocalConsolePassword("PassWordMustBeAtLeast6Chars.");
SetLocalConsolePasswordResult response = client.setLocalConsolePassword(request);SetSMBGuestPasswordResult setSMBGuestPassword(SetSMBGuestPasswordRequest setSMBGuestPasswordRequest)
Sets the password for the guest user smbguest. The smbguest user is the user when the
authentication method for the file share is set to GuestAccess. This operation only supported for S3
File Gateways
setSMBGuestPasswordRequest - SetSMBGuestPasswordInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.ShutdownGatewayResult shutdownGateway(ShutdownGatewayRequest shutdownGatewayRequest)
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 gateway's virtual machine (VM) and not the host VM.
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.
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.
shutdownGatewayRequest - A JSON object containing the Amazon Resource Name (ARN) of the gateway to shut down.InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
ShutdownGatewayRequest request = new ShutdownGatewayRequest().withGatewayARN("arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B");
ShutdownGatewayResult response = client.shutdownGateway(request);StartAvailabilityMonitorTestResult startAvailabilityMonitorTest(StartAvailabilityMonitorTestRequest startAvailabilityMonitorTestRequest)
Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host
environment. This request only initiates the test and that a successful response only indicates that the test was
started. It doesn't indicate that the test passed. For the status of the test, invoke the
DescribeAvailabilityMonitorTest API.
Starting this test will cause your gateway to go offline for a brief period.
startAvailabilityMonitorTestRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.StartGatewayResult startGateway(StartGatewayRequest startGatewayRequest)
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.
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.
startGatewayRequest - A JSON object containing the Amazon Resource Name (ARN) of the gateway to start.InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
StartGatewayRequest request = new StartGatewayRequest().withGatewayARN("arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B");
StartGatewayResult response = client.startGateway(request);UpdateAutomaticTapeCreationPolicyResult updateAutomaticTapeCreationPolicy(UpdateAutomaticTapeCreationPolicyRequest updateAutomaticTapeCreationPolicyRequest)
Updates the automatic tape creation policy of a gateway. Use this to update the policy with a new set of automatic tape creation rules. This is only supported for tape gateways.
By default, there is no automatic tape creation policy.
A gateway can have only one automatic tape creation policy.
updateAutomaticTapeCreationPolicyRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.UpdateBandwidthRateLimitResult updateBandwidthRateLimit(UpdateBandwidthRateLimitRequest updateBandwidthRateLimitRequest)
Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains. This operation is supported only for the stored volume, cached volume, and tape gateway types. To update bandwidth rate limits for S3 file gateways, use UpdateBandwidthRateLimitSchedule.
By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.
To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
updateBandwidthRateLimitRequest - A JSON object containing one or more of the following fields:
InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
UpdateBandwidthRateLimitRequest request = new UpdateBandwidthRateLimitRequest()
.withGatewayARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B").withAverageUploadRateLimitInBitsPerSec(51200L)
.withAverageDownloadRateLimitInBitsPerSec(102400L);
UpdateBandwidthRateLimitResult response = client.updateBandwidthRateLimit(request);UpdateBandwidthRateLimitScheduleResult updateBandwidthRateLimitSchedule(UpdateBandwidthRateLimitScheduleRequest updateBandwidthRateLimitScheduleRequest)
Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This operation is supported for volume, tape, and S3 file gateways. S3 file gateways support bandwidth rate limits for upload only. FSx file gateways do not support bandwidth rate limits.
updateBandwidthRateLimitScheduleRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.UpdateChapCredentialsResult updateChapCredentials(UpdateChapCredentialsRequest updateChapCredentialsRequest)
Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it. This operation is supported in the volume and tape gateway types.
When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.
updateChapCredentialsRequest - A JSON object containing one or more of the following fields:
InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
UpdateChapCredentialsRequest request = new UpdateChapCredentialsRequest()
.withTargetARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume")
.withSecretToAuthenticateInitiator("111111111111").withInitiatorName("iqn.1991-05.com.microsoft:computername.domain.example.com")
.withSecretToAuthenticateTarget("222222222222");
UpdateChapCredentialsResult response = client.updateChapCredentials(request);UpdateFileSystemAssociationResult updateFileSystemAssociation(UpdateFileSystemAssociationRequest updateFileSystemAssociationRequest)
Updates a file system association. This operation is only supported in the FSx File Gateways.
updateFileSystemAssociationRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.UpdateGatewayInformationResult updateGatewayInformation(UpdateGatewayInformationRequest updateGatewayInformationRequest)
Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
For gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN.
updateGatewayInformationRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
UpdateGatewayInformationRequest request = new UpdateGatewayInformationRequest()
.withGatewayARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B").withGatewayName("MyGateway2")
.withGatewayTimezone("GMT-12:00");
UpdateGatewayInformationResult response = client.updateGatewayInformation(request);UpdateGatewaySoftwareNowResult updateGatewaySoftwareNow(UpdateGatewaySoftwareNowRequest updateGatewaySoftwareNowRequest)
Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.
When you make this request, you get a 200 OK success response immediately. However, it might take
some time for the update to complete. You can call DescribeGatewayInformation to verify the gateway is in
the STATE_RUNNING state.
A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see Customizing your Windows iSCSI settings and Customizing your Linux iSCSI settings, respectively.
updateGatewaySoftwareNowRequest - A JSON object containing the Amazon Resource Name (ARN) of the gateway to update.InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
UpdateGatewaySoftwareNowRequest request = new UpdateGatewaySoftwareNowRequest()
.withGatewayARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B");
UpdateGatewaySoftwareNowResult response = client.updateGatewaySoftwareNow(request);UpdateMaintenanceStartTimeResult updateMaintenanceStartTime(UpdateMaintenanceStartTimeRequest updateMaintenanceStartTimeRequest)
Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone.
updateMaintenanceStartTimeRequest - A JSON object containing the following fields:
InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
UpdateMaintenanceStartTimeRequest request = new UpdateMaintenanceStartTimeRequest()
.withGatewayARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B").withHourOfDay(0).withMinuteOfHour(30).withDayOfWeek(2);
UpdateMaintenanceStartTimeResult response = client.updateMaintenanceStartTime(request);UpdateNFSFileShareResult updateNFSFileShare(UpdateNFSFileShareRequest updateNFSFileShareRequest)
Updates a Network File System (NFS) file share. This operation is only supported in S3 File Gateways.
To leave a file share field unchanged, set the corresponding input field to null.
Updates the following file share settings:
Default storage class for your S3 bucket
Metadata defaults for your S3 bucket
Allowed NFS clients for your file share
Squash settings
Write status of your file share
updateNFSFileShareRequest - UpdateNFSFileShareInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.UpdateSMBFileShareResult updateSMBFileShare(UpdateSMBFileShareRequest updateSMBFileShareRequest)
Updates a Server Message Block (SMB) file share. This operation is only supported for S3 File Gateways.
To leave a file share field unchanged, set the corresponding input field to null.
File gateways require Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure that Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your file gateway in. If Amazon Web Services STS is not activated in this Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region in the Identity and Access Management User Guide.
File gateways don't support creating hard or symbolic links on a file share.
updateSMBFileShareRequest - UpdateSMBFileShareInputInvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.UpdateSMBFileShareVisibilityResult updateSMBFileShareVisibility(UpdateSMBFileShareVisibilityRequest updateSMBFileShareVisibilityRequest)
Controls whether the shares on an S3 File Gateway are visible in a net view or browse list. The operation is only supported for S3 File Gateways.
updateSMBFileShareVisibilityRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.UpdateSMBLocalGroupsResult updateSMBLocalGroups(UpdateSMBLocalGroupsRequest updateSMBLocalGroupsRequest)
Updates the list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.
updateSMBLocalGroupsRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.UpdateSMBSecurityStrategyResult updateSMBSecurityStrategy(UpdateSMBSecurityStrategyRequest updateSMBSecurityStrategyRequest)
Updates the SMB security strategy on a file gateway. This action is only supported in file gateways.
This API is called Security level in the User Guide.
A higher security level can affect performance of the gateway.
updateSMBSecurityStrategyRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.UpdateSnapshotScheduleResult updateSnapshotSchedule(UpdateSnapshotScheduleRequest updateSnapshotScheduleRequest)
Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway types.
The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume.
In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.
updateSnapshotScheduleRequest - A JSON object containing one or more of the following fields:
InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
UpdateSnapshotScheduleRequest request = new UpdateSnapshotScheduleRequest()
.withVolumeARN("arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB").withStartAt(0)
.withRecurrenceInHours(1).withDescription("Hourly snapshot");
UpdateSnapshotScheduleResult response = client.updateSnapshotSchedule(request);UpdateVTLDeviceTypeResult updateVTLDeviceType(UpdateVTLDeviceTypeRequest updateVTLDeviceTypeRequest)
Updates the type of medium changer in a tape gateway. When you activate a tape gateway, you select a medium changer type for the tape gateway. This operation enables you to select a different type of medium changer after a tape gateway is activated. This operation is only supported in the tape gateway type.
updateVTLDeviceTypeRequest - InvalidGatewayRequestException - An exception occurred because an invalid gateway request was issued to the service. For more information,
see the error and message fields.InternalServerErrorException - An internal server error has occurred during the request. For more information, see the error and message
fields.AWSStorageGateway client = AWSStorageGatewayClientBuilder.standard().build();
UpdateVTLDeviceTypeRequest request = new UpdateVTLDeviceTypeRequest().withVTLDeviceARN(
"arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001").withDeviceType(
"Medium Changer");
UpdateVTLDeviceTypeResult response = client.updateVTLDeviceType(request);void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 a request.
request - The originally executed request.