@Generated(value="software.amazon.awssdk:codegen") public interface StorageGatewayClient extends SdkClient
builder() method.
AWS Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization's on-premises IT environment and AWS's storage infrastructure. The service enables you to securely upload data to the AWS cloud for cost effective backup and rapid disaster recovery.
Use the following links to get started using the AWS Storage Gateway Service API Reference:
AWS Storage Gateway Required Request Headers: Describes the required headers that you must send with every POST request to AWS Storage Gateway.
Signing Requests: AWS Storage Gateway requires that you authenticate every request you send; this topic describes how sign such a request.
Error Responses: Provides reference information about AWS Storage Gateway errors.
Operations in AWS Storage Gateway: Contains detailed descriptions of all AWS Storage Gateway operations, their request parameters, response elements, possible errors, and examples of requests and responses.
AWS Storage Gateway Regions and Endpoints: Provides a list of each AWS region and endpoints available for use with AWS Storage Gateway.
AWS 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 AWS Storage Gateway volume and snapshot IDs coming in 2016.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default ActivateGatewayResponse |
activateGateway(ActivateGatewayRequest activateGatewayRequest)
Activates the gateway you previously deployed on your host.
|
default ActivateGatewayResponse |
activateGateway(Consumer<ActivateGatewayRequest.Builder> activateGatewayRequest)
Activates the gateway you previously deployed on your host.
|
default AddCacheResponse |
addCache(AddCacheRequest addCacheRequest)
Configures one or more gateway local disks as cache for a gateway.
|
default AddCacheResponse |
addCache(Consumer<AddCacheRequest.Builder> addCacheRequest)
Configures one or more gateway local disks as cache for a gateway.
|
default AddTagsToResourceResponse |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds one or more tags to the specified resource.
|
default AddTagsToResourceResponse |
addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)
Adds one or more tags to the specified resource.
|
default AddUploadBufferResponse |
addUploadBuffer(AddUploadBufferRequest addUploadBufferRequest)
Configures one or more gateway local disks as upload buffer for a specified gateway.
|
default AddUploadBufferResponse |
addUploadBuffer(Consumer<AddUploadBufferRequest.Builder> addUploadBufferRequest)
Configures one or more gateway local disks as upload buffer for a specified gateway.
|
default AddWorkingStorageResponse |
addWorkingStorage(AddWorkingStorageRequest addWorkingStorageRequest)
Configures one or more gateway local disks as working storage for a gateway.
|
default AddWorkingStorageResponse |
addWorkingStorage(Consumer<AddWorkingStorageRequest.Builder> addWorkingStorageRequest)
Configures one or more gateway local disks as working storage for a gateway.
|
static StorageGatewayClientBuilder |
builder()
Create a builder that can be used to configure and create a
StorageGatewayClient. |
default CancelArchivalResponse |
cancelArchival(CancelArchivalRequest cancelArchivalRequest)
Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.
|
default CancelArchivalResponse |
cancelArchival(Consumer<CancelArchivalRequest.Builder> cancelArchivalRequest)
Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.
|
default CancelRetrievalResponse |
cancelRetrieval(CancelRetrievalRequest cancelRetrievalRequest)
Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is
initiated.
|
default CancelRetrievalResponse |
cancelRetrieval(Consumer<CancelRetrievalRequest.Builder> cancelRetrievalRequest)
Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is
initiated.
|
static StorageGatewayClient |
create()
Create a
StorageGatewayClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateCachediScsiVolumeResponse |
createCachediSCSIVolume(Consumer<CreateCachediScsiVolumeRequest.Builder> createCachediScsiVolumeRequest)
Creates a cached volume on a specified cached volume gateway.
|
default CreateCachediScsiVolumeResponse |
createCachediSCSIVolume(CreateCachediScsiVolumeRequest createCachediScsiVolumeRequest)
Creates a cached volume on a specified cached volume gateway.
|
default CreateNfsFileShareResponse |
createNFSFileShare(Consumer<CreateNfsFileShareRequest.Builder> createNfsFileShareRequest)
Creates a Network File System (NFS) file share on an existing file gateway.
|
default CreateNfsFileShareResponse |
createNFSFileShare(CreateNfsFileShareRequest createNfsFileShareRequest)
Creates a Network File System (NFS) file share on an existing file gateway.
|
default CreateSmbFileShareResponse |
createSMBFileShare(Consumer<CreateSmbFileShareRequest.Builder> createSmbFileShareRequest)
Creates a Server Message Block (SMB) file share on an existing file gateway.
|
default CreateSmbFileShareResponse |
createSMBFileShare(CreateSmbFileShareRequest createSmbFileShareRequest)
Creates a Server Message Block (SMB) file share on an existing file gateway.
|
default CreateSnapshotResponse |
createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest)
Initiates a snapshot of a volume.
|
default CreateSnapshotResponse |
createSnapshot(CreateSnapshotRequest createSnapshotRequest)
Initiates a snapshot of a volume.
|
default CreateSnapshotFromVolumeRecoveryPointResponse |
createSnapshotFromVolumeRecoveryPoint(Consumer<CreateSnapshotFromVolumeRecoveryPointRequest.Builder> createSnapshotFromVolumeRecoveryPointRequest)
Initiates a snapshot of a gateway from a volume recovery point.
|
default CreateSnapshotFromVolumeRecoveryPointResponse |
createSnapshotFromVolumeRecoveryPoint(CreateSnapshotFromVolumeRecoveryPointRequest createSnapshotFromVolumeRecoveryPointRequest)
Initiates a snapshot of a gateway from a volume recovery point.
|
default CreateStorediScsiVolumeResponse |
createStorediSCSIVolume(Consumer<CreateStorediScsiVolumeRequest.Builder> createStorediScsiVolumeRequest)
Creates a volume on a specified gateway.
|
default CreateStorediScsiVolumeResponse |
createStorediSCSIVolume(CreateStorediScsiVolumeRequest createStorediScsiVolumeRequest)
Creates a volume on a specified gateway.
|
default CreateTapesResponse |
createTapes(Consumer<CreateTapesRequest.Builder> createTapesRequest)
Creates one or more virtual tapes.
|
default CreateTapesResponse |
createTapes(CreateTapesRequest createTapesRequest)
Creates one or more virtual tapes.
|
default CreateTapeWithBarcodeResponse |
createTapeWithBarcode(Consumer<CreateTapeWithBarcodeRequest.Builder> createTapeWithBarcodeRequest)
Creates a virtual tape by using your own barcode.
|
default CreateTapeWithBarcodeResponse |
createTapeWithBarcode(CreateTapeWithBarcodeRequest createTapeWithBarcodeRequest)
Creates a virtual tape by using your own barcode.
|
default DeleteBandwidthRateLimitResponse |
deleteBandwidthRateLimit(Consumer<DeleteBandwidthRateLimitRequest.Builder> deleteBandwidthRateLimitRequest)
Deletes the bandwidth rate limits of a gateway.
|
default DeleteBandwidthRateLimitResponse |
deleteBandwidthRateLimit(DeleteBandwidthRateLimitRequest deleteBandwidthRateLimitRequest)
Deletes the bandwidth rate limits of a gateway.
|
default DeleteChapCredentialsResponse |
deleteChapCredentials(Consumer<DeleteChapCredentialsRequest.Builder> deleteChapCredentialsRequest)
Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator
pair.
|
default DeleteChapCredentialsResponse |
deleteChapCredentials(DeleteChapCredentialsRequest deleteChapCredentialsRequest)
Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator
pair.
|
default DeleteFileShareResponse |
deleteFileShare(Consumer<DeleteFileShareRequest.Builder> deleteFileShareRequest)
Deletes a file share from a file gateway.
|
default DeleteFileShareResponse |
deleteFileShare(DeleteFileShareRequest deleteFileShareRequest)
Deletes a file share from a file gateway.
|
default DeleteGatewayResponse |
deleteGateway(Consumer<DeleteGatewayRequest.Builder> deleteGatewayRequest)
Deletes a gateway.
|
default DeleteGatewayResponse |
deleteGateway(DeleteGatewayRequest deleteGatewayRequest)
Deletes a gateway.
|
default DeleteSnapshotScheduleResponse |
deleteSnapshotSchedule(Consumer<DeleteSnapshotScheduleRequest.Builder> deleteSnapshotScheduleRequest)
Deletes a snapshot of a volume.
|
default DeleteSnapshotScheduleResponse |
deleteSnapshotSchedule(DeleteSnapshotScheduleRequest deleteSnapshotScheduleRequest)
Deletes a snapshot of a volume.
|
default DeleteTapeResponse |
deleteTape(Consumer<DeleteTapeRequest.Builder> deleteTapeRequest)
Deletes the specified virtual tape.
|
default DeleteTapeResponse |
deleteTape(DeleteTapeRequest deleteTapeRequest)
Deletes the specified virtual tape.
|
default DeleteTapeArchiveResponse |
deleteTapeArchive(Consumer<DeleteTapeArchiveRequest.Builder> deleteTapeArchiveRequest)
Deletes the specified virtual tape from the virtual tape shelf (VTS).
|
default DeleteTapeArchiveResponse |
deleteTapeArchive(DeleteTapeArchiveRequest deleteTapeArchiveRequest)
Deletes the specified virtual tape from the virtual tape shelf (VTS).
|
default DeleteVolumeResponse |
deleteVolume(Consumer<DeleteVolumeRequest.Builder> deleteVolumeRequest)
Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or
CreateStorediSCSIVolume API.
|
default DeleteVolumeResponse |
deleteVolume(DeleteVolumeRequest deleteVolumeRequest)
Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or
CreateStorediSCSIVolume API.
|
default DescribeBandwidthRateLimitResponse |
describeBandwidthRateLimit(Consumer<DescribeBandwidthRateLimitRequest.Builder> describeBandwidthRateLimitRequest)
Returns the bandwidth rate limits of a gateway.
|
default DescribeBandwidthRateLimitResponse |
describeBandwidthRateLimit(DescribeBandwidthRateLimitRequest describeBandwidthRateLimitRequest)
Returns the bandwidth rate limits of a gateway.
|
default DescribeCacheResponse |
describeCache(Consumer<DescribeCacheRequest.Builder> describeCacheRequest)
Returns information about the cache of a gateway.
|
default DescribeCacheResponse |
describeCache(DescribeCacheRequest describeCacheRequest)
Returns information about the cache of a gateway.
|
default DescribeCachediScsiVolumesResponse |
describeCachediSCSIVolumes(Consumer<DescribeCachediScsiVolumesRequest.Builder> describeCachediScsiVolumesRequest)
Returns a description of the gateway volumes specified in the request.
|
default DescribeCachediScsiVolumesResponse |
describeCachediSCSIVolumes(DescribeCachediScsiVolumesRequest describeCachediScsiVolumesRequest)
Returns a description of the gateway volumes specified in the request.
|
default DescribeChapCredentialsResponse |
describeChapCredentials(Consumer<DescribeChapCredentialsRequest.Builder> describeChapCredentialsRequest)
Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified
iSCSI target, one for each target-initiator pair.
|
default DescribeChapCredentialsResponse |
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.
|
default DescribeGatewayInformationResponse |
describeGatewayInformation(Consumer<DescribeGatewayInformationRequest.Builder> describeGatewayInformationRequest)
Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state
(whether the gateway is running or not).
|
default DescribeGatewayInformationResponse |
describeGatewayInformation(DescribeGatewayInformationRequest describeGatewayInformationRequest)
Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state
(whether the gateway is running or not).
|
default DescribeMaintenanceStartTimeResponse |
describeMaintenanceStartTime(Consumer<DescribeMaintenanceStartTimeRequest.Builder> describeMaintenanceStartTimeRequest)
Returns your gateway's weekly maintenance start time including the day and time of the week.
|
default DescribeMaintenanceStartTimeResponse |
describeMaintenanceStartTime(DescribeMaintenanceStartTimeRequest describeMaintenanceStartTimeRequest)
Returns your gateway's weekly maintenance start time including the day and time of the week.
|
default DescribeNfsFileSharesResponse |
describeNFSFileShares(Consumer<DescribeNfsFileSharesRequest.Builder> describeNfsFileSharesRequest)
Gets a description for one or more Network File System (NFS) file shares from a file gateway.
|
default DescribeNfsFileSharesResponse |
describeNFSFileShares(DescribeNfsFileSharesRequest describeNfsFileSharesRequest)
Gets a description for one or more Network File System (NFS) file shares from a file gateway.
|
default DescribeSmbFileSharesResponse |
describeSMBFileShares(Consumer<DescribeSmbFileSharesRequest.Builder> describeSmbFileSharesRequest)
Gets a description for one or more Server Message Block (SMB) file shares from a file gateway.
|
default DescribeSmbFileSharesResponse |
describeSMBFileShares(DescribeSmbFileSharesRequest describeSmbFileSharesRequest)
Gets a description for one or more Server Message Block (SMB) file shares from a file gateway.
|
default DescribeSmbSettingsResponse |
describeSMBSettings(Consumer<DescribeSmbSettingsRequest.Builder> describeSmbSettingsRequest)
Gets a description of a Server Message Block (SMB) file share settings from a file gateway.
|
default DescribeSmbSettingsResponse |
describeSMBSettings(DescribeSmbSettingsRequest describeSmbSettingsRequest)
Gets a description of a Server Message Block (SMB) file share settings from a file gateway.
|
default DescribeSnapshotScheduleResponse |
describeSnapshotSchedule(Consumer<DescribeSnapshotScheduleRequest.Builder> describeSnapshotScheduleRequest)
Describes the snapshot schedule for the specified gateway volume.
|
default DescribeSnapshotScheduleResponse |
describeSnapshotSchedule(DescribeSnapshotScheduleRequest describeSnapshotScheduleRequest)
Describes the snapshot schedule for the specified gateway volume.
|
default DescribeStorediScsiVolumesResponse |
describeStorediSCSIVolumes(Consumer<DescribeStorediScsiVolumesRequest.Builder> describeStorediScsiVolumesRequest)
Returns the description of the gateway volumes specified in the request.
|
default DescribeStorediScsiVolumesResponse |
describeStorediSCSIVolumes(DescribeStorediScsiVolumesRequest describeStorediScsiVolumesRequest)
Returns the description of the gateway volumes specified in the request.
|
default DescribeTapeArchivesResponse |
describeTapeArchives()
Returns a description of specified virtual tapes in the virtual tape shelf (VTS).
|
default DescribeTapeArchivesResponse |
describeTapeArchives(Consumer<DescribeTapeArchivesRequest.Builder> describeTapeArchivesRequest)
Returns a description of specified virtual tapes in the virtual tape shelf (VTS).
|
default DescribeTapeArchivesResponse |
describeTapeArchives(DescribeTapeArchivesRequest describeTapeArchivesRequest)
Returns a description of specified virtual tapes in the virtual tape shelf (VTS).
|
default DescribeTapeArchivesIterable |
describeTapeArchivesPaginator()
Returns a description of specified virtual tapes in the virtual tape shelf (VTS).
|
default DescribeTapeArchivesIterable |
describeTapeArchivesPaginator(Consumer<DescribeTapeArchivesRequest.Builder> describeTapeArchivesRequest)
Returns a description of specified virtual tapes in the virtual tape shelf (VTS).
|
default DescribeTapeArchivesIterable |
describeTapeArchivesPaginator(DescribeTapeArchivesRequest describeTapeArchivesRequest)
Returns a description of specified virtual tapes in the virtual tape shelf (VTS).
|
default DescribeTapeRecoveryPointsResponse |
describeTapeRecoveryPoints(Consumer<DescribeTapeRecoveryPointsRequest.Builder> describeTapeRecoveryPointsRequest)
Returns a list of virtual tape recovery points that are available for the specified tape gateway.
|
default DescribeTapeRecoveryPointsResponse |
describeTapeRecoveryPoints(DescribeTapeRecoveryPointsRequest describeTapeRecoveryPointsRequest)
Returns a list of virtual tape recovery points that are available for the specified tape gateway.
|
default DescribeTapeRecoveryPointsIterable |
describeTapeRecoveryPointsPaginator(Consumer<DescribeTapeRecoveryPointsRequest.Builder> describeTapeRecoveryPointsRequest)
Returns a list of virtual tape recovery points that are available for the specified tape gateway.
|
default DescribeTapeRecoveryPointsIterable |
describeTapeRecoveryPointsPaginator(DescribeTapeRecoveryPointsRequest describeTapeRecoveryPointsRequest)
Returns a list of virtual tape recovery points that are available for the specified tape gateway.
|
default DescribeTapesResponse |
describeTapes(Consumer<DescribeTapesRequest.Builder> describeTapesRequest)
Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes.
|
default DescribeTapesResponse |
describeTapes(DescribeTapesRequest describeTapesRequest)
Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes.
|
default DescribeTapesIterable |
describeTapesPaginator(Consumer<DescribeTapesRequest.Builder> describeTapesRequest)
Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes.
|
default DescribeTapesIterable |
describeTapesPaginator(DescribeTapesRequest describeTapesRequest)
Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes.
|
default DescribeUploadBufferResponse |
describeUploadBuffer(Consumer<DescribeUploadBufferRequest.Builder> describeUploadBufferRequest)
Returns information about the upload buffer of a gateway.
|
default DescribeUploadBufferResponse |
describeUploadBuffer(DescribeUploadBufferRequest describeUploadBufferRequest)
Returns information about the upload buffer of a gateway.
|
default DescribeVtlDevicesResponse |
describeVTLDevices(Consumer<DescribeVtlDevicesRequest.Builder> describeVtlDevicesRequest)
Returns a description of virtual tape library (VTL) devices for the specified tape gateway.
|
default DescribeVtlDevicesResponse |
describeVTLDevices(DescribeVtlDevicesRequest describeVtlDevicesRequest)
Returns a description of virtual tape library (VTL) devices for the specified tape gateway.
|
default DescribeVTLDevicesIterable |
describeVTLDevicesPaginator(Consumer<DescribeVtlDevicesRequest.Builder> describeVtlDevicesRequest)
Returns a description of virtual tape library (VTL) devices for the specified tape gateway.
|
default DescribeVTLDevicesIterable |
describeVTLDevicesPaginator(DescribeVtlDevicesRequest describeVtlDevicesRequest)
Returns a description of virtual tape library (VTL) devices for the specified tape gateway.
|
default DescribeWorkingStorageResponse |
describeWorkingStorage(Consumer<DescribeWorkingStorageRequest.Builder> describeWorkingStorageRequest)
Returns information about the working storage of a gateway.
|
default DescribeWorkingStorageResponse |
describeWorkingStorage(DescribeWorkingStorageRequest describeWorkingStorageRequest)
Returns information about the working storage of a gateway.
|
default DisableGatewayResponse |
disableGateway(Consumer<DisableGatewayRequest.Builder> disableGatewayRequest)
Disables a tape gateway when the gateway is no longer functioning.
|
default DisableGatewayResponse |
disableGateway(DisableGatewayRequest disableGatewayRequest)
Disables a tape gateway when the gateway is no longer functioning.
|
default JoinDomainResponse |
joinDomain(Consumer<JoinDomainRequest.Builder> joinDomainRequest)
Adds a file gateway to an Active Directory domain.
|
default JoinDomainResponse |
joinDomain(JoinDomainRequest joinDomainRequest)
Adds a file gateway to an Active Directory domain.
|
default ListFileSharesResponse |
listFileShares()
Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling
user account.
|
default ListFileSharesResponse |
listFileShares(Consumer<ListFileSharesRequest.Builder> listFileSharesRequest)
Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling
user account.
|
default ListFileSharesResponse |
listFileShares(ListFileSharesRequest listFileSharesRequest)
Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling
user account.
|
default ListGatewaysResponse |
listGateways()
Lists gateways owned by an AWS account in a region specified in the request.
|
default ListGatewaysResponse |
listGateways(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest)
Lists gateways owned by an AWS account in a region specified in the request.
|
default ListGatewaysResponse |
listGateways(ListGatewaysRequest listGatewaysRequest)
Lists gateways owned by an AWS account in a region specified in the request.
|
default ListGatewaysIterable |
listGatewaysPaginator()
Lists gateways owned by an AWS account in a region specified in the request.
|
default ListGatewaysIterable |
listGatewaysPaginator(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest)
Lists gateways owned by an AWS account in a region specified in the request.
|
default ListGatewaysIterable |
listGatewaysPaginator(ListGatewaysRequest listGatewaysRequest)
Lists gateways owned by an AWS account in a region specified in the request.
|
default ListLocalDisksResponse |
listLocalDisks(Consumer<ListLocalDisksRequest.Builder> listLocalDisksRequest)
Returns a list of the gateway's local disks.
|
default ListLocalDisksResponse |
listLocalDisks(ListLocalDisksRequest listLocalDisksRequest)
Returns a list of the gateway's local disks.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags that have been added to the specified resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags that have been added to the specified resource.
|
default ListTapesResponse |
listTapes()
Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS).
|
default ListTapesResponse |
listTapes(Consumer<ListTapesRequest.Builder> listTapesRequest)
Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS).
|
default ListTapesResponse |
listTapes(ListTapesRequest listTapesRequest)
Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS).
|
default ListVolumeInitiatorsResponse |
listVolumeInitiators(Consumer<ListVolumeInitiatorsRequest.Builder> listVolumeInitiatorsRequest)
Lists iSCSI initiators that are connected to a volume.
|
default ListVolumeInitiatorsResponse |
listVolumeInitiators(ListVolumeInitiatorsRequest listVolumeInitiatorsRequest)
Lists iSCSI initiators that are connected to a volume.
|
default ListVolumeRecoveryPointsResponse |
listVolumeRecoveryPoints(Consumer<ListVolumeRecoveryPointsRequest.Builder> listVolumeRecoveryPointsRequest)
Lists the recovery points for a specified gateway.
|
default ListVolumeRecoveryPointsResponse |
listVolumeRecoveryPoints(ListVolumeRecoveryPointsRequest listVolumeRecoveryPointsRequest)
Lists the recovery points for a specified gateway.
|
default ListVolumesResponse |
listVolumes()
Lists the iSCSI stored volumes of a gateway.
|
default ListVolumesResponse |
listVolumes(Consumer<ListVolumesRequest.Builder> listVolumesRequest)
Lists the iSCSI stored volumes of a gateway.
|
default ListVolumesResponse |
listVolumes(ListVolumesRequest listVolumesRequest)
Lists the iSCSI stored volumes of a gateway.
|
default ListVolumesIterable |
listVolumesPaginator()
Lists the iSCSI stored volumes of a gateway.
|
default ListVolumesIterable |
listVolumesPaginator(Consumer<ListVolumesRequest.Builder> listVolumesRequest)
Lists the iSCSI stored volumes of a gateway.
|
default ListVolumesIterable |
listVolumesPaginator(ListVolumesRequest listVolumesRequest)
Lists the iSCSI stored volumes of a gateway.
|
default NotifyWhenUploadedResponse |
notifyWhenUploaded(Consumer<NotifyWhenUploadedRequest.Builder> notifyWhenUploadedRequest)
Sends you notification through CloudWatch Events when all files written to your NFS file share have been uploaded
to Amazon S3.
|
default NotifyWhenUploadedResponse |
notifyWhenUploaded(NotifyWhenUploadedRequest notifyWhenUploadedRequest)
Sends you notification through CloudWatch Events when all files written to your NFS file share have been uploaded
to Amazon S3.
|
default RefreshCacheResponse |
refreshCache(Consumer<RefreshCacheRequest.Builder> refreshCacheRequest)
Refreshes the cache for the specified file share.
|
default RefreshCacheResponse |
refreshCache(RefreshCacheRequest refreshCacheRequest)
Refreshes the cache for the specified file share.
|
default RemoveTagsFromResourceResponse |
removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)
Removes one or more tags from the specified resource.
|
default RemoveTagsFromResourceResponse |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes one or more tags from the specified resource.
|
default ResetCacheResponse |
resetCache(Consumer<ResetCacheRequest.Builder> resetCacheRequest)
Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache
storage.
|
default ResetCacheResponse |
resetCache(ResetCacheRequest resetCacheRequest)
Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache
storage.
|
default RetrieveTapeArchiveResponse |
retrieveTapeArchive(Consumer<RetrieveTapeArchiveRequest.Builder> retrieveTapeArchiveRequest)
Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway.
|
default RetrieveTapeArchiveResponse |
retrieveTapeArchive(RetrieveTapeArchiveRequest retrieveTapeArchiveRequest)
Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway.
|
default RetrieveTapeRecoveryPointResponse |
retrieveTapeRecoveryPoint(Consumer<RetrieveTapeRecoveryPointRequest.Builder> retrieveTapeRecoveryPointRequest)
Retrieves the recovery point for the specified virtual tape.
|
default RetrieveTapeRecoveryPointResponse |
retrieveTapeRecoveryPoint(RetrieveTapeRecoveryPointRequest retrieveTapeRecoveryPointRequest)
Retrieves the recovery point for the specified virtual tape.
|
static ServiceMetadata |
serviceMetadata() |
default SetLocalConsolePasswordResponse |
setLocalConsolePassword(Consumer<SetLocalConsolePasswordRequest.Builder> setLocalConsolePasswordRequest)
Sets the password for your VM local console.
|
default SetLocalConsolePasswordResponse |
setLocalConsolePassword(SetLocalConsolePasswordRequest setLocalConsolePasswordRequest)
Sets the password for your VM local console.
|
default SetSmbGuestPasswordResponse |
setSMBGuestPassword(Consumer<SetSmbGuestPasswordRequest.Builder> setSmbGuestPasswordRequest)
Sets the password for the guest user
smbguest. |
default SetSmbGuestPasswordResponse |
setSMBGuestPassword(SetSmbGuestPasswordRequest setSmbGuestPasswordRequest)
Sets the password for the guest user
smbguest. |
default ShutdownGatewayResponse |
shutdownGateway(Consumer<ShutdownGatewayRequest.Builder> shutdownGatewayRequest)
Shuts down a gateway.
|
default ShutdownGatewayResponse |
shutdownGateway(ShutdownGatewayRequest shutdownGatewayRequest)
Shuts down a gateway.
|
default StartGatewayResponse |
startGateway(Consumer<StartGatewayRequest.Builder> startGatewayRequest)
Starts a gateway that you previously shut down (see ShutdownGateway).
|
default StartGatewayResponse |
startGateway(StartGatewayRequest startGatewayRequest)
Starts a gateway that you previously shut down (see ShutdownGateway).
|
default UpdateBandwidthRateLimitResponse |
updateBandwidthRateLimit(Consumer<UpdateBandwidthRateLimitRequest.Builder> updateBandwidthRateLimitRequest)
Updates the bandwidth rate limits of a gateway.
|
default UpdateBandwidthRateLimitResponse |
updateBandwidthRateLimit(UpdateBandwidthRateLimitRequest updateBandwidthRateLimitRequest)
Updates the bandwidth rate limits of a gateway.
|
default UpdateChapCredentialsResponse |
updateChapCredentials(Consumer<UpdateChapCredentialsRequest.Builder> updateChapCredentialsRequest)
Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target.
|
default UpdateChapCredentialsResponse |
updateChapCredentials(UpdateChapCredentialsRequest updateChapCredentialsRequest)
Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target.
|
default UpdateGatewayInformationResponse |
updateGatewayInformation(Consumer<UpdateGatewayInformationRequest.Builder> updateGatewayInformationRequest)
Updates a gateway's metadata, which includes the gateway's name and time zone.
|
default UpdateGatewayInformationResponse |
updateGatewayInformation(UpdateGatewayInformationRequest updateGatewayInformationRequest)
Updates a gateway's metadata, which includes the gateway's name and time zone.
|
default UpdateGatewaySoftwareNowResponse |
updateGatewaySoftwareNow(Consumer<UpdateGatewaySoftwareNowRequest.Builder> updateGatewaySoftwareNowRequest)
Updates the gateway virtual machine (VM) software.
|
default UpdateGatewaySoftwareNowResponse |
updateGatewaySoftwareNow(UpdateGatewaySoftwareNowRequest updateGatewaySoftwareNowRequest)
Updates the gateway virtual machine (VM) software.
|
default UpdateMaintenanceStartTimeResponse |
updateMaintenanceStartTime(Consumer<UpdateMaintenanceStartTimeRequest.Builder> updateMaintenanceStartTimeRequest)
Updates a gateway's weekly maintenance start time information, including day and time of the week.
|
default UpdateMaintenanceStartTimeResponse |
updateMaintenanceStartTime(UpdateMaintenanceStartTimeRequest updateMaintenanceStartTimeRequest)
Updates a gateway's weekly maintenance start time information, including day and time of the week.
|
default UpdateNfsFileShareResponse |
updateNFSFileShare(Consumer<UpdateNfsFileShareRequest.Builder> updateNfsFileShareRequest)
Updates a Network File System (NFS) file share.
|
default UpdateNfsFileShareResponse |
updateNFSFileShare(UpdateNfsFileShareRequest updateNfsFileShareRequest)
Updates a Network File System (NFS) file share.
|
default UpdateSmbFileShareResponse |
updateSMBFileShare(Consumer<UpdateSmbFileShareRequest.Builder> updateSmbFileShareRequest)
Updates a Server Message Block (SMB) file share.
|
default UpdateSmbFileShareResponse |
updateSMBFileShare(UpdateSmbFileShareRequest updateSmbFileShareRequest)
Updates a Server Message Block (SMB) file share.
|
default UpdateSnapshotScheduleResponse |
updateSnapshotSchedule(Consumer<UpdateSnapshotScheduleRequest.Builder> updateSnapshotScheduleRequest)
Updates a snapshot schedule configured for a gateway volume.
|
default UpdateSnapshotScheduleResponse |
updateSnapshotSchedule(UpdateSnapshotScheduleRequest updateSnapshotScheduleRequest)
Updates a snapshot schedule configured for a gateway volume.
|
default UpdateVtlDeviceTypeResponse |
updateVTLDeviceType(Consumer<UpdateVtlDeviceTypeRequest.Builder> updateVtlDeviceTypeRequest)
Updates the type of medium changer in a tape gateway.
|
default UpdateVtlDeviceTypeResponse |
updateVTLDeviceType(UpdateVtlDeviceTypeRequest updateVtlDeviceTypeRequest)
Updates the type of medium changer in a tape gateway.
|
serviceNameclosestatic final String SERVICE_NAME
static StorageGatewayClient create()
StorageGatewayClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static StorageGatewayClientBuilder builder()
StorageGatewayClient.default ActivateGatewayResponse activateGateway(ActivateGatewayRequest activateGatewayRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the region 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ActivateGatewayResponse activateGateway(Consumer<ActivateGatewayRequest.Builder> activateGatewayRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the region 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.
This is a convenience which creates an instance of the ActivateGatewayRequest.Builder avoiding the need
to create one manually via ActivateGatewayRequest.builder()
activateGatewayRequest - A Consumer that will call methods on ActivateGatewayInput.Builder to create a request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AddCacheResponse addCache(AddCacheRequest addCacheRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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 Storage Gateway Concepts).
In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AddCacheResponse addCache(Consumer<AddCacheRequest.Builder> addCacheRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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 Storage Gateway Concepts).
In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.
This is a convenience which creates an instance of the AddCacheRequest.Builder avoiding the need to
create one manually via AddCacheRequest.builder()
addCacheRequest - A Consumer that will call methods on AddCacheInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AddTagsToResourceResponse addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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 AWS Storage Gateway resources:
Storage gateways of all types
Storage Volumes
Virtual Tapes
You can create a maximum of 10 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AddTagsToResourceResponse addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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 AWS Storage Gateway resources:
Storage gateways of all types
Storage Volumes
Virtual Tapes
You can create a maximum of 10 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags.
This is a convenience which creates an instance of the AddTagsToResourceRequest.Builder avoiding the need
to create one manually via AddTagsToResourceRequest.builder()
addTagsToResourceRequest - A Consumer that will call methods on AddTagsToResourceInput.Builder to create a request.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AddUploadBufferResponse addUploadBuffer(AddUploadBufferRequest addUploadBufferRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AddUploadBufferResponse addUploadBuffer(Consumer<AddUploadBufferRequest.Builder> addUploadBufferRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the AddUploadBufferRequest.Builder avoiding the need
to create one manually via AddUploadBufferRequest.builder()
addUploadBufferRequest - A Consumer that will call methods on AddUploadBufferInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AddWorkingStorageResponse addWorkingStorage(AddWorkingStorageRequest addWorkingStorageRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AddWorkingStorageResponse addWorkingStorage(Consumer<AddWorkingStorageRequest.Builder> addWorkingStorageRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the AddWorkingStorageRequest.Builder avoiding the need
to create one manually via AddWorkingStorageRequest.builder()
addWorkingStorageRequest - A Consumer that will call methods on AddWorkingStorageInput.Builder to create a request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CancelArchivalResponse cancelArchival(CancelArchivalRequest cancelArchivalRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CancelArchivalResponse cancelArchival(Consumer<CancelArchivalRequest.Builder> cancelArchivalRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the CancelArchivalRequest.Builder avoiding the need to
create one manually via CancelArchivalRequest.builder()
cancelArchivalRequest - A Consumer that will call methods on CancelArchivalInput.Builder to create a request.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CancelRetrievalResponse cancelRetrieval(CancelRetrievalRequest cancelRetrievalRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CancelRetrievalResponse cancelRetrieval(Consumer<CancelRetrievalRequest.Builder> cancelRetrievalRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the CancelRetrievalRequest.Builder avoiding the need
to create one manually via CancelRetrievalRequest.builder()
cancelRetrievalRequest - A Consumer that will call methods on CancelRetrievalInput.Builder to create a request.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateCachediScsiVolumeResponse createCachediSCSIVolume(CreateCachediScsiVolumeRequest createCachediScsiVolumeRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateCachediScsiVolumeResponse createCachediSCSIVolume(Consumer<CreateCachediScsiVolumeRequest.Builder> createCachediScsiVolumeRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the CreateCachediScsiVolumeRequest.Builder avoiding
the need to create one manually via CreateCachediScsiVolumeRequest.builder()
createCachediScsiVolumeRequest - A Consumer that will call methods on CreateCachediSCSIVolumeInput.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateNfsFileShareResponse createNFSFileShare(CreateNfsFileShareRequest createNfsFileShareRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Creates a Network File System (NFS) file share on an existing 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 a NFS interface. This operation is only supported for file gateways.
File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you create a file share. Make sure AWS STS is activated in the region you are creating your file gateway in. If AWS STS is not activated in the region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.
File gateway does 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateNfsFileShareResponse createNFSFileShare(Consumer<CreateNfsFileShareRequest.Builder> createNfsFileShareRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Creates a Network File System (NFS) file share on an existing 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 a NFS interface. This operation is only supported for file gateways.
File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you create a file share. Make sure AWS STS is activated in the region you are creating your file gateway in. If AWS STS is not activated in the region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.
File gateway does not support creating hard or symbolic links on a file share.
This is a convenience which creates an instance of the CreateNfsFileShareRequest.Builder avoiding the
need to create one manually via CreateNfsFileShareRequest.builder()
createNfsFileShareRequest - A Consumer that will call methods on CreateNFSFileShareInput.Builder to create a request.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSmbFileShareResponse createSMBFileShare(CreateSmbFileShareRequest createSmbFileShareRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Creates a Server Message Block (SMB) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway expose file shares using a SMB interface. This operation is only supported for file gateways.
File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSmbFileShareResponse createSMBFileShare(Consumer<CreateSmbFileShareRequest.Builder> createSmbFileShareRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Creates a Server Message Block (SMB) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway expose file shares using a SMB interface. This operation is only supported for file gateways.
File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.
File gateways don't support creating hard or symbolic links on a file share.
This is a convenience which creates an instance of the CreateSmbFileShareRequest.Builder avoiding the
need to create one manually via CreateSmbFileShareRequest.builder()
createSmbFileShareRequest - A Consumer that will call methods on CreateSMBFileShareInput.Builder to create a request.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSnapshotResponse createSnapshot(CreateSnapshotRequest createSnapshotRequest) throws InvalidGatewayRequestException, InternalServerErrorException, ServiceUnavailableErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Initiates a snapshot of a volume.
AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad-hoc basis. This API enables you to take ad-hoc snapshot. For more information, see 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 AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. 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 EC2 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSnapshotResponse createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest) throws InvalidGatewayRequestException, InternalServerErrorException, ServiceUnavailableErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Initiates a snapshot of a volume.
AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad-hoc basis. This API enables you to take ad-hoc snapshot. For more information, see 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 AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. 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 EC2 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.
This is a convenience which creates an instance of the CreateSnapshotRequest.Builder avoiding the need to
create one manually via CreateSnapshotRequest.builder()
createSnapshotRequest - A Consumer that will call methods on CreateSnapshotInput.Builder to create a request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSnapshotFromVolumeRecoveryPointResponse createSnapshotFromVolumeRecoveryPoint(CreateSnapshotFromVolumeRecoveryPointRequest createSnapshotFromVolumeRecoveryPointRequest) throws InvalidGatewayRequestException, InternalServerErrorException, ServiceUnavailableErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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 AWS 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, in 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSnapshotFromVolumeRecoveryPointResponse createSnapshotFromVolumeRecoveryPoint(Consumer<CreateSnapshotFromVolumeRecoveryPointRequest.Builder> createSnapshotFromVolumeRecoveryPointRequest) throws InvalidGatewayRequestException, InternalServerErrorException, ServiceUnavailableErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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 AWS 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, in Amazon Elastic Compute Cloud API Reference.
This is a convenience which creates an instance of the
CreateSnapshotFromVolumeRecoveryPointRequest.Builder avoiding the need to create one manually via
CreateSnapshotFromVolumeRecoveryPointRequest.builder()
createSnapshotFromVolumeRecoveryPointRequest - A Consumer that will call methods on CreateSnapshotFromVolumeRecoveryPointInput.Builder to
create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateStorediScsiVolumeResponse createStorediSCSIVolume(CreateStorediScsiVolumeRequest createStorediScsiVolumeRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateStorediScsiVolumeResponse createStorediSCSIVolume(Consumer<CreateStorediScsiVolumeRequest.Builder> createStorediScsiVolumeRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the CreateStorediScsiVolumeRequest.Builder avoiding
the need to create one manually via CreateStorediScsiVolumeRequest.builder()
createStorediScsiVolumeRequest - A Consumer that will call methods on CreateStorediSCSIVolumeInput.Builder to create a
request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateTapeWithBarcodeResponse createTapeWithBarcode(CreateTapeWithBarcodeRequest createTapeWithBarcodeRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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 can not 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateTapeWithBarcodeResponse createTapeWithBarcode(Consumer<CreateTapeWithBarcodeRequest.Builder> createTapeWithBarcodeRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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 can not 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.
This is a convenience which creates an instance of the CreateTapeWithBarcodeRequest.Builder avoiding the
need to create one manually via CreateTapeWithBarcodeRequest.builder()
createTapeWithBarcodeRequest - A Consumer that will call methods on CreateTapeWithBarcodeInput.Builder to create a
request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateTapesResponse createTapes(CreateTapesRequest createTapesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateTapesResponse createTapes(Consumer<CreateTapesRequest.Builder> createTapesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the CreateTapesRequest.Builder avoiding the need to
create one manually via CreateTapesRequest.builder()
createTapesRequest - A Consumer that will call methods on CreateTapesInput.Builder to create a request.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteBandwidthRateLimitResponse deleteBandwidthRateLimit(DeleteBandwidthRateLimitRequest deleteBandwidthRateLimitRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteBandwidthRateLimitResponse deleteBandwidthRateLimit(Consumer<DeleteBandwidthRateLimitRequest.Builder> deleteBandwidthRateLimitRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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 is a convenience which creates an instance of the DeleteBandwidthRateLimitRequest.Builder avoiding
the need to create one manually via DeleteBandwidthRateLimitRequest.builder()
deleteBandwidthRateLimitRequest - A Consumer that will call methods on DeleteBandwidthRateLimitInput.Builder to create a
request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteChapCredentialsResponse deleteChapCredentials(DeleteChapCredentialsRequest deleteChapCredentialsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteChapCredentialsResponse deleteChapCredentials(Consumer<DeleteChapCredentialsRequest.Builder> deleteChapCredentialsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.
This is a convenience which creates an instance of the DeleteChapCredentialsRequest.Builder avoiding the
need to create one manually via DeleteChapCredentialsRequest.builder()
deleteChapCredentialsRequest - A Consumer that will call methods on DeleteChapCredentialsInput.Builder to create a
request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteFileShareResponse deleteFileShare(DeleteFileShareRequest deleteFileShareRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Deletes a file share from a file gateway. This operation is only supported for 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteFileShareResponse deleteFileShare(Consumer<DeleteFileShareRequest.Builder> deleteFileShareRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Deletes a file share from a file gateway. This operation is only supported for file gateways.
This is a convenience which creates an instance of the DeleteFileShareRequest.Builder avoiding the need
to create one manually via DeleteFileShareRequest.builder()
deleteFileShareRequest - A Consumer that will call methods on DeleteFileShareInput.Builder to create a request.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteGatewayResponse deleteGateway(DeleteGatewayRequest deleteGatewayRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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 AWS 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteGatewayResponse deleteGateway(Consumer<DeleteGatewayRequest.Builder> deleteGatewayRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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 AWS Storage Gateway Detail Page.
This is a convenience which creates an instance of the DeleteGatewayRequest.Builder avoiding the need to
create one manually via DeleteGatewayRequest.builder()
deleteGatewayRequest - A Consumer that will call methods on DeleteGatewayInput.Builder to create a request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteSnapshotScheduleResponse deleteSnapshotSchedule(DeleteSnapshotScheduleRequest deleteSnapshotScheduleRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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 Working with
Snapshots. In the DeleteSnapshotSchedule request, you identify the volume by providing its
Amazon Resource Name (ARN). This operation is only supported in stored and cached volume gateway types.
To list or delete a snapshot, you must use the Amazon EC2 API. in 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteSnapshotScheduleResponse deleteSnapshotSchedule(Consumer<DeleteSnapshotScheduleRequest.Builder> deleteSnapshotScheduleRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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 Working with
Snapshots. In the DeleteSnapshotSchedule request, you identify the volume by providing its
Amazon Resource Name (ARN). This operation is only supported in stored and cached volume gateway types.
To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference.
This is a convenience which creates an instance of the DeleteSnapshotScheduleRequest.Builder avoiding the
need to create one manually via DeleteSnapshotScheduleRequest.builder()
deleteSnapshotScheduleRequest - A Consumer that will call methods on DeleteSnapshotScheduleInput.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteTapeResponse deleteTape(DeleteTapeRequest deleteTapeRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteTapeResponse deleteTape(Consumer<DeleteTapeRequest.Builder> deleteTapeRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Deletes the specified virtual tape. This operation is only supported in the tape gateway type.
This is a convenience which creates an instance of the DeleteTapeRequest.Builder avoiding the need to
create one manually via DeleteTapeRequest.builder()
deleteTapeRequest - A Consumer that will call methods on DeleteTapeInput.Builder to create a request.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteTapeArchiveResponse deleteTapeArchive(DeleteTapeArchiveRequest deleteTapeArchiveRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteTapeArchiveResponse deleteTapeArchive(Consumer<DeleteTapeArchiveRequest.Builder> deleteTapeArchiveRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.
This is a convenience which creates an instance of the DeleteTapeArchiveRequest.Builder avoiding the need
to create one manually via DeleteTapeArchiveRequest.builder()
deleteTapeArchiveRequest - A Consumer that will call methods on DeleteTapeArchiveInput.Builder to create a request.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteVolumeResponse deleteVolume(DeleteVolumeRequest deleteVolumeRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteVolumeResponse deleteVolume(Consumer<DeleteVolumeRequest.Builder> deleteVolumeRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the DeleteVolumeRequest.Builder avoiding the need to
create one manually via DeleteVolumeRequest.builder()
deleteVolumeRequest - A Consumer that will call methods on DeleteVolumeInput.Builder to create a request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeBandwidthRateLimitResponse describeBandwidthRateLimit(DescribeBandwidthRateLimitRequest describeBandwidthRateLimitRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect.
This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
describeBandwidthRateLimitRequest - A JSON object containing the 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeBandwidthRateLimitResponse describeBandwidthRateLimit(Consumer<DescribeBandwidthRateLimitRequest.Builder> describeBandwidthRateLimitRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect.
This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
This is a convenience which creates an instance of the DescribeBandwidthRateLimitRequest.Builder avoiding
the need to create one manually via DescribeBandwidthRateLimitRequest.builder()
describeBandwidthRateLimitRequest - A Consumer that will call methods on DescribeBandwidthRateLimitInput.Builder to create a
request. A JSON object containing the 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCacheResponse describeCache(DescribeCacheRequest describeCacheRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCacheResponse describeCache(Consumer<DescribeCacheRequest.Builder> describeCacheRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the DescribeCacheRequest.Builder avoiding the need to
create one manually via DescribeCacheRequest.builder()
describeCacheRequest - A Consumer that will call methods on DescribeCacheInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCachediScsiVolumesResponse describeCachediSCSIVolumes(DescribeCachediScsiVolumesRequest describeCachediScsiVolumesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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 Amazon 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCachediScsiVolumesResponse describeCachediSCSIVolumes(Consumer<DescribeCachediScsiVolumesRequest.Builder> describeCachediScsiVolumesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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 Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).
This is a convenience which creates an instance of the DescribeCachediScsiVolumesRequest.Builder avoiding
the need to create one manually via DescribeCachediScsiVolumesRequest.builder()
describeCachediScsiVolumesRequest - A Consumer that will call methods on DescribeCachediSCSIVolumesInput.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeChapCredentialsResponse describeChapCredentials(DescribeChapCredentialsRequest describeChapCredentialsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeChapCredentialsResponse describeChapCredentials(Consumer<DescribeChapCredentialsRequest.Builder> describeChapCredentialsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.
This is a convenience which creates an instance of the DescribeChapCredentialsRequest.Builder avoiding
the need to create one manually via DescribeChapCredentialsRequest.builder()
describeChapCredentialsRequest - A Consumer that will call methods on DescribeChapCredentialsInput.Builder to create a
request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeGatewayInformationResponse describeGatewayInformation(DescribeGatewayInformationRequest describeGatewayInformationRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeGatewayInformationResponse describeGatewayInformation(Consumer<DescribeGatewayInformationRequest.Builder> describeGatewayInformationRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
This is a convenience which creates an instance of the DescribeGatewayInformationRequest.Builder avoiding
the need to create one manually via DescribeGatewayInformationRequest.builder()
describeGatewayInformationRequest - A Consumer that will call methods on DescribeGatewayInformationInput.Builder to create a
request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeMaintenanceStartTimeResponse describeMaintenanceStartTime(DescribeMaintenanceStartTimeRequest describeMaintenanceStartTimeRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeMaintenanceStartTimeResponse describeMaintenanceStartTime(Consumer<DescribeMaintenanceStartTimeRequest.Builder> describeMaintenanceStartTimeRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the DescribeMaintenanceStartTimeRequest.Builder
avoiding the need to create one manually via DescribeMaintenanceStartTimeRequest.builder()
describeMaintenanceStartTimeRequest - A Consumer that will call methods on DescribeMaintenanceStartTimeInput.Builder to create a
request. A JSON object containing the 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeNfsFileSharesResponse describeNFSFileShares(DescribeNfsFileSharesRequest describeNfsFileSharesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Gets a description for one or more Network File System (NFS) file shares from a file gateway. This operation is only supported for 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeNfsFileSharesResponse describeNFSFileShares(Consumer<DescribeNfsFileSharesRequest.Builder> describeNfsFileSharesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Gets a description for one or more Network File System (NFS) file shares from a file gateway. This operation is only supported for file gateways.
This is a convenience which creates an instance of the DescribeNfsFileSharesRequest.Builder avoiding the
need to create one manually via DescribeNfsFileSharesRequest.builder()
describeNfsFileSharesRequest - A Consumer that will call methods on DescribeNFSFileSharesInput.Builder to create a
request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSmbFileSharesResponse describeSMBFileShares(DescribeSmbFileSharesRequest describeSmbFileSharesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Gets a description for one or more Server Message Block (SMB) file shares from a file gateway. This operation is only supported for 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSmbFileSharesResponse describeSMBFileShares(Consumer<DescribeSmbFileSharesRequest.Builder> describeSmbFileSharesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Gets a description for one or more Server Message Block (SMB) file shares from a file gateway. This operation is only supported for file gateways.
This is a convenience which creates an instance of the DescribeSmbFileSharesRequest.Builder avoiding the
need to create one manually via DescribeSmbFileSharesRequest.builder()
describeSmbFileSharesRequest - A Consumer that will call methods on DescribeSMBFileSharesInput.Builder to create a
request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSmbSettingsResponse describeSMBSettings(DescribeSmbSettingsRequest describeSmbSettingsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSmbSettingsResponse describeSMBSettings(Consumer<DescribeSmbSettingsRequest.Builder> describeSmbSettingsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.
This is a convenience which creates an instance of the DescribeSmbSettingsRequest.Builder avoiding the
need to create one manually via DescribeSmbSettingsRequest.builder()
describeSmbSettingsRequest - A Consumer that will call methods on DescribeSMBSettingsInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSnapshotScheduleResponse describeSnapshotSchedule(DescribeSnapshotScheduleRequest describeSnapshotScheduleRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSnapshotScheduleResponse describeSnapshotSchedule(Consumer<DescribeSnapshotScheduleRequest.Builder> describeSnapshotScheduleRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the DescribeSnapshotScheduleRequest.Builder avoiding
the need to create one manually via DescribeSnapshotScheduleRequest.builder()
describeSnapshotScheduleRequest - A Consumer that will call methods on DescribeSnapshotScheduleInput.Builder to create a
request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStorediScsiVolumesResponse describeStorediSCSIVolumes(DescribeStorediScsiVolumesRequest describeStorediScsiVolumesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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 Amazon 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStorediScsiVolumesResponse describeStorediSCSIVolumes(Consumer<DescribeStorediScsiVolumesRequest.Builder> describeStorediScsiVolumesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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 Amazon Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.
This is a convenience which creates an instance of the DescribeStorediScsiVolumesRequest.Builder avoiding
the need to create one manually via DescribeStorediScsiVolumesRequest.builder()
describeStorediScsiVolumesRequest - A Consumer that will call methods on DescribeStorediSCSIVolumesInput.Builder to create a
request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTapeArchivesResponse describeTapeArchives() throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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, AWS Storage Gateway returns a description of all virtual
tapes found in the VTS associated with your account.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeTapeArchives(DescribeTapeArchivesRequest),
AWS API Documentationdefault DescribeTapeArchivesResponse describeTapeArchives(DescribeTapeArchivesRequest describeTapeArchivesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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, AWS 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTapeArchivesResponse describeTapeArchives(Consumer<DescribeTapeArchivesRequest.Builder> describeTapeArchivesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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, AWS Storage Gateway returns a description of all virtual
tapes found in the VTS associated with your account.
This is a convenience which creates an instance of the DescribeTapeArchivesRequest.Builder avoiding the
need to create one manually via DescribeTapeArchivesRequest.builder()
describeTapeArchivesRequest - A Consumer that will call methods on DescribeTapeArchivesInput.Builder to create a
request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTapeArchivesIterable describeTapeArchivesPaginator() throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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, AWS Storage Gateway returns a description of all virtual
tapes found in the VTS associated with your account.
This is a variant of
describeTapeArchives(software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeArchivesIterable responses = client.describeTapeArchivesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeArchivesIterable responses = client
.describeTapeArchivesPaginator(request);
for (software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeArchivesIterable responses = client.describeTapeArchivesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeTapeArchives(software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesRequest)
operation.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeTapeArchivesPaginator(DescribeTapeArchivesRequest),
AWS API Documentationdefault DescribeTapeArchivesIterable describeTapeArchivesPaginator(DescribeTapeArchivesRequest describeTapeArchivesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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, AWS Storage Gateway returns a description of all virtual
tapes found in the VTS associated with your account.
This is a variant of
describeTapeArchives(software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeArchivesIterable responses = client.describeTapeArchivesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeArchivesIterable responses = client
.describeTapeArchivesPaginator(request);
for (software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeArchivesIterable responses = client.describeTapeArchivesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeTapeArchives(software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesRequest)
operation.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTapeArchivesIterable describeTapeArchivesPaginator(Consumer<DescribeTapeArchivesRequest.Builder> describeTapeArchivesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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, AWS Storage Gateway returns a description of all virtual
tapes found in the VTS associated with your account.
This is a variant of
describeTapeArchives(software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeArchivesIterable responses = client.describeTapeArchivesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeArchivesIterable responses = client
.describeTapeArchivesPaginator(request);
for (software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeArchivesIterable responses = client.describeTapeArchivesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeTapeArchives(software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesRequest)
operation.
This is a convenience which creates an instance of the DescribeTapeArchivesRequest.Builder avoiding the
need to create one manually via DescribeTapeArchivesRequest.builder()
describeTapeArchivesRequest - A Consumer that will call methods on DescribeTapeArchivesInput.Builder to create a
request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTapeRecoveryPointsResponse describeTapeRecoveryPoints(DescribeTapeRecoveryPointsRequest describeTapeRecoveryPointsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTapeRecoveryPointsResponse describeTapeRecoveryPoints(Consumer<DescribeTapeRecoveryPointsRequest.Builder> describeTapeRecoveryPointsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the DescribeTapeRecoveryPointsRequest.Builder avoiding
the need to create one manually via DescribeTapeRecoveryPointsRequest.builder()
describeTapeRecoveryPointsRequest - A Consumer that will call methods on DescribeTapeRecoveryPointsInput.Builder to create a
request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTapeRecoveryPointsIterable describeTapeRecoveryPointsPaginator(DescribeTapeRecoveryPointsRequest describeTapeRecoveryPointsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a variant of
describeTapeRecoveryPoints(software.amazon.awssdk.services.storagegateway.model.DescribeTapeRecoveryPointsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeRecoveryPointsIterable responses = client.describeTapeRecoveryPointsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeRecoveryPointsIterable responses = client
.describeTapeRecoveryPointsPaginator(request);
for (software.amazon.awssdk.services.storagegateway.model.DescribeTapeRecoveryPointsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeRecoveryPointsIterable responses = client.describeTapeRecoveryPointsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeTapeRecoveryPoints(software.amazon.awssdk.services.storagegateway.model.DescribeTapeRecoveryPointsRequest)
operation.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTapeRecoveryPointsIterable describeTapeRecoveryPointsPaginator(Consumer<DescribeTapeRecoveryPointsRequest.Builder> describeTapeRecoveryPointsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a variant of
describeTapeRecoveryPoints(software.amazon.awssdk.services.storagegateway.model.DescribeTapeRecoveryPointsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeRecoveryPointsIterable responses = client.describeTapeRecoveryPointsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeRecoveryPointsIterable responses = client
.describeTapeRecoveryPointsPaginator(request);
for (software.amazon.awssdk.services.storagegateway.model.DescribeTapeRecoveryPointsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeRecoveryPointsIterable responses = client.describeTapeRecoveryPointsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeTapeRecoveryPoints(software.amazon.awssdk.services.storagegateway.model.DescribeTapeRecoveryPointsRequest)
operation.
This is a convenience which creates an instance of the DescribeTapeRecoveryPointsRequest.Builder avoiding
the need to create one manually via DescribeTapeRecoveryPointsRequest.builder()
describeTapeRecoveryPointsRequest - A Consumer that will call methods on DescribeTapeRecoveryPointsInput.Builder to create a
request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTapesResponse describeTapes(DescribeTapesRequest describeTapesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTapesResponse describeTapes(Consumer<DescribeTapesRequest.Builder> describeTapesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the DescribeTapesRequest.Builder avoiding the need to
create one manually via DescribeTapesRequest.builder()
describeTapesRequest - A Consumer that will call methods on DescribeTapesInput.Builder to create a request.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTapesIterable describeTapesPaginator(DescribeTapesRequest describeTapesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a variant of
describeTapes(software.amazon.awssdk.services.storagegateway.model.DescribeTapesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.storagegateway.paginators.DescribeTapesIterable responses = client.describeTapesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.storagegateway.paginators.DescribeTapesIterable responses = client
.describeTapesPaginator(request);
for (software.amazon.awssdk.services.storagegateway.model.DescribeTapesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.storagegateway.paginators.DescribeTapesIterable responses = client.describeTapesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeTapes(software.amazon.awssdk.services.storagegateway.model.DescribeTapesRequest) operation.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTapesIterable describeTapesPaginator(Consumer<DescribeTapesRequest.Builder> describeTapesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a variant of
describeTapes(software.amazon.awssdk.services.storagegateway.model.DescribeTapesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.storagegateway.paginators.DescribeTapesIterable responses = client.describeTapesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.storagegateway.paginators.DescribeTapesIterable responses = client
.describeTapesPaginator(request);
for (software.amazon.awssdk.services.storagegateway.model.DescribeTapesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.storagegateway.paginators.DescribeTapesIterable responses = client.describeTapesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeTapes(software.amazon.awssdk.services.storagegateway.model.DescribeTapesRequest) operation.
This is a convenience which creates an instance of the DescribeTapesRequest.Builder avoiding the need to
create one manually via DescribeTapesRequest.builder()
describeTapesRequest - A Consumer that will call methods on DescribeTapesInput.Builder to create a request.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeUploadBufferResponse describeUploadBuffer(DescribeUploadBufferRequest describeUploadBufferRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeUploadBufferResponse describeUploadBuffer(Consumer<DescribeUploadBufferRequest.Builder> describeUploadBufferRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the DescribeUploadBufferRequest.Builder avoiding the
need to create one manually via DescribeUploadBufferRequest.builder()
describeUploadBufferRequest - A Consumer that will call methods on DescribeUploadBufferInput.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeVtlDevicesResponse describeVTLDevices(DescribeVtlDevicesRequest describeVtlDevicesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, AWS 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeVtlDevicesResponse describeVTLDevices(Consumer<DescribeVtlDevicesRequest.Builder> describeVtlDevicesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, AWS Storage Gateway returns VTL device information.
This operation is only supported in the tape gateway type.
This is a convenience which creates an instance of the DescribeVtlDevicesRequest.Builder avoiding the
need to create one manually via DescribeVtlDevicesRequest.builder()
describeVtlDevicesRequest - A Consumer that will call methods on DescribeVTLDevicesInput.Builder to create a request.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeVTLDevicesIterable describeVTLDevicesPaginator(DescribeVtlDevicesRequest describeVtlDevicesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, AWS Storage Gateway returns VTL device information.
This operation is only supported in the tape gateway type.
This is a variant of
describeVTLDevices(software.amazon.awssdk.services.storagegateway.model.DescribeVtlDevicesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.storagegateway.paginators.DescribeVTLDevicesIterable responses = client.describeVTLDevicesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.storagegateway.paginators.DescribeVTLDevicesIterable responses = client
.describeVTLDevicesPaginator(request);
for (software.amazon.awssdk.services.storagegateway.model.DescribeVtlDevicesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.storagegateway.paginators.DescribeVTLDevicesIterable responses = client.describeVTLDevicesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeVTLDevices(software.amazon.awssdk.services.storagegateway.model.DescribeVtlDevicesRequest)
operation.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeVTLDevicesIterable describeVTLDevicesPaginator(Consumer<DescribeVtlDevicesRequest.Builder> describeVtlDevicesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, AWS Storage Gateway returns VTL device information.
This operation is only supported in the tape gateway type.
This is a variant of
describeVTLDevices(software.amazon.awssdk.services.storagegateway.model.DescribeVtlDevicesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.storagegateway.paginators.DescribeVTLDevicesIterable responses = client.describeVTLDevicesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.storagegateway.paginators.DescribeVTLDevicesIterable responses = client
.describeVTLDevicesPaginator(request);
for (software.amazon.awssdk.services.storagegateway.model.DescribeVtlDevicesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.storagegateway.paginators.DescribeVTLDevicesIterable responses = client.describeVTLDevicesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeVTLDevices(software.amazon.awssdk.services.storagegateway.model.DescribeVtlDevicesRequest)
operation.
This is a convenience which creates an instance of the DescribeVtlDevicesRequest.Builder avoiding the
need to create one manually via DescribeVtlDevicesRequest.builder()
describeVtlDevicesRequest - A Consumer that will call methods on DescribeVTLDevicesInput.Builder to create a request.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeWorkingStorageResponse describeWorkingStorage(DescribeWorkingStorageRequest describeWorkingStorageRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeWorkingStorageResponse describeWorkingStorage(Consumer<DescribeWorkingStorageRequest.Builder> describeWorkingStorageRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the DescribeWorkingStorageRequest.Builder avoiding the
need to create one manually via DescribeWorkingStorageRequest.builder()
describeWorkingStorageRequest - A Consumer that will call methods on DescribeWorkingStorageInput.Builder to create a
request. A JSON object containing the 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisableGatewayResponse disableGateway(DisableGatewayRequest disableGatewayRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
Once 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisableGatewayResponse disableGateway(Consumer<DisableGatewayRequest.Builder> disableGatewayRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
Once a gateway is disabled it cannot be enabled.
This is a convenience which creates an instance of the DisableGatewayRequest.Builder avoiding the need to
create one manually via DisableGatewayRequest.builder()
disableGatewayRequest - A Consumer that will call methods on DisableGatewayInput.Builder to create a request.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault JoinDomainResponse joinDomain(JoinDomainRequest joinDomainRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault JoinDomainResponse joinDomain(Consumer<JoinDomainRequest.Builder> joinDomainRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.
This is a convenience which creates an instance of the JoinDomainRequest.Builder avoiding the need to
create one manually via JoinDomainRequest.builder()
joinDomainRequest - A Consumer that will call methods on JoinDomainInput.Builder to create a request.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFileSharesResponse listFileShares() throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling user account. This operation is only supported for file gateways.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistFileShares(ListFileSharesRequest),
AWS
API Documentationdefault ListFileSharesResponse listFileShares(ListFileSharesRequest listFileSharesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling user account. This operation is only supported for 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFileSharesResponse listFileShares(Consumer<ListFileSharesRequest.Builder> listFileSharesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling user account. This operation is only supported for file gateways.
This is a convenience which creates an instance of the ListFileSharesRequest.Builder avoiding the need to
create one manually via ListFileSharesRequest.builder()
listFileSharesRequest - A Consumer that will call methods on ListFileSharesInput.Builder to create a request.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGatewaysResponse listGateways() throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Lists gateways owned by an AWS account in a 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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistGateways(ListGatewaysRequest),
AWS
API Documentationdefault ListGatewaysResponse listGateways(ListGatewaysRequest listGatewaysRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Lists gateways owned by an AWS account in a 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGatewaysResponse listGateways(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Lists gateways owned by an AWS account in a 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.
This is a convenience which creates an instance of the ListGatewaysRequest.Builder avoiding the need to
create one manually via ListGatewaysRequest.builder()
listGatewaysRequest - A Consumer that will call methods on ListGatewaysInput.Builder to create a request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGatewaysIterable listGatewaysPaginator() throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Lists gateways owned by an AWS account in a 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.
This is a variant of
listGateways(software.amazon.awssdk.services.storagegateway.model.ListGatewaysRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.storagegateway.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.storagegateway.paginators.ListGatewaysIterable responses = client
.listGatewaysPaginator(request);
for (software.amazon.awssdk.services.storagegateway.model.ListGatewaysResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.storagegateway.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listGateways(software.amazon.awssdk.services.storagegateway.model.ListGatewaysRequest) operation.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistGatewaysPaginator(ListGatewaysRequest),
AWS
API Documentationdefault ListGatewaysIterable listGatewaysPaginator(ListGatewaysRequest listGatewaysRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Lists gateways owned by an AWS account in a 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.
This is a variant of
listGateways(software.amazon.awssdk.services.storagegateway.model.ListGatewaysRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.storagegateway.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.storagegateway.paginators.ListGatewaysIterable responses = client
.listGatewaysPaginator(request);
for (software.amazon.awssdk.services.storagegateway.model.ListGatewaysResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.storagegateway.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listGateways(software.amazon.awssdk.services.storagegateway.model.ListGatewaysRequest) operation.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGatewaysIterable listGatewaysPaginator(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Lists gateways owned by an AWS account in a 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.
This is a variant of
listGateways(software.amazon.awssdk.services.storagegateway.model.ListGatewaysRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.storagegateway.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.storagegateway.paginators.ListGatewaysIterable responses = client
.listGatewaysPaginator(request);
for (software.amazon.awssdk.services.storagegateway.model.ListGatewaysResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.storagegateway.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listGateways(software.amazon.awssdk.services.storagegateway.model.ListGatewaysRequest) operation.
This is a convenience which creates an instance of the ListGatewaysRequest.Builder avoiding the need to
create one manually via ListGatewaysRequest.builder()
listGatewaysRequest - A Consumer that will call methods on ListGatewaysInput.Builder to create a request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListLocalDisksResponse listLocalDisks(ListLocalDisksRequest listLocalDisksRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListLocalDisksResponse listLocalDisks(Consumer<ListLocalDisksRequest.Builder> listLocalDisksRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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).
This is a convenience which creates an instance of the ListLocalDisksRequest.Builder avoiding the need to
create one manually via ListLocalDisksRequest.builder()
listLocalDisksRequest - A Consumer that will call methods on ListLocalDisksInput.Builder to create a request. A
JSON object containing the 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Lists the tags that have been added to the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway type.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Lists the tags that have been added to the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway type.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceInput.Builder to create a request.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTapesResponse listTapes() throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistTapes(ListTapesRequest),
AWS API
Documentationdefault ListTapesResponse listTapes(ListTapesRequest listTapesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTapesResponse listTapes(Consumer<ListTapesRequest.Builder> listTapesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the ListTapesRequest.Builder avoiding the need to
create one manually via ListTapesRequest.builder()
listTapesRequest - A Consumer that will call methods on ListTapesInput.Builder to create a request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListVolumeInitiatorsResponse listVolumeInitiators(ListVolumeInitiatorsRequest listVolumeInitiatorsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListVolumeInitiatorsResponse listVolumeInitiators(Consumer<ListVolumeInitiatorsRequest.Builder> listVolumeInitiatorsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the ListVolumeInitiatorsRequest.Builder avoiding the
need to create one manually via ListVolumeInitiatorsRequest.builder()
listVolumeInitiatorsRequest - A Consumer that will call methods on ListVolumeInitiatorsInput.Builder to create a
request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListVolumeRecoveryPointsResponse listVolumeRecoveryPoints(ListVolumeRecoveryPointsRequest listVolumeRecoveryPointsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListVolumeRecoveryPointsResponse listVolumeRecoveryPoints(Consumer<ListVolumeRecoveryPointsRequest.Builder> listVolumeRecoveryPointsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the ListVolumeRecoveryPointsRequest.Builder avoiding
the need to create one manually via ListVolumeRecoveryPointsRequest.builder()
listVolumeRecoveryPointsRequest - A Consumer that will call methods on ListVolumeRecoveryPointsInput.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListVolumesResponse listVolumes() throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistVolumes(ListVolumesRequest),
AWS API
Documentationdefault ListVolumesResponse listVolumes(ListVolumesRequest listVolumesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListVolumesResponse listVolumes(Consumer<ListVolumesRequest.Builder> listVolumesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the ListVolumesRequest.Builder avoiding the need to
create one manually via ListVolumesRequest.builder()
listVolumesRequest - A Consumer that will call methods on ListVolumesInput.Builder to create a request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListVolumesIterable listVolumesPaginator() throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a variant of
listVolumes(software.amazon.awssdk.services.storagegateway.model.ListVolumesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.storagegateway.paginators.ListVolumesIterable responses = client.listVolumesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.storagegateway.paginators.ListVolumesIterable responses = client
.listVolumesPaginator(request);
for (software.amazon.awssdk.services.storagegateway.model.ListVolumesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.storagegateway.paginators.ListVolumesIterable responses = client.listVolumesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listVolumes(software.amazon.awssdk.services.storagegateway.model.ListVolumesRequest) operation.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistVolumesPaginator(ListVolumesRequest),
AWS API
Documentationdefault ListVolumesIterable listVolumesPaginator(ListVolumesRequest listVolumesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a variant of
listVolumes(software.amazon.awssdk.services.storagegateway.model.ListVolumesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.storagegateway.paginators.ListVolumesIterable responses = client.listVolumesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.storagegateway.paginators.ListVolumesIterable responses = client
.listVolumesPaginator(request);
for (software.amazon.awssdk.services.storagegateway.model.ListVolumesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.storagegateway.paginators.ListVolumesIterable responses = client.listVolumesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listVolumes(software.amazon.awssdk.services.storagegateway.model.ListVolumesRequest) operation.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListVolumesIterable listVolumesPaginator(Consumer<ListVolumesRequest.Builder> listVolumesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a variant of
listVolumes(software.amazon.awssdk.services.storagegateway.model.ListVolumesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.storagegateway.paginators.ListVolumesIterable responses = client.listVolumesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.storagegateway.paginators.ListVolumesIterable responses = client
.listVolumesPaginator(request);
for (software.amazon.awssdk.services.storagegateway.model.ListVolumesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.storagegateway.paginators.ListVolumesIterable responses = client.listVolumesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listVolumes(software.amazon.awssdk.services.storagegateway.model.ListVolumesRequest) operation.
This is a convenience which creates an instance of the ListVolumesRequest.Builder avoiding the need to
create one manually via ListVolumesRequest.builder()
listVolumesRequest - A Consumer that will call methods on ListVolumesInput.Builder to create a request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault NotifyWhenUploadedResponse notifyWhenUploaded(NotifyWhenUploadedRequest notifyWhenUploadedRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Sends you notification through CloudWatch Events when all files written to your NFS file share have been uploaded to Amazon S3.
AWS 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 NFS 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 AWS Lambda function. This operation is only supported for file gateways.
For more information, see Getting File Upload Notification in the Storage Gateway User Guide (https://docs.aws.amazon .com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification).
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault NotifyWhenUploadedResponse notifyWhenUploaded(Consumer<NotifyWhenUploadedRequest.Builder> notifyWhenUploadedRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Sends you notification through CloudWatch Events when all files written to your NFS file share have been uploaded to Amazon S3.
AWS 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 NFS 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 AWS Lambda function. This operation is only supported for file gateways.
For more information, see Getting File Upload Notification in the Storage Gateway User Guide (https://docs.aws.amazon .com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification).
This is a convenience which creates an instance of the NotifyWhenUploadedRequest.Builder avoiding the
need to create one manually via NotifyWhenUploadedRequest.builder()
notifyWhenUploadedRequest - A Consumer that will call methods on NotifyWhenUploadedInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RefreshCacheResponse refreshCache(RefreshCacheRequest refreshCacheRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Refreshes the cache 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 is only supported in the file gateway type. 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.
refreshCacheRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RefreshCacheResponse refreshCache(Consumer<RefreshCacheRequest.Builder> refreshCacheRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Refreshes the cache 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 is only supported in the file gateway type. 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.
This is a convenience which creates an instance of the RefreshCacheRequest.Builder avoiding the need to
create one manually via RefreshCacheRequest.builder()
refreshCacheRequest - A Consumer that will call methods on RefreshCacheInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Removes one or more tags from the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemoveTagsFromResourceResponse removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Removes one or more tags from the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway types.
This is a convenience which creates an instance of the RemoveTagsFromResourceRequest.Builder avoiding the
need to create one manually via RemoveTagsFromResourceRequest.builder()
removeTagsFromResourceRequest - A Consumer that will call methods on RemoveTagsFromResourceInput.Builder to create a
request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ResetCacheResponse resetCache(ResetCacheRequest resetCacheRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ResetCacheResponse resetCache(Consumer<ResetCacheRequest.Builder> resetCacheRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a 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.
This is a convenience which creates an instance of the ResetCacheRequest.Builder avoiding the need to
create one manually via ResetCacheRequest.builder()
resetCacheRequest - A Consumer that will call methods on ResetCacheInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RetrieveTapeArchiveResponse retrieveTapeArchive(RetrieveTapeArchiveRequest retrieveTapeArchiveRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RetrieveTapeArchiveResponse retrieveTapeArchive(Consumer<RetrieveTapeArchiveRequest.Builder> retrieveTapeArchiveRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the RetrieveTapeArchiveRequest.Builder avoiding the
need to create one manually via RetrieveTapeArchiveRequest.builder()
retrieveTapeArchiveRequest - A Consumer that will call methods on RetrieveTapeArchiveInput.Builder to create a request.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RetrieveTapeRecoveryPointResponse retrieveTapeRecoveryPoint(RetrieveTapeRecoveryPointRequest retrieveTapeRecoveryPointRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RetrieveTapeRecoveryPointResponse retrieveTapeRecoveryPoint(Consumer<RetrieveTapeRecoveryPointRequest.Builder> retrieveTapeRecoveryPointRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the RetrieveTapeRecoveryPointRequest.Builder avoiding
the need to create one manually via RetrieveTapeRecoveryPointRequest.builder()
retrieveTapeRecoveryPointRequest - A Consumer that will call methods on RetrieveTapeRecoveryPointInput.Builder to create a
request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SetLocalConsolePasswordResponse setLocalConsolePassword(SetLocalConsolePasswordRequest setLocalConsolePasswordRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SetLocalConsolePasswordResponse setLocalConsolePassword(Consumer<SetLocalConsolePasswordRequest.Builder> setLocalConsolePasswordRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the SetLocalConsolePasswordRequest.Builder avoiding
the need to create one manually via SetLocalConsolePasswordRequest.builder()
setLocalConsolePasswordRequest - A Consumer that will call methods on SetLocalConsolePasswordInput.Builder to create a
request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SetSmbGuestPasswordResponse setSMBGuestPassword(SetSmbGuestPasswordRequest setSmbGuestPasswordRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SetSmbGuestPasswordResponse setSMBGuestPassword(Consumer<SetSmbGuestPasswordRequest.Builder> setSmbGuestPasswordRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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 is a convenience which creates an instance of the SetSmbGuestPasswordRequest.Builder avoiding the
need to create one manually via SetSmbGuestPasswordRequest.builder()
setSmbGuestPasswordRequest - A Consumer that will call methods on SetSMBGuestPasswordInput.Builder to create a request.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ShutdownGatewayResponse shutdownGateway(ShutdownGatewayRequest shutdownGatewayRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ShutdownGatewayResponse shutdownGateway(Consumer<ShutdownGatewayRequest.Builder> shutdownGatewayRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the ShutdownGatewayRequest.Builder avoiding the need
to create one manually via ShutdownGatewayRequest.builder()
shutdownGatewayRequest - A Consumer that will call methods on ShutdownGatewayInput.Builder to create a request. A
JSON object containing the 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartGatewayResponse startGateway(StartGatewayRequest startGatewayRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartGatewayResponse startGateway(Consumer<StartGatewayRequest.Builder> startGatewayRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the StartGatewayRequest.Builder avoiding the need to
create one manually via StartGatewayRequest.builder()
startGatewayRequest - A Consumer that will call methods on StartGatewayInput.Builder to create a request. A JSON
object containing the 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateBandwidthRateLimitResponse updateBandwidthRateLimit(UpdateBandwidthRateLimitRequest updateBandwidthRateLimitRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateBandwidthRateLimitResponse updateBandwidthRateLimit(Consumer<UpdateBandwidthRateLimitRequest.Builder> updateBandwidthRateLimitRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
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.
This is a convenience which creates an instance of the UpdateBandwidthRateLimitRequest.Builder avoiding
the need to create one manually via UpdateBandwidthRateLimitRequest.builder()
updateBandwidthRateLimitRequest - A Consumer that will call methods on UpdateBandwidthRateLimitInput.Builder to create a
request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateChapCredentialsResponse updateChapCredentials(UpdateChapCredentialsRequest updateChapCredentialsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateChapCredentialsResponse updateChapCredentials(Consumer<UpdateChapCredentialsRequest.Builder> updateChapCredentialsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.
This is a convenience which creates an instance of the UpdateChapCredentialsRequest.Builder avoiding the
need to create one manually via UpdateChapCredentialsRequest.builder()
updateChapCredentialsRequest - A Consumer that will call methods on UpdateChapCredentialsInput.Builder to create a
request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateGatewayInformationResponse updateGatewayInformation(UpdateGatewayInformationRequest updateGatewayInformationRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateGatewayInformationResponse updateGatewayInformation(Consumer<UpdateGatewayInformationRequest.Builder> updateGatewayInformationRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the UpdateGatewayInformationRequest.Builder avoiding
the need to create one manually via UpdateGatewayInformationRequest.builder()
updateGatewayInformationRequest - A Consumer that will call methods on UpdateGatewayInformationInput.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateGatewaySoftwareNowResponse updateGatewaySoftwareNow(UpdateGatewaySoftwareNowRequest updateGatewaySoftwareNowRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateGatewaySoftwareNowResponse updateGatewaySoftwareNow(Consumer<UpdateGatewaySoftwareNowRequest.Builder> updateGatewaySoftwareNowRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the UpdateGatewaySoftwareNowRequest.Builder avoiding
the need to create one manually via UpdateGatewaySoftwareNowRequest.builder()
updateGatewaySoftwareNowRequest - A Consumer that will call methods on UpdateGatewaySoftwareNowInput.Builder to create a
request. A JSON object containing the 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateMaintenanceStartTimeResponse updateMaintenanceStartTime(UpdateMaintenanceStartTimeRequest updateMaintenanceStartTimeRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateMaintenanceStartTimeResponse updateMaintenanceStartTime(Consumer<UpdateMaintenanceStartTimeRequest.Builder> updateMaintenanceStartTimeRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the UpdateMaintenanceStartTimeRequest.Builder avoiding
the need to create one manually via UpdateMaintenanceStartTimeRequest.builder()
updateMaintenanceStartTimeRequest - A Consumer that will call methods on UpdateMaintenanceStartTimeInput.Builder to create a
request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateNfsFileShareResponse updateNFSFileShare(UpdateNfsFileShareRequest updateNfsFileShareRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Updates a Network File System (NFS) file share. This operation is only supported in the file gateway type.
To leave a file share field unchanged, set the corresponding input field to null.
Updates the following file share setting:
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
To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported in file gateways.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateNfsFileShareResponse updateNFSFileShare(Consumer<UpdateNfsFileShareRequest.Builder> updateNfsFileShareRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Updates a Network File System (NFS) file share. This operation is only supported in the file gateway type.
To leave a file share field unchanged, set the corresponding input field to null.
Updates the following file share setting:
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
To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported in file gateways.
This is a convenience which creates an instance of the UpdateNfsFileShareRequest.Builder avoiding the
need to create one manually via UpdateNfsFileShareRequest.builder()
updateNfsFileShareRequest - A Consumer that will call methods on UpdateNFSFileShareInput.Builder to create a request.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateSmbFileShareResponse updateSMBFileShare(UpdateSmbFileShareRequest updateSmbFileShareRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Updates a Server Message Block (SMB) file share.
To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported for file gateways.
File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateSmbFileShareResponse updateSMBFileShare(Consumer<UpdateSmbFileShareRequest.Builder> updateSmbFileShareRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
Updates a Server Message Block (SMB) file share.
To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported for file gateways.
File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.
File gateways don't support creating hard or symbolic links on a file share.
This is a convenience which creates an instance of the UpdateSmbFileShareRequest.Builder avoiding the
need to create one manually via UpdateSmbFileShareRequest.builder()
updateSmbFileShareRequest - A Consumer that will call methods on UpdateSMBFileShareInput.Builder to create a request.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateSnapshotScheduleResponse updateSnapshotSchedule(UpdateSnapshotScheduleRequest updateSnapshotScheduleRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateSnapshotScheduleResponse updateSnapshotSchedule(Consumer<UpdateSnapshotScheduleRequest.Builder> updateSnapshotScheduleRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the UpdateSnapshotScheduleRequest.Builder avoiding the
need to create one manually via UpdateSnapshotScheduleRequest.builder()
updateSnapshotScheduleRequest - A Consumer that will call methods on UpdateSnapshotScheduleInput.Builder to create a
request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateVtlDeviceTypeResponse updateVTLDeviceType(UpdateVtlDeviceTypeRequest updateVtlDeviceTypeRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateVtlDeviceTypeResponse updateVTLDeviceType(Consumer<UpdateVtlDeviceTypeRequest.Builder> updateVtlDeviceTypeRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException
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.
This is a convenience which creates an instance of the UpdateVtlDeviceTypeRequest.Builder avoiding the
need to create one manually via UpdateVtlDeviceTypeRequest.builder()
updateVtlDeviceTypeRequest - A Consumer that will call methods on UpdateVTLDeviceTypeInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.StorageGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.