Interface StorageGatewayClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.
Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization's on-premises IT environment and the Amazon Web Services storage infrastructure. The service enables you to securely upload data to the Amazon Web Services Cloud for cost effective backup and rapid disaster recovery.
Use the following links to get started using the Storage Gateway Service API Reference:
-
Storage Gateway required request headers: Describes the required headers that you must send with every POST request to Storage Gateway.
-
Signing requests: Storage Gateway requires that you authenticate every request you send; this topic describes how sign such a request.
-
Error responses: Provides reference information about Storage Gateway errors.
-
Operations in Storage Gateway: Contains detailed descriptions of all Storage Gateway operations, their request parameters, response elements, possible errors, and examples of requests and responses.
-
Storage Gateway endpoints and quotas: Provides a list of each Amazon Web Services Region and the endpoints available for use with Storage Gateway.
Storage Gateway resource IDs are in uppercase. When you use these resource IDs with the Amazon EC2 API, EC2 expects
resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For example, in
Storage Gateway the ID for a volume might be vol-AA22BB012345DAF670. When you use this ID with the EC2
API, you must change it to vol-aa22bb012345daf670. Otherwise, the EC2 API might not behave as expected.
IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes are changing to a longer format. Starting in December 2016, all new volumes and snapshots will be created with a 17-character string. Starting in April 2016, you will be able to use these longer IDs so you can test your systems with the new format. For more information, see Longer EC2 and EBS resource IDs.
For example, a volume Amazon Resource Name (ARN) with the longer volume ID format looks like the following:
arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.
A snapshot ID with the longer ID format looks like the following: snap-78e226633445566ee.
For more information, see Announcement: Heads-up – Longer Storage Gateway volume and snapshot IDs coming in 2016.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptiondefault ActivateGatewayResponseactivateGateway(Consumer<ActivateGatewayRequest.Builder> activateGatewayRequest) Activates the gateway you previously deployed on your host.default ActivateGatewayResponseactivateGateway(ActivateGatewayRequest activateGatewayRequest) Activates the gateway you previously deployed on your host.default AddCacheResponseaddCache(Consumer<AddCacheRequest.Builder> addCacheRequest) Configures one or more gateway local disks as cache for a gateway.default AddCacheResponseaddCache(AddCacheRequest addCacheRequest) Configures one or more gateway local disks as cache for a gateway.default AddTagsToResourceResponseaddTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) Adds one or more tags to the specified resource.default AddTagsToResourceResponseaddTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) Adds one or more tags to the specified resource.default AddUploadBufferResponseaddUploadBuffer(Consumer<AddUploadBufferRequest.Builder> addUploadBufferRequest) Configures one or more gateway local disks as upload buffer for a specified gateway.default AddUploadBufferResponseaddUploadBuffer(AddUploadBufferRequest addUploadBufferRequest) Configures one or more gateway local disks as upload buffer for a specified gateway.default AddWorkingStorageResponseaddWorkingStorage(Consumer<AddWorkingStorageRequest.Builder> addWorkingStorageRequest) Configures one or more gateway local disks as working storage for a gateway.default AddWorkingStorageResponseaddWorkingStorage(AddWorkingStorageRequest addWorkingStorageRequest) Configures one or more gateway local disks as working storage for a gateway.default AssignTapePoolResponseassignTapePool(Consumer<AssignTapePoolRequest.Builder> assignTapePoolRequest) Assigns a tape to a tape pool for archiving.default AssignTapePoolResponseassignTapePool(AssignTapePoolRequest assignTapePoolRequest) Assigns a tape to a tape pool for archiving.default AssociateFileSystemResponseassociateFileSystem(Consumer<AssociateFileSystemRequest.Builder> associateFileSystemRequest) Associate an Amazon FSx file system with the FSx File Gateway.default AssociateFileSystemResponseassociateFileSystem(AssociateFileSystemRequest associateFileSystemRequest) Associate an Amazon FSx file system with the FSx File Gateway.default AttachVolumeResponseattachVolume(Consumer<AttachVolumeRequest.Builder> attachVolumeRequest) Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway.default AttachVolumeResponseattachVolume(AttachVolumeRequest attachVolumeRequest) Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway.static StorageGatewayClientBuilderbuilder()Create a builder that can be used to configure and create aStorageGatewayClient.default CancelArchivalResponsecancelArchival(Consumer<CancelArchivalRequest.Builder> cancelArchivalRequest) Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.default CancelArchivalResponsecancelArchival(CancelArchivalRequest cancelArchivalRequest) Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.default CancelRetrievalResponsecancelRetrieval(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.default CancelRetrievalResponsecancelRetrieval(CancelRetrievalRequest cancelRetrievalRequest) Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated.static StorageGatewayClientcreate()Create aStorageGatewayClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateCachediScsiVolumeResponsecreateCachediSCSIVolume(Consumer<CreateCachediScsiVolumeRequest.Builder> createCachediScsiVolumeRequest) Creates a cached volume on a specified cached volume gateway.default CreateCachediScsiVolumeResponsecreateCachediSCSIVolume(CreateCachediScsiVolumeRequest createCachediScsiVolumeRequest) Creates a cached volume on a specified cached volume gateway.default CreateNfsFileShareResponsecreateNFSFileShare(Consumer<CreateNfsFileShareRequest.Builder> createNfsFileShareRequest) Creates a Network File System (NFS) file share on an existing S3 File Gateway.default CreateNfsFileShareResponsecreateNFSFileShare(CreateNfsFileShareRequest createNfsFileShareRequest) Creates a Network File System (NFS) file share on an existing S3 File Gateway.default CreateSmbFileShareResponsecreateSMBFileShare(Consumer<CreateSmbFileShareRequest.Builder> createSmbFileShareRequest) Creates a Server Message Block (SMB) file share on an existing S3 File Gateway.default CreateSmbFileShareResponsecreateSMBFileShare(CreateSmbFileShareRequest createSmbFileShareRequest) Creates a Server Message Block (SMB) file share on an existing S3 File Gateway.default CreateSnapshotResponsecreateSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest) Initiates a snapshot of a volume.default CreateSnapshotResponsecreateSnapshot(CreateSnapshotRequest createSnapshotRequest) Initiates a snapshot of a volume.createSnapshotFromVolumeRecoveryPoint(Consumer<CreateSnapshotFromVolumeRecoveryPointRequest.Builder> createSnapshotFromVolumeRecoveryPointRequest) Initiates a snapshot of a gateway from a volume recovery point.createSnapshotFromVolumeRecoveryPoint(CreateSnapshotFromVolumeRecoveryPointRequest createSnapshotFromVolumeRecoveryPointRequest) Initiates a snapshot of a gateway from a volume recovery point.default CreateStorediScsiVolumeResponsecreateStorediSCSIVolume(Consumer<CreateStorediScsiVolumeRequest.Builder> createStorediScsiVolumeRequest) Creates a volume on a specified gateway.default CreateStorediScsiVolumeResponsecreateStorediSCSIVolume(CreateStorediScsiVolumeRequest createStorediScsiVolumeRequest) Creates a volume on a specified gateway.default CreateTapePoolResponsecreateTapePool(Consumer<CreateTapePoolRequest.Builder> createTapePoolRequest) Creates a new custom tape pool.default CreateTapePoolResponsecreateTapePool(CreateTapePoolRequest createTapePoolRequest) Creates a new custom tape pool.default CreateTapesResponsecreateTapes(Consumer<CreateTapesRequest.Builder> createTapesRequest) Creates one or more virtual tapes.default CreateTapesResponsecreateTapes(CreateTapesRequest createTapesRequest) Creates one or more virtual tapes.default CreateTapeWithBarcodeResponsecreateTapeWithBarcode(Consumer<CreateTapeWithBarcodeRequest.Builder> createTapeWithBarcodeRequest) Creates a virtual tape by using your own barcode.default CreateTapeWithBarcodeResponsecreateTapeWithBarcode(CreateTapeWithBarcodeRequest createTapeWithBarcodeRequest) Creates a virtual tape by using your own barcode.deleteAutomaticTapeCreationPolicy(Consumer<DeleteAutomaticTapeCreationPolicyRequest.Builder> deleteAutomaticTapeCreationPolicyRequest) Deletes the automatic tape creation policy of a gateway.deleteAutomaticTapeCreationPolicy(DeleteAutomaticTapeCreationPolicyRequest deleteAutomaticTapeCreationPolicyRequest) Deletes the automatic tape creation policy of a gateway.default DeleteBandwidthRateLimitResponsedeleteBandwidthRateLimit(Consumer<DeleteBandwidthRateLimitRequest.Builder> deleteBandwidthRateLimitRequest) Deletes the bandwidth rate limits of a gateway.default DeleteBandwidthRateLimitResponsedeleteBandwidthRateLimit(DeleteBandwidthRateLimitRequest deleteBandwidthRateLimitRequest) Deletes the bandwidth rate limits of a gateway.default DeleteChapCredentialsResponsedeleteChapCredentials(Consumer<DeleteChapCredentialsRequest.Builder> deleteChapCredentialsRequest) Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.default DeleteChapCredentialsResponsedeleteChapCredentials(DeleteChapCredentialsRequest deleteChapCredentialsRequest) Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.default DeleteFileShareResponsedeleteFileShare(Consumer<DeleteFileShareRequest.Builder> deleteFileShareRequest) Deletes a file share from an S3 File Gateway.default DeleteFileShareResponsedeleteFileShare(DeleteFileShareRequest deleteFileShareRequest) Deletes a file share from an S3 File Gateway.default DeleteGatewayResponsedeleteGateway(Consumer<DeleteGatewayRequest.Builder> deleteGatewayRequest) Deletes a gateway.default DeleteGatewayResponsedeleteGateway(DeleteGatewayRequest deleteGatewayRequest) Deletes a gateway.default DeleteSnapshotScheduleResponsedeleteSnapshotSchedule(Consumer<DeleteSnapshotScheduleRequest.Builder> deleteSnapshotScheduleRequest) Deletes a snapshot of a volume.default DeleteSnapshotScheduleResponsedeleteSnapshotSchedule(DeleteSnapshotScheduleRequest deleteSnapshotScheduleRequest) Deletes a snapshot of a volume.default DeleteTapeResponsedeleteTape(Consumer<DeleteTapeRequest.Builder> deleteTapeRequest) Deletes the specified virtual tape.default DeleteTapeResponsedeleteTape(DeleteTapeRequest deleteTapeRequest) Deletes the specified virtual tape.default DeleteTapeArchiveResponsedeleteTapeArchive(Consumer<DeleteTapeArchiveRequest.Builder> deleteTapeArchiveRequest) Deletes the specified virtual tape from the virtual tape shelf (VTS).default DeleteTapeArchiveResponsedeleteTapeArchive(DeleteTapeArchiveRequest deleteTapeArchiveRequest) Deletes the specified virtual tape from the virtual tape shelf (VTS).default DeleteTapePoolResponsedeleteTapePool(Consumer<DeleteTapePoolRequest.Builder> deleteTapePoolRequest) Delete a custom tape pool.default DeleteTapePoolResponsedeleteTapePool(DeleteTapePoolRequest deleteTapePoolRequest) Delete a custom tape pool.default DeleteVolumeResponsedeleteVolume(Consumer<DeleteVolumeRequest.Builder> deleteVolumeRequest) Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API.default DeleteVolumeResponsedeleteVolume(DeleteVolumeRequest deleteVolumeRequest) Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API.describeAvailabilityMonitorTest(Consumer<DescribeAvailabilityMonitorTestRequest.Builder> describeAvailabilityMonitorTestRequest) Returns information about the most recent high availability monitoring test that was performed on the host in a cluster.describeAvailabilityMonitorTest(DescribeAvailabilityMonitorTestRequest describeAvailabilityMonitorTestRequest) Returns information about the most recent high availability monitoring test that was performed on the host in a cluster.describeBandwidthRateLimit(Consumer<DescribeBandwidthRateLimitRequest.Builder> describeBandwidthRateLimitRequest) Returns the bandwidth rate limits of a gateway.describeBandwidthRateLimit(DescribeBandwidthRateLimitRequest describeBandwidthRateLimitRequest) Returns the bandwidth rate limits of a gateway.describeBandwidthRateLimitSchedule(Consumer<DescribeBandwidthRateLimitScheduleRequest.Builder> describeBandwidthRateLimitScheduleRequest) Returns information about the bandwidth rate limit schedule of a gateway.describeBandwidthRateLimitSchedule(DescribeBandwidthRateLimitScheduleRequest describeBandwidthRateLimitScheduleRequest) Returns information about the bandwidth rate limit schedule of a gateway.default DescribeCacheResponsedescribeCache(Consumer<DescribeCacheRequest.Builder> describeCacheRequest) Returns information about the cache of a gateway.default DescribeCacheResponsedescribeCache(DescribeCacheRequest describeCacheRequest) Returns information about the cache of a gateway.describeCachediSCSIVolumes(Consumer<DescribeCachediScsiVolumesRequest.Builder> describeCachediScsiVolumesRequest) Returns a description of the gateway volumes specified in the request.describeCachediSCSIVolumes(DescribeCachediScsiVolumesRequest describeCachediScsiVolumesRequest) Returns a description of the gateway volumes specified in the request.default DescribeChapCredentialsResponsedescribeChapCredentials(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 DescribeChapCredentialsResponsedescribeChapCredentials(DescribeChapCredentialsRequest describeChapCredentialsRequest) Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.describeFileSystemAssociations(Consumer<DescribeFileSystemAssociationsRequest.Builder> describeFileSystemAssociationsRequest) Gets the file system association information.describeFileSystemAssociations(DescribeFileSystemAssociationsRequest describeFileSystemAssociationsRequest) Gets the file system association information.describeGatewayInformation(Consumer<DescribeGatewayInformationRequest.Builder> describeGatewayInformationRequest) Returns metadata about a gateway such as its name, network interfaces, time zone, status, and software version.describeGatewayInformation(DescribeGatewayInformationRequest describeGatewayInformationRequest) Returns metadata about a gateway such as its name, network interfaces, time zone, status, and software version.describeMaintenanceStartTime(Consumer<DescribeMaintenanceStartTimeRequest.Builder> describeMaintenanceStartTimeRequest) Returns your gateway's maintenance window schedule information, with values for monthly or weekly cadence, specific day and time to begin maintenance, and which types of updates to apply.describeMaintenanceStartTime(DescribeMaintenanceStartTimeRequest describeMaintenanceStartTimeRequest) Returns your gateway's maintenance window schedule information, with values for monthly or weekly cadence, specific day and time to begin maintenance, and which types of updates to apply.default DescribeNfsFileSharesResponsedescribeNFSFileShares(Consumer<DescribeNfsFileSharesRequest.Builder> describeNfsFileSharesRequest) Gets a description for one or more Network File System (NFS) file shares from an S3 File Gateway.default DescribeNfsFileSharesResponsedescribeNFSFileShares(DescribeNfsFileSharesRequest describeNfsFileSharesRequest) Gets a description for one or more Network File System (NFS) file shares from an S3 File Gateway.default DescribeSmbFileSharesResponsedescribeSMBFileShares(Consumer<DescribeSmbFileSharesRequest.Builder> describeSmbFileSharesRequest) Gets a description for one or more Server Message Block (SMB) file shares from a S3 File Gateway.default DescribeSmbFileSharesResponsedescribeSMBFileShares(DescribeSmbFileSharesRequest describeSmbFileSharesRequest) Gets a description for one or more Server Message Block (SMB) file shares from a S3 File Gateway.default DescribeSmbSettingsResponsedescribeSMBSettings(Consumer<DescribeSmbSettingsRequest.Builder> describeSmbSettingsRequest) Gets a description of a Server Message Block (SMB) file share settings from a file gateway.default DescribeSmbSettingsResponsedescribeSMBSettings(DescribeSmbSettingsRequest describeSmbSettingsRequest) Gets a description of a Server Message Block (SMB) file share settings from a file gateway.default DescribeSnapshotScheduleResponsedescribeSnapshotSchedule(Consumer<DescribeSnapshotScheduleRequest.Builder> describeSnapshotScheduleRequest) Describes the snapshot schedule for the specified gateway volume.default DescribeSnapshotScheduleResponsedescribeSnapshotSchedule(DescribeSnapshotScheduleRequest describeSnapshotScheduleRequest) Describes the snapshot schedule for the specified gateway volume.describeStorediSCSIVolumes(Consumer<DescribeStorediScsiVolumesRequest.Builder> describeStorediScsiVolumesRequest) Returns the description of the gateway volumes specified in the request.describeStorediSCSIVolumes(DescribeStorediScsiVolumesRequest describeStorediScsiVolumesRequest) Returns the description of the gateway volumes specified in the request.default DescribeTapeArchivesResponseReturns a description of specified virtual tapes in the virtual tape shelf (VTS).default DescribeTapeArchivesResponsedescribeTapeArchives(Consumer<DescribeTapeArchivesRequest.Builder> describeTapeArchivesRequest) Returns a description of specified virtual tapes in the virtual tape shelf (VTS).default DescribeTapeArchivesResponsedescribeTapeArchives(DescribeTapeArchivesRequest describeTapeArchivesRequest) Returns a description of specified virtual tapes in the virtual tape shelf (VTS).default DescribeTapeArchivesIterableThis is a variant ofdescribeTapeArchives(software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesRequest)operation.default DescribeTapeArchivesIterabledescribeTapeArchivesPaginator(Consumer<DescribeTapeArchivesRequest.Builder> describeTapeArchivesRequest) This is a variant ofdescribeTapeArchives(software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesRequest)operation.default DescribeTapeArchivesIterabledescribeTapeArchivesPaginator(DescribeTapeArchivesRequest describeTapeArchivesRequest) This is a variant ofdescribeTapeArchives(software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesRequest)operation.describeTapeRecoveryPoints(Consumer<DescribeTapeRecoveryPointsRequest.Builder> describeTapeRecoveryPointsRequest) Returns a list of virtual tape recovery points that are available for the specified tape gateway.describeTapeRecoveryPoints(DescribeTapeRecoveryPointsRequest describeTapeRecoveryPointsRequest) Returns a list of virtual tape recovery points that are available for the specified tape gateway.describeTapeRecoveryPointsPaginator(Consumer<DescribeTapeRecoveryPointsRequest.Builder> describeTapeRecoveryPointsRequest) This is a variant ofdescribeTapeRecoveryPoints(software.amazon.awssdk.services.storagegateway.model.DescribeTapeRecoveryPointsRequest)operation.describeTapeRecoveryPointsPaginator(DescribeTapeRecoveryPointsRequest describeTapeRecoveryPointsRequest) This is a variant ofdescribeTapeRecoveryPoints(software.amazon.awssdk.services.storagegateway.model.DescribeTapeRecoveryPointsRequest)operation.default DescribeTapesResponsedescribeTapes(Consumer<DescribeTapesRequest.Builder> describeTapesRequest) Returns a description of virtual tapes that correspond to the specified Amazon Resource Names (ARNs).default DescribeTapesResponsedescribeTapes(DescribeTapesRequest describeTapesRequest) Returns a description of virtual tapes that correspond to the specified Amazon Resource Names (ARNs).default DescribeTapesIterabledescribeTapesPaginator(Consumer<DescribeTapesRequest.Builder> describeTapesRequest) This is a variant ofdescribeTapes(software.amazon.awssdk.services.storagegateway.model.DescribeTapesRequest)operation.default DescribeTapesIterabledescribeTapesPaginator(DescribeTapesRequest describeTapesRequest) This is a variant ofdescribeTapes(software.amazon.awssdk.services.storagegateway.model.DescribeTapesRequest)operation.default DescribeUploadBufferResponsedescribeUploadBuffer(Consumer<DescribeUploadBufferRequest.Builder> describeUploadBufferRequest) Returns information about the upload buffer of a gateway.default DescribeUploadBufferResponsedescribeUploadBuffer(DescribeUploadBufferRequest describeUploadBufferRequest) Returns information about the upload buffer of a gateway.default DescribeVtlDevicesResponsedescribeVTLDevices(Consumer<DescribeVtlDevicesRequest.Builder> describeVtlDevicesRequest) Returns a description of virtual tape library (VTL) devices for the specified tape gateway.default DescribeVtlDevicesResponsedescribeVTLDevices(DescribeVtlDevicesRequest describeVtlDevicesRequest) Returns a description of virtual tape library (VTL) devices for the specified tape gateway.default DescribeVTLDevicesIterabledescribeVTLDevicesPaginator(Consumer<DescribeVtlDevicesRequest.Builder> describeVtlDevicesRequest) This is a variant ofdescribeVTLDevices(software.amazon.awssdk.services.storagegateway.model.DescribeVtlDevicesRequest)operation.default DescribeVTLDevicesIterabledescribeVTLDevicesPaginator(DescribeVtlDevicesRequest describeVtlDevicesRequest) This is a variant ofdescribeVTLDevices(software.amazon.awssdk.services.storagegateway.model.DescribeVtlDevicesRequest)operation.default DescribeWorkingStorageResponsedescribeWorkingStorage(Consumer<DescribeWorkingStorageRequest.Builder> describeWorkingStorageRequest) Returns information about the working storage of a gateway.default DescribeWorkingStorageResponsedescribeWorkingStorage(DescribeWorkingStorageRequest describeWorkingStorageRequest) Returns information about the working storage of a gateway.default DetachVolumeResponsedetachVolume(Consumer<DetachVolumeRequest.Builder> detachVolumeRequest) Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway.default DetachVolumeResponsedetachVolume(DetachVolumeRequest detachVolumeRequest) Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway.default DisableGatewayResponsedisableGateway(Consumer<DisableGatewayRequest.Builder> disableGatewayRequest) Disables a tape gateway when the gateway is no longer functioning.default DisableGatewayResponsedisableGateway(DisableGatewayRequest disableGatewayRequest) Disables a tape gateway when the gateway is no longer functioning.default DisassociateFileSystemResponsedisassociateFileSystem(Consumer<DisassociateFileSystemRequest.Builder> disassociateFileSystemRequest) Disassociates an Amazon FSx file system from the specified gateway.default DisassociateFileSystemResponsedisassociateFileSystem(DisassociateFileSystemRequest disassociateFileSystemRequest) Disassociates an Amazon FSx file system from the specified gateway.default JoinDomainResponsejoinDomain(Consumer<JoinDomainRequest.Builder> joinDomainRequest) Adds a file gateway to an Active Directory domain.default JoinDomainResponsejoinDomain(JoinDomainRequest joinDomainRequest) Adds a file gateway to an Active Directory domain.listAutomaticTapeCreationPolicies(Consumer<ListAutomaticTapeCreationPoliciesRequest.Builder> listAutomaticTapeCreationPoliciesRequest) Lists the automatic tape creation policies for a gateway.listAutomaticTapeCreationPolicies(ListAutomaticTapeCreationPoliciesRequest listAutomaticTapeCreationPoliciesRequest) Lists the automatic tape creation policies for a gateway.default ListFileSharesResponseGets a list of the file shares for a specific S3 File Gateway, or the list of file shares that belong to the calling Amazon Web Services account.default ListFileSharesResponselistFileShares(Consumer<ListFileSharesRequest.Builder> listFileSharesRequest) Gets a list of the file shares for a specific S3 File Gateway, or the list of file shares that belong to the calling Amazon Web Services account.default ListFileSharesResponselistFileShares(ListFileSharesRequest listFileSharesRequest) Gets a list of the file shares for a specific S3 File Gateway, or the list of file shares that belong to the calling Amazon Web Services account.default ListFileSharesIterableThis is a variant oflistFileShares(software.amazon.awssdk.services.storagegateway.model.ListFileSharesRequest)operation.default ListFileSharesIterablelistFileSharesPaginator(Consumer<ListFileSharesRequest.Builder> listFileSharesRequest) This is a variant oflistFileShares(software.amazon.awssdk.services.storagegateway.model.ListFileSharesRequest)operation.default ListFileSharesIterablelistFileSharesPaginator(ListFileSharesRequest listFileSharesRequest) This is a variant oflistFileShares(software.amazon.awssdk.services.storagegateway.model.ListFileSharesRequest)operation.listFileSystemAssociations(Consumer<ListFileSystemAssociationsRequest.Builder> listFileSystemAssociationsRequest) Gets a list ofFileSystemAssociationSummaryobjects.listFileSystemAssociations(ListFileSystemAssociationsRequest listFileSystemAssociationsRequest) Gets a list ofFileSystemAssociationSummaryobjects.listFileSystemAssociationsPaginator(Consumer<ListFileSystemAssociationsRequest.Builder> listFileSystemAssociationsRequest) This is a variant oflistFileSystemAssociations(software.amazon.awssdk.services.storagegateway.model.ListFileSystemAssociationsRequest)operation.listFileSystemAssociationsPaginator(ListFileSystemAssociationsRequest listFileSystemAssociationsRequest) This is a variant oflistFileSystemAssociations(software.amazon.awssdk.services.storagegateway.model.ListFileSystemAssociationsRequest)operation.default ListGatewaysResponseLists gateways owned by an Amazon Web Services account in an Amazon Web Services Region specified in the request.default ListGatewaysResponselistGateways(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest) Lists gateways owned by an Amazon Web Services account in an Amazon Web Services Region specified in the request.default ListGatewaysResponselistGateways(ListGatewaysRequest listGatewaysRequest) Lists gateways owned by an Amazon Web Services account in an Amazon Web Services Region specified in the request.default ListGatewaysIterableThis is a variant oflistGateways(software.amazon.awssdk.services.storagegateway.model.ListGatewaysRequest)operation.default ListGatewaysIterablelistGatewaysPaginator(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest) This is a variant oflistGateways(software.amazon.awssdk.services.storagegateway.model.ListGatewaysRequest)operation.default ListGatewaysIterablelistGatewaysPaginator(ListGatewaysRequest listGatewaysRequest) This is a variant oflistGateways(software.amazon.awssdk.services.storagegateway.model.ListGatewaysRequest)operation.default ListLocalDisksResponselistLocalDisks(Consumer<ListLocalDisksRequest.Builder> listLocalDisksRequest) Returns a list of the gateway's local disks.default ListLocalDisksResponselistLocalDisks(ListLocalDisksRequest listLocalDisksRequest) Returns a list of the gateway's local disks.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags that have been added to the specified resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags that have been added to the specified resource.default ListTagsForResourceIterablelistTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.storagegateway.model.ListTagsForResourceRequest)operation.default ListTagsForResourceIterablelistTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.storagegateway.model.ListTagsForResourceRequest)operation.default ListTapePoolsResponselistTapePools(Consumer<ListTapePoolsRequest.Builder> listTapePoolsRequest) Lists custom tape pools.default ListTapePoolsResponselistTapePools(ListTapePoolsRequest listTapePoolsRequest) Lists custom tape pools.default ListTapePoolsIterablelistTapePoolsPaginator(Consumer<ListTapePoolsRequest.Builder> listTapePoolsRequest) This is a variant oflistTapePools(software.amazon.awssdk.services.storagegateway.model.ListTapePoolsRequest)operation.default ListTapePoolsIterablelistTapePoolsPaginator(ListTapePoolsRequest listTapePoolsRequest) This is a variant oflistTapePools(software.amazon.awssdk.services.storagegateway.model.ListTapePoolsRequest)operation.default ListTapesResponseLists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS).default ListTapesResponselistTapes(Consumer<ListTapesRequest.Builder> listTapesRequest) Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS).default ListTapesResponselistTapes(ListTapesRequest listTapesRequest) Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS).default ListTapesIterableThis is a variant oflistTapes(software.amazon.awssdk.services.storagegateway.model.ListTapesRequest)operation.default ListTapesIterablelistTapesPaginator(Consumer<ListTapesRequest.Builder> listTapesRequest) This is a variant oflistTapes(software.amazon.awssdk.services.storagegateway.model.ListTapesRequest)operation.default ListTapesIterablelistTapesPaginator(ListTapesRequest listTapesRequest) This is a variant oflistTapes(software.amazon.awssdk.services.storagegateway.model.ListTapesRequest)operation.default ListVolumeInitiatorsResponselistVolumeInitiators(Consumer<ListVolumeInitiatorsRequest.Builder> listVolumeInitiatorsRequest) Lists iSCSI initiators that are connected to a volume.default ListVolumeInitiatorsResponselistVolumeInitiators(ListVolumeInitiatorsRequest listVolumeInitiatorsRequest) Lists iSCSI initiators that are connected to a volume.default ListVolumeRecoveryPointsResponselistVolumeRecoveryPoints(Consumer<ListVolumeRecoveryPointsRequest.Builder> listVolumeRecoveryPointsRequest) Lists the recovery points for a specified gateway.default ListVolumeRecoveryPointsResponselistVolumeRecoveryPoints(ListVolumeRecoveryPointsRequest listVolumeRecoveryPointsRequest) Lists the recovery points for a specified gateway.default ListVolumesResponseLists the iSCSI stored volumes of a gateway.default ListVolumesResponselistVolumes(Consumer<ListVolumesRequest.Builder> listVolumesRequest) Lists the iSCSI stored volumes of a gateway.default ListVolumesResponselistVolumes(ListVolumesRequest listVolumesRequest) Lists the iSCSI stored volumes of a gateway.default ListVolumesIterableThis is a variant oflistVolumes(software.amazon.awssdk.services.storagegateway.model.ListVolumesRequest)operation.default ListVolumesIterablelistVolumesPaginator(Consumer<ListVolumesRequest.Builder> listVolumesRequest) This is a variant oflistVolumes(software.amazon.awssdk.services.storagegateway.model.ListVolumesRequest)operation.default ListVolumesIterablelistVolumesPaginator(ListVolumesRequest listVolumesRequest) This is a variant oflistVolumes(software.amazon.awssdk.services.storagegateway.model.ListVolumesRequest)operation.default NotifyWhenUploadedResponsenotifyWhenUploaded(Consumer<NotifyWhenUploadedRequest.Builder> notifyWhenUploadedRequest) Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to Amazon S3.default NotifyWhenUploadedResponsenotifyWhenUploaded(NotifyWhenUploadedRequest notifyWhenUploadedRequest) Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to Amazon S3.default RefreshCacheResponserefreshCache(Consumer<RefreshCacheRequest.Builder> refreshCacheRequest) Refreshes the cached inventory of objects for the specified file share.default RefreshCacheResponserefreshCache(RefreshCacheRequest refreshCacheRequest) Refreshes the cached inventory of objects for the specified file share.default RemoveTagsFromResourceResponseremoveTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) Removes one or more tags from the specified resource.default RemoveTagsFromResourceResponseremoveTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) Removes one or more tags from the specified resource.default ResetCacheResponseresetCache(Consumer<ResetCacheRequest.Builder> resetCacheRequest) Resets all cache disks that have encountered an error and makes the disks available for reconfiguration as cache storage.default ResetCacheResponseresetCache(ResetCacheRequest resetCacheRequest) Resets all cache disks that have encountered an error and makes the disks available for reconfiguration as cache storage.default RetrieveTapeArchiveResponseretrieveTapeArchive(Consumer<RetrieveTapeArchiveRequest.Builder> retrieveTapeArchiveRequest) Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway.default RetrieveTapeArchiveResponseretrieveTapeArchive(RetrieveTapeArchiveRequest retrieveTapeArchiveRequest) Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway.retrieveTapeRecoveryPoint(Consumer<RetrieveTapeRecoveryPointRequest.Builder> retrieveTapeRecoveryPointRequest) Retrieves the recovery point for the specified virtual tape.retrieveTapeRecoveryPoint(RetrieveTapeRecoveryPointRequest retrieveTapeRecoveryPointRequest) Retrieves the recovery point for the specified virtual tape.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatadefault SetLocalConsolePasswordResponsesetLocalConsolePassword(Consumer<SetLocalConsolePasswordRequest.Builder> setLocalConsolePasswordRequest) Sets the password for your VM local console.default SetLocalConsolePasswordResponsesetLocalConsolePassword(SetLocalConsolePasswordRequest setLocalConsolePasswordRequest) Sets the password for your VM local console.default SetSmbGuestPasswordResponsesetSMBGuestPassword(Consumer<SetSmbGuestPasswordRequest.Builder> setSmbGuestPasswordRequest) Sets the password for the guest usersmbguest.default SetSmbGuestPasswordResponsesetSMBGuestPassword(SetSmbGuestPasswordRequest setSmbGuestPasswordRequest) Sets the password for the guest usersmbguest.default ShutdownGatewayResponseshutdownGateway(Consumer<ShutdownGatewayRequest.Builder> shutdownGatewayRequest) Shuts down a Tape Gateway or Volume Gateway.default ShutdownGatewayResponseshutdownGateway(ShutdownGatewayRequest shutdownGatewayRequest) Shuts down a Tape Gateway or Volume Gateway.startAvailabilityMonitorTest(Consumer<StartAvailabilityMonitorTestRequest.Builder> startAvailabilityMonitorTestRequest) Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment.startAvailabilityMonitorTest(StartAvailabilityMonitorTestRequest startAvailabilityMonitorTestRequest) Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment.default StartGatewayResponsestartGateway(Consumer<StartGatewayRequest.Builder> startGatewayRequest) Starts a gateway that you previously shut down (see ShutdownGateway).default StartGatewayResponsestartGateway(StartGatewayRequest startGatewayRequest) Starts a gateway that you previously shut down (see ShutdownGateway).updateAutomaticTapeCreationPolicy(Consumer<UpdateAutomaticTapeCreationPolicyRequest.Builder> updateAutomaticTapeCreationPolicyRequest) Updates the automatic tape creation policy of a gateway.updateAutomaticTapeCreationPolicy(UpdateAutomaticTapeCreationPolicyRequest updateAutomaticTapeCreationPolicyRequest) Updates the automatic tape creation policy of a gateway.default UpdateBandwidthRateLimitResponseupdateBandwidthRateLimit(Consumer<UpdateBandwidthRateLimitRequest.Builder> updateBandwidthRateLimitRequest) Updates the bandwidth rate limits of a gateway.default UpdateBandwidthRateLimitResponseupdateBandwidthRateLimit(UpdateBandwidthRateLimitRequest updateBandwidthRateLimitRequest) Updates the bandwidth rate limits of a gateway.updateBandwidthRateLimitSchedule(Consumer<UpdateBandwidthRateLimitScheduleRequest.Builder> updateBandwidthRateLimitScheduleRequest) Updates the bandwidth rate limit schedule for a specified gateway.updateBandwidthRateLimitSchedule(UpdateBandwidthRateLimitScheduleRequest updateBandwidthRateLimitScheduleRequest) Updates the bandwidth rate limit schedule for a specified gateway.default UpdateChapCredentialsResponseupdateChapCredentials(Consumer<UpdateChapCredentialsRequest.Builder> updateChapCredentialsRequest) Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target.default UpdateChapCredentialsResponseupdateChapCredentials(UpdateChapCredentialsRequest updateChapCredentialsRequest) Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target.updateFileSystemAssociation(Consumer<UpdateFileSystemAssociationRequest.Builder> updateFileSystemAssociationRequest) Updates a file system association.updateFileSystemAssociation(UpdateFileSystemAssociationRequest updateFileSystemAssociationRequest) Updates a file system association.default UpdateGatewayInformationResponseupdateGatewayInformation(Consumer<UpdateGatewayInformationRequest.Builder> updateGatewayInformationRequest) Updates a gateway's metadata, which includes the gateway's name, time zone, and metadata cache size.default UpdateGatewayInformationResponseupdateGatewayInformation(UpdateGatewayInformationRequest updateGatewayInformationRequest) Updates a gateway's metadata, which includes the gateway's name, time zone, and metadata cache size.default UpdateGatewaySoftwareNowResponseupdateGatewaySoftwareNow(Consumer<UpdateGatewaySoftwareNowRequest.Builder> updateGatewaySoftwareNowRequest) Updates the gateway virtual machine (VM) software.default UpdateGatewaySoftwareNowResponseupdateGatewaySoftwareNow(UpdateGatewaySoftwareNowRequest updateGatewaySoftwareNowRequest) Updates the gateway virtual machine (VM) software.updateMaintenanceStartTime(Consumer<UpdateMaintenanceStartTimeRequest.Builder> updateMaintenanceStartTimeRequest) Updates a gateway's maintenance window schedule, with settings for monthly or weekly cadence, specific day and time to begin maintenance, and which types of updates to apply.updateMaintenanceStartTime(UpdateMaintenanceStartTimeRequest updateMaintenanceStartTimeRequest) Updates a gateway's maintenance window schedule, with settings for monthly or weekly cadence, specific day and time to begin maintenance, and which types of updates to apply.default UpdateNfsFileShareResponseupdateNFSFileShare(Consumer<UpdateNfsFileShareRequest.Builder> updateNfsFileShareRequest) Updates a Network File System (NFS) file share.default UpdateNfsFileShareResponseupdateNFSFileShare(UpdateNfsFileShareRequest updateNfsFileShareRequest) Updates a Network File System (NFS) file share.default UpdateSmbFileShareResponseupdateSMBFileShare(Consumer<UpdateSmbFileShareRequest.Builder> updateSmbFileShareRequest) Updates a Server Message Block (SMB) file share.default UpdateSmbFileShareResponseupdateSMBFileShare(UpdateSmbFileShareRequest updateSmbFileShareRequest) Updates a Server Message Block (SMB) file share.updateSMBFileShareVisibility(Consumer<UpdateSmbFileShareVisibilityRequest.Builder> updateSmbFileShareVisibilityRequest) Controls whether the shares on an S3 File Gateway are visible in a net view or browse list.updateSMBFileShareVisibility(UpdateSmbFileShareVisibilityRequest updateSmbFileShareVisibilityRequest) Controls whether the shares on an S3 File Gateway are visible in a net view or browse list.default UpdateSmbLocalGroupsResponseupdateSMBLocalGroups(Consumer<UpdateSmbLocalGroupsRequest.Builder> updateSmbLocalGroupsRequest) Updates the list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.default UpdateSmbLocalGroupsResponseupdateSMBLocalGroups(UpdateSmbLocalGroupsRequest updateSmbLocalGroupsRequest) Updates the list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.updateSMBSecurityStrategy(Consumer<UpdateSmbSecurityStrategyRequest.Builder> updateSmbSecurityStrategyRequest) Updates the SMB security strategy level for an Amazon S3 file gateway.updateSMBSecurityStrategy(UpdateSmbSecurityStrategyRequest updateSmbSecurityStrategyRequest) Updates the SMB security strategy level for an Amazon S3 file gateway.default UpdateSnapshotScheduleResponseupdateSnapshotSchedule(Consumer<UpdateSnapshotScheduleRequest.Builder> updateSnapshotScheduleRequest) Updates a snapshot schedule configured for a gateway volume.default UpdateSnapshotScheduleResponseupdateSnapshotSchedule(UpdateSnapshotScheduleRequest updateSnapshotScheduleRequest) Updates a snapshot schedule configured for a gateway volume.default UpdateVtlDeviceTypeResponseupdateVTLDeviceType(Consumer<UpdateVtlDeviceTypeRequest.Builder> updateVtlDeviceTypeRequest) Updates the type of medium changer in a tape gateway.default UpdateVtlDeviceTypeResponseupdateVTLDeviceType(UpdateVtlDeviceTypeRequest updateVtlDeviceTypeRequest) Updates the type of medium changer in a tape gateway.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
activateGateway
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 Amazon Web Services Region that you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account. For more information, see UpdateGatewayInformation.
You must turn on the gateway VM before you can activate your gateway.
- Parameters:
activateGatewayRequest- A JSON object containing one or more of the following fields:- Returns:
- Result of the ActivateGateway operation returned by the service.
- See Also:
-
activateGateway
default 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 Amazon Web Services Region that you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account. For more information, see UpdateGatewayInformation.
You must turn on the gateway VM before you can activate your gateway.
This is a convenience which creates an instance of the
ActivateGatewayRequest.Builderavoiding the need to create one manually viaActivateGatewayRequest.builder()- Parameters:
activateGatewayRequest- AConsumerthat will call methods onActivateGatewayRequest.Builderto create a request. A JSON object containing one or more of the following fields:- Returns:
- Result of the ActivateGateway operation returned by the service.
- See Also:
-
addCache
default 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 How Storage Gateway works (architecture).
In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.
- Parameters:
addCacheRequest-- Returns:
- Result of the AddCache operation returned by the service.
- See Also:
-
addCache
default 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 How Storage Gateway works (architecture).
In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.
This is a convenience which creates an instance of the
AddCacheRequest.Builderavoiding the need to create one manually viaAddCacheRequest.builder()- Parameters:
addCacheRequest- AConsumerthat will call methods onAddCacheRequest.Builderto create a request.- Returns:
- Result of the AddCache operation returned by the service.
- See Also:
-
addTagsToResource
default 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 Storage Gateway resources:
-
Storage gateways of all types
-
Storage volumes
-
Virtual tapes
-
NFS and SMB file shares
-
File System associations
You can create a maximum of 50 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags.
- Parameters:
addTagsToResourceRequest- AddTagsToResourceInput- Returns:
- Result of the AddTagsToResource operation returned by the service.
- See Also:
-
-
addTagsToResource
default 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 Storage Gateway resources:
-
Storage gateways of all types
-
Storage volumes
-
Virtual tapes
-
NFS and SMB file shares
-
File System associations
You can create a maximum of 50 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags.
This is a convenience which creates an instance of the
AddTagsToResourceRequest.Builderavoiding the need to create one manually viaAddTagsToResourceRequest.builder()- Parameters:
addTagsToResourceRequest- AConsumerthat will call methods onAddTagsToResourceRequest.Builderto create a request. AddTagsToResourceInput- Returns:
- Result of the AddTagsToResource operation returned by the service.
- See Also:
-
-
addUploadBuffer
default 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.
- Parameters:
addUploadBufferRequest-- Returns:
- Result of the AddUploadBuffer operation returned by the service.
- See Also:
-
addUploadBuffer
default 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.Builderavoiding the need to create one manually viaAddUploadBufferRequest.builder()- Parameters:
addUploadBufferRequest- AConsumerthat will call methods onAddUploadBufferRequest.Builderto create a request.- Returns:
- Result of the AddUploadBuffer operation returned by the service.
- See Also:
-
addWorkingStorage
default 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.
- Parameters:
addWorkingStorageRequest- A JSON object containing one or more of the following fields:- Returns:
- Result of the AddWorkingStorage operation returned by the service.
- See Also:
-
addWorkingStorage
default 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.Builderavoiding the need to create one manually viaAddWorkingStorageRequest.builder()- Parameters:
addWorkingStorageRequest- AConsumerthat will call methods onAddWorkingStorageRequest.Builderto create a request. A JSON object containing one or more of the following fields:- Returns:
- Result of the AddWorkingStorage operation returned by the service.
- See Also:
-
assignTapePool
default AssignTapePoolResponse assignTapePool(AssignTapePoolRequest assignTapePoolRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
- Parameters:
assignTapePoolRequest-- Returns:
- Result of the AssignTapePool operation returned by the service.
- See Also:
-
assignTapePool
default AssignTapePoolResponse assignTapePool(Consumer<AssignTapePoolRequest.Builder> assignTapePoolRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
This is a convenience which creates an instance of the
AssignTapePoolRequest.Builderavoiding the need to create one manually viaAssignTapePoolRequest.builder()- Parameters:
assignTapePoolRequest- AConsumerthat will call methods onAssignTapePoolRequest.Builderto create a request.- Returns:
- Result of the AssignTapePool operation returned by the service.
- See Also:
-
associateFileSystem
default AssociateFileSystemResponse associateFileSystem(AssociateFileSystemRequest associateFileSystemRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Associate an Amazon FSx file system with the FSx File Gateway. After the association process is complete, the file shares on the Amazon FSx file system are available for access through the gateway. This operation only supports the FSx File Gateway type.
- Parameters:
associateFileSystemRequest-- Returns:
- Result of the AssociateFileSystem operation returned by the service.
- See Also:
-
associateFileSystem
default AssociateFileSystemResponse associateFileSystem(Consumer<AssociateFileSystemRequest.Builder> associateFileSystemRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Associate an Amazon FSx file system with the FSx File Gateway. After the association process is complete, the file shares on the Amazon FSx file system are available for access through the gateway. This operation only supports the FSx File Gateway type.
This is a convenience which creates an instance of the
AssociateFileSystemRequest.Builderavoiding the need to create one manually viaAssociateFileSystemRequest.builder()- Parameters:
associateFileSystemRequest- AConsumerthat will call methods onAssociateFileSystemRequest.Builderto create a request.- Returns:
- Result of the AssociateFileSystem operation returned by the service.
- See Also:
-
attachVolume
default AttachVolumeResponse attachVolume(AttachVolumeRequest attachVolumeRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance.
- Parameters:
attachVolumeRequest- AttachVolumeInput- Returns:
- Result of the AttachVolume operation returned by the service.
- See Also:
-
attachVolume
default AttachVolumeResponse attachVolume(Consumer<AttachVolumeRequest.Builder> attachVolumeRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance.
This is a convenience which creates an instance of the
AttachVolumeRequest.Builderavoiding the need to create one manually viaAttachVolumeRequest.builder()- Parameters:
attachVolumeRequest- AConsumerthat will call methods onAttachVolumeRequest.Builderto create a request. AttachVolumeInput- Returns:
- Result of the AttachVolume operation returned by the service.
- See Also:
-
cancelArchival
default 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.
- Parameters:
cancelArchivalRequest- CancelArchivalInput- Returns:
- Result of the CancelArchival operation returned by the service.
- See Also:
-
cancelArchival
default 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.Builderavoiding the need to create one manually viaCancelArchivalRequest.builder()- Parameters:
cancelArchivalRequest- AConsumerthat will call methods onCancelArchivalRequest.Builderto create a request. CancelArchivalInput- Returns:
- Result of the CancelArchival operation returned by the service.
- See Also:
-
cancelRetrieval
default 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.
- Parameters:
cancelRetrievalRequest- CancelRetrievalInput- Returns:
- Result of the CancelRetrieval operation returned by the service.
- See Also:
-
cancelRetrieval
default 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.Builderavoiding the need to create one manually viaCancelRetrievalRequest.builder()- Parameters:
cancelRetrievalRequest- AConsumerthat will call methods onCancelRetrievalRequest.Builderto create a request. CancelRetrievalInput- Returns:
- Result of the CancelRetrieval operation returned by the service.
- See Also:
-
createCachediSCSIVolume
default 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
SourceVolumeARNfor this cached volume, which creates an exact copy of the existing volume’s latest recovery point. TheVolumeSizeInBytesvalue must be equal to or larger than the size of the copied volume, in bytes.- Parameters:
createCachediScsiVolumeRequest-- Returns:
- Result of the CreateCachediSCSIVolume operation returned by the service.
- See Also:
-
createCachediSCSIVolume
default 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
SourceVolumeARNfor this cached volume, which creates an exact copy of the existing volume’s latest recovery point. TheVolumeSizeInBytesvalue 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.Builderavoiding the need to create one manually viaCreateCachediScsiVolumeRequest.builder()- Parameters:
createCachediScsiVolumeRequest- AConsumerthat will call methods onCreateCachediScsiVolumeRequest.Builderto create a request.- Returns:
- Result of the CreateCachediSCSIVolume operation returned by the service.
- See Also:
-
createSnapshot
default CreateSnapshotResponse createSnapshot(CreateSnapshotRequest createSnapshotRequest) throws InvalidGatewayRequestException, InternalServerErrorException, ServiceUnavailableErrorException, AwsServiceException, SdkClientException, StorageGatewayException Initiates a snapshot of a volume.
Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (Amazon S3) for durable off-site recovery, and also import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis. This API enables you to take an ad hoc snapshot. For more information, see Editing a snapshot schedule.
In the
CreateSnapshotrequest, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the Storage Gateway console. In response, Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. This operation is only supported in stored and cached volume gateway type.To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the Amazon Elastic Compute Cloud API Reference.
Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page.
- Parameters:
createSnapshotRequest- A JSON object containing one or more of the following fields:- Returns:
- Result of the CreateSnapshot operation returned by the service.
- See Also:
-
createSnapshot
default CreateSnapshotResponse createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest) throws InvalidGatewayRequestException, InternalServerErrorException, ServiceUnavailableErrorException, AwsServiceException, SdkClientException, StorageGatewayException Initiates a snapshot of a volume.
Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (Amazon S3) for durable off-site recovery, and also import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis. This API enables you to take an ad hoc snapshot. For more information, see Editing a snapshot schedule.
In the
CreateSnapshotrequest, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the Storage Gateway console. In response, Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. This operation is only supported in stored and cached volume gateway type.To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the Amazon Elastic Compute Cloud API Reference.
Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page.
This is a convenience which creates an instance of the
CreateSnapshotRequest.Builderavoiding the need to create one manually viaCreateSnapshotRequest.builder()- Parameters:
createSnapshotRequest- AConsumerthat will call methods onCreateSnapshotRequest.Builderto create a request. A JSON object containing one or more of the following fields:- Returns:
- Result of the CreateSnapshot operation returned by the service.
- See Also:
-
createSnapshotFromVolumeRecoveryPoint
default 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
CreateSnapshotFromVolumeRecoveryPointrequest, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and its description appear in the Storage Gateway console. In response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the Amazon Elastic Compute Cloud API Reference.
- Parameters:
createSnapshotFromVolumeRecoveryPointRequest-- Returns:
- Result of the CreateSnapshotFromVolumeRecoveryPoint operation returned by the service.
- See Also:
-
createSnapshotFromVolumeRecoveryPoint
default 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
CreateSnapshotFromVolumeRecoveryPointrequest, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and its description appear in the Storage Gateway console. In response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the Amazon Elastic Compute Cloud API Reference.
This is a convenience which creates an instance of the
CreateSnapshotFromVolumeRecoveryPointRequest.Builderavoiding the need to create one manually viaCreateSnapshotFromVolumeRecoveryPointRequest.builder()- Parameters:
createSnapshotFromVolumeRecoveryPointRequest- AConsumerthat will call methods onCreateSnapshotFromVolumeRecoveryPointRequest.Builderto create a request.- Returns:
- Result of the CreateSnapshotFromVolumeRecoveryPoint operation returned by the service.
- See Also:
-
createStorediSCSIVolume
default 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.
- Parameters:
createStorediScsiVolumeRequest- A JSON object containing one or more of the following fields:- Returns:
- Result of the CreateStorediSCSIVolume operation returned by the service.
- See Also:
-
createStorediSCSIVolume
default 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.Builderavoiding the need to create one manually viaCreateStorediScsiVolumeRequest.builder()- Parameters:
createStorediScsiVolumeRequest- AConsumerthat will call methods onCreateStorediScsiVolumeRequest.Builderto create a request. A JSON object containing one or more of the following fields:- Returns:
- Result of the CreateStorediSCSIVolume operation returned by the service.
- See Also:
-
createTapePool
default CreateTapePoolResponse createTapePool(CreateTapePoolRequest createTapePoolRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Creates a new custom tape pool. You can use custom tape pool to enable tape retention lock on tapes that are archived in the custom pool.
- Parameters:
createTapePoolRequest-- Returns:
- Result of the CreateTapePool operation returned by the service.
- See Also:
-
createTapePool
default CreateTapePoolResponse createTapePool(Consumer<CreateTapePoolRequest.Builder> createTapePoolRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Creates a new custom tape pool. You can use custom tape pool to enable tape retention lock on tapes that are archived in the custom pool.
This is a convenience which creates an instance of the
CreateTapePoolRequest.Builderavoiding the need to create one manually viaCreateTapePoolRequest.builder()- Parameters:
createTapePoolRequest- AConsumerthat will call methods onCreateTapePoolRequest.Builderto create a request.- Returns:
- Result of the CreateTapePool operation returned by the service.
- See Also:
-
createTapeWithBarcode
default 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 cannot be reused if it has already been used on a tape. This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type.
Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.
- Parameters:
createTapeWithBarcodeRequest- CreateTapeWithBarcodeInput- Returns:
- Result of the CreateTapeWithBarcode operation returned by the service.
- See Also:
-
createTapeWithBarcode
default 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 cannot be reused if it has already been used on a tape. This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type.
Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.
This is a convenience which creates an instance of the
CreateTapeWithBarcodeRequest.Builderavoiding the need to create one manually viaCreateTapeWithBarcodeRequest.builder()- Parameters:
createTapeWithBarcodeRequest- AConsumerthat will call methods onCreateTapeWithBarcodeRequest.Builderto create a request. CreateTapeWithBarcodeInput- Returns:
- Result of the CreateTapeWithBarcode operation returned by the service.
- See Also:
-
createTapes
default 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.
- Parameters:
createTapesRequest- CreateTapesInput- Returns:
- Result of the CreateTapes operation returned by the service.
- See Also:
-
createTapes
default 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.Builderavoiding the need to create one manually viaCreateTapesRequest.builder()- Parameters:
createTapesRequest- AConsumerthat will call methods onCreateTapesRequest.Builderto create a request. CreateTapesInput- Returns:
- Result of the CreateTapes operation returned by the service.
- See Also:
-
deleteAutomaticTapeCreationPolicy
default DeleteAutomaticTapeCreationPolicyResponse deleteAutomaticTapeCreationPolicy(DeleteAutomaticTapeCreationPolicyRequest deleteAutomaticTapeCreationPolicyRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Deletes the automatic tape creation policy of a gateway. If you delete this policy, new virtual tapes must be created manually. Use the Amazon Resource Name (ARN) of the gateway in your request to remove the policy.
- Parameters:
deleteAutomaticTapeCreationPolicyRequest-- Returns:
- Result of the DeleteAutomaticTapeCreationPolicy operation returned by the service.
- See Also:
-
deleteAutomaticTapeCreationPolicy
default DeleteAutomaticTapeCreationPolicyResponse deleteAutomaticTapeCreationPolicy(Consumer<DeleteAutomaticTapeCreationPolicyRequest.Builder> deleteAutomaticTapeCreationPolicyRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Deletes the automatic tape creation policy of a gateway. If you delete this policy, new virtual tapes must be created manually. Use the Amazon Resource Name (ARN) of the gateway in your request to remove the policy.
This is a convenience which creates an instance of the
DeleteAutomaticTapeCreationPolicyRequest.Builderavoiding the need to create one manually viaDeleteAutomaticTapeCreationPolicyRequest.builder()- Parameters:
deleteAutomaticTapeCreationPolicyRequest- AConsumerthat will call methods onDeleteAutomaticTapeCreationPolicyRequest.Builderto create a request.- Returns:
- Result of the DeleteAutomaticTapeCreationPolicy operation returned by the service.
- See Also:
-
deleteBandwidthRateLimit
default 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. This operation is supported only for the stored volume, cached volume, and tape gateway types.
- Parameters:
deleteBandwidthRateLimitRequest- A JSON object containing the following fields:- Returns:
- Result of the DeleteBandwidthRateLimit operation returned by the service.
- See Also:
-
deleteBandwidthRateLimit
default 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 operation is supported only for the stored volume, cached volume, and tape gateway types.
This is a convenience which creates an instance of the
DeleteBandwidthRateLimitRequest.Builderavoiding the need to create one manually viaDeleteBandwidthRateLimitRequest.builder()- Parameters:
deleteBandwidthRateLimitRequest- AConsumerthat will call methods onDeleteBandwidthRateLimitRequest.Builderto create a request. A JSON object containing the following fields:- Returns:
- Result of the DeleteBandwidthRateLimit operation returned by the service.
- See Also:
-
deleteChapCredentials
default 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. This operation is supported in volume and tape gateway types.
- Parameters:
deleteChapCredentialsRequest- A JSON object containing one or more of the following fields:- Returns:
- Result of the DeleteChapCredentials operation returned by the service.
- See Also:
-
deleteChapCredentials
default 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 operation is supported in volume and tape gateway types.
This is a convenience which creates an instance of the
DeleteChapCredentialsRequest.Builderavoiding the need to create one manually viaDeleteChapCredentialsRequest.builder()- Parameters:
deleteChapCredentialsRequest- AConsumerthat will call methods onDeleteChapCredentialsRequest.Builderto create a request. A JSON object containing one or more of the following fields:- Returns:
- Result of the DeleteChapCredentials operation returned by the service.
- See Also:
-
deleteGateway
default 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 Storage Gateway detail page.
- Parameters:
deleteGatewayRequest- A JSON object containing the ID of the gateway to delete.- Returns:
- Result of the DeleteGateway operation returned by the service.
- See Also:
-
deleteGateway
default 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 Storage Gateway detail page.
This is a convenience which creates an instance of the
DeleteGatewayRequest.Builderavoiding the need to create one manually viaDeleteGatewayRequest.builder()- Parameters:
deleteGatewayRequest- AConsumerthat will call methods onDeleteGatewayRequest.Builderto create a request. A JSON object containing the ID of the gateway to delete.- Returns:
- Result of the DeleteGateway operation returned by the service.
- See Also:
-
deleteSnapshotSchedule
default 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 Backing up your volumes. In the
DeleteSnapshotSchedulerequest, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported for cached volume gateway types.To list or delete a snapshot, you must use the Amazon EC2 API. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.
- Parameters:
deleteSnapshotScheduleRequest-- Returns:
- Result of the DeleteSnapshotSchedule operation returned by the service.
- See Also:
-
deleteSnapshotSchedule
default 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 Backing up your volumes. In the
DeleteSnapshotSchedulerequest, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported for cached volume gateway types.To list or delete a snapshot, you must use the Amazon EC2 API. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.
This is a convenience which creates an instance of the
DeleteSnapshotScheduleRequest.Builderavoiding the need to create one manually viaDeleteSnapshotScheduleRequest.builder()- Parameters:
deleteSnapshotScheduleRequest- AConsumerthat will call methods onDeleteSnapshotScheduleRequest.Builderto create a request.- Returns:
- Result of the DeleteSnapshotSchedule operation returned by the service.
- See Also:
-
deleteTape
default 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.
- Parameters:
deleteTapeRequest- DeleteTapeInput- Returns:
- Result of the DeleteTape operation returned by the service.
- See Also:
-
deleteTape
default 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.Builderavoiding the need to create one manually viaDeleteTapeRequest.builder()- Parameters:
deleteTapeRequest- AConsumerthat will call methods onDeleteTapeRequest.Builderto create a request. DeleteTapeInput- Returns:
- Result of the DeleteTape operation returned by the service.
- See Also:
-
deleteTapeArchive
default 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.
- Parameters:
deleteTapeArchiveRequest- DeleteTapeArchiveInput- Returns:
- Result of the DeleteTapeArchive operation returned by the service.
- See Also:
-
deleteTapeArchive
default 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.Builderavoiding the need to create one manually viaDeleteTapeArchiveRequest.builder()- Parameters:
deleteTapeArchiveRequest- AConsumerthat will call methods onDeleteTapeArchiveRequest.Builderto create a request. DeleteTapeArchiveInput- Returns:
- Result of the DeleteTapeArchive operation returned by the service.
- See Also:
-
deleteTapePool
default DeleteTapePoolResponse deleteTapePool(DeleteTapePoolRequest deleteTapePoolRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Delete a custom tape pool. A custom tape pool can only be deleted if there are no tapes in the pool and if there are no automatic tape creation policies that reference the custom tape pool.
- Parameters:
deleteTapePoolRequest-- Returns:
- Result of the DeleteTapePool operation returned by the service.
- See Also:
-
deleteTapePool
default DeleteTapePoolResponse deleteTapePool(Consumer<DeleteTapePoolRequest.Builder> deleteTapePoolRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Delete a custom tape pool. A custom tape pool can only be deleted if there are no tapes in the pool and if there are no automatic tape creation policies that reference the custom tape pool.
This is a convenience which creates an instance of the
DeleteTapePoolRequest.Builderavoiding the need to create one manually viaDeleteTapePoolRequest.builder()- Parameters:
deleteTapePoolRequest- AConsumerthat will call methods onDeleteTapePoolRequest.Builderto create a request.- Returns:
- Result of the DeleteTapePool operation returned by the service.
- See Also:
-
deleteVolume
default 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.
- Parameters:
deleteVolumeRequest- A JSON object containing the DeleteVolumeInputinvalid input: '$'VolumeARN to delete.- Returns:
- Result of the DeleteVolume operation returned by the service.
- See Also:
-
deleteVolume
default 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.Builderavoiding the need to create one manually viaDeleteVolumeRequest.builder()- Parameters:
deleteVolumeRequest- AConsumerthat will call methods onDeleteVolumeRequest.Builderto create a request. A JSON object containing the DeleteVolumeInputinvalid input: '$'VolumeARN to delete.- Returns:
- Result of the DeleteVolume operation returned by the service.
- See Also:
-
describeAvailabilityMonitorTest
default DescribeAvailabilityMonitorTestResponse describeAvailabilityMonitorTest(DescribeAvailabilityMonitorTestRequest describeAvailabilityMonitorTestRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Returns information about the most recent high availability monitoring test that was performed on the host in a cluster. If a test isn't performed, the status and start time in the response would be null.
- Parameters:
describeAvailabilityMonitorTestRequest-- Returns:
- Result of the DescribeAvailabilityMonitorTest operation returned by the service.
- See Also:
-
describeAvailabilityMonitorTest
default DescribeAvailabilityMonitorTestResponse describeAvailabilityMonitorTest(Consumer<DescribeAvailabilityMonitorTestRequest.Builder> describeAvailabilityMonitorTestRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Returns information about the most recent high availability monitoring test that was performed on the host in a cluster. If a test isn't performed, the status and start time in the response would be null.
This is a convenience which creates an instance of the
DescribeAvailabilityMonitorTestRequest.Builderavoiding the need to create one manually viaDescribeAvailabilityMonitorTestRequest.builder()- Parameters:
describeAvailabilityMonitorTestRequest- AConsumerthat will call methods onDescribeAvailabilityMonitorTestRequest.Builderto create a request.- Returns:
- Result of the DescribeAvailabilityMonitorTest operation returned by the service.
- See Also:
-
describeBandwidthRateLimit
default 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 is supported only for the stored volume, cached volume, and tape gateway types. To describe bandwidth rate limits for S3 file gateways, use DescribeBandwidthRateLimitSchedule.
This operation returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
- Parameters:
describeBandwidthRateLimitRequest- A JSON object containing the Amazon Resource Name (ARN) of the gateway.- Returns:
- Result of the DescribeBandwidthRateLimit operation returned by the service.
- See Also:
-
describeBandwidthRateLimit
default 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 is supported only for the stored volume, cached volume, and tape gateway types. To describe bandwidth rate limits for S3 file gateways, use DescribeBandwidthRateLimitSchedule.
This operation returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
This is a convenience which creates an instance of the
DescribeBandwidthRateLimitRequest.Builderavoiding the need to create one manually viaDescribeBandwidthRateLimitRequest.builder()- Parameters:
describeBandwidthRateLimitRequest- AConsumerthat will call methods onDescribeBandwidthRateLimitRequest.Builderto create a request. A JSON object containing the Amazon Resource Name (ARN) of the gateway.- Returns:
- Result of the DescribeBandwidthRateLimit operation returned by the service.
- See Also:
-
describeBandwidthRateLimitSchedule
default DescribeBandwidthRateLimitScheduleResponse describeBandwidthRateLimitSchedule(DescribeBandwidthRateLimitScheduleRequest describeBandwidthRateLimitScheduleRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Returns information about the bandwidth rate limit schedule of a gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. This operation is supported only for volume, tape and S3 file gateways. FSx file gateways do not support bandwidth rate limits.
This operation returns information about a gateway's bandwidth rate limit schedule. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.
A bandwidth rate limit interval consists of one or more days of the week, a start hour and minute, an ending hour and minute, and bandwidth rate limits for uploading and downloading
If no bandwidth rate limit schedule intervals are set for the gateway, this operation returns an empty response. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
- Parameters:
describeBandwidthRateLimitScheduleRequest-- Returns:
- Result of the DescribeBandwidthRateLimitSchedule operation returned by the service.
- See Also:
-
describeBandwidthRateLimitSchedule
default DescribeBandwidthRateLimitScheduleResponse describeBandwidthRateLimitSchedule(Consumer<DescribeBandwidthRateLimitScheduleRequest.Builder> describeBandwidthRateLimitScheduleRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Returns information about the bandwidth rate limit schedule of a gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. This operation is supported only for volume, tape and S3 file gateways. FSx file gateways do not support bandwidth rate limits.
This operation returns information about a gateway's bandwidth rate limit schedule. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.
A bandwidth rate limit interval consists of one or more days of the week, a start hour and minute, an ending hour and minute, and bandwidth rate limits for uploading and downloading
If no bandwidth rate limit schedule intervals are set for the gateway, this operation returns an empty response. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
This is a convenience which creates an instance of the
DescribeBandwidthRateLimitScheduleRequest.Builderavoiding the need to create one manually viaDescribeBandwidthRateLimitScheduleRequest.builder()- Parameters:
describeBandwidthRateLimitScheduleRequest- AConsumerthat will call methods onDescribeBandwidthRateLimitScheduleRequest.Builderto create a request.- Returns:
- Result of the DescribeBandwidthRateLimitSchedule operation returned by the service.
- See Also:
-
describeCache
default 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.
- Parameters:
describeCacheRequest-- Returns:
- Result of the DescribeCache operation returned by the service.
- See Also:
-
describeCache
default 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.Builderavoiding the need to create one manually viaDescribeCacheRequest.builder()- Parameters:
describeCacheRequest- AConsumerthat will call methods onDescribeCacheRequest.Builderto create a request.- Returns:
- Result of the DescribeCache operation returned by the service.
- See Also:
-
describeCachediSCSIVolumes
default 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, Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).
- Parameters:
describeCachediScsiVolumesRequest-- Returns:
- Result of the DescribeCachediSCSIVolumes operation returned by the service.
- See Also:
-
describeCachediSCSIVolumes
default 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, Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).
This is a convenience which creates an instance of the
DescribeCachediScsiVolumesRequest.Builderavoiding the need to create one manually viaDescribeCachediScsiVolumesRequest.builder()- Parameters:
describeCachediScsiVolumesRequest- AConsumerthat will call methods onDescribeCachediScsiVolumesRequest.Builderto create a request.- Returns:
- Result of the DescribeCachediSCSIVolumes operation returned by the service.
- See Also:
-
describeChapCredentials
default 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. This operation is supported in the volume and tape gateway types.
- Parameters:
describeChapCredentialsRequest- A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.- Returns:
- Result of the DescribeChapCredentials operation returned by the service.
- See Also:
-
describeChapCredentials
default 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 operation is supported in the volume and tape gateway types.
This is a convenience which creates an instance of the
DescribeChapCredentialsRequest.Builderavoiding the need to create one manually viaDescribeChapCredentialsRequest.builder()- Parameters:
describeChapCredentialsRequest- AConsumerthat will call methods onDescribeChapCredentialsRequest.Builderto create a request. A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.- Returns:
- Result of the DescribeChapCredentials operation returned by the service.
- See Also:
-
describeFileSystemAssociations
default DescribeFileSystemAssociationsResponse describeFileSystemAssociations(DescribeFileSystemAssociationsRequest describeFileSystemAssociationsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Gets the file system association information. This operation is only supported for FSx File Gateways.
- Parameters:
describeFileSystemAssociationsRequest-- Returns:
- Result of the DescribeFileSystemAssociations operation returned by the service.
- See Also:
-
describeFileSystemAssociations
default DescribeFileSystemAssociationsResponse describeFileSystemAssociations(Consumer<DescribeFileSystemAssociationsRequest.Builder> describeFileSystemAssociationsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Gets the file system association information. This operation is only supported for FSx File Gateways.
This is a convenience which creates an instance of the
DescribeFileSystemAssociationsRequest.Builderavoiding the need to create one manually viaDescribeFileSystemAssociationsRequest.builder()- Parameters:
describeFileSystemAssociationsRequest- AConsumerthat will call methods onDescribeFileSystemAssociationsRequest.Builderto create a request.- Returns:
- Result of the DescribeFileSystemAssociations operation returned by the service.
- See Also:
-
describeGatewayInformation
default DescribeGatewayInformationResponse describeGatewayInformation(DescribeGatewayInformationRequest describeGatewayInformationRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Returns metadata about a gateway such as its name, network interfaces, time zone, status, and software version. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
- Parameters:
describeGatewayInformationRequest- A JSON object containing the ID of the gateway.- Returns:
- Result of the DescribeGatewayInformation operation returned by the service.
- See Also:
-
describeGatewayInformation
default DescribeGatewayInformationResponse describeGatewayInformation(Consumer<DescribeGatewayInformationRequest.Builder> describeGatewayInformationRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Returns metadata about a gateway such as its name, network interfaces, time zone, status, and software version. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
This is a convenience which creates an instance of the
DescribeGatewayInformationRequest.Builderavoiding the need to create one manually viaDescribeGatewayInformationRequest.builder()- Parameters:
describeGatewayInformationRequest- AConsumerthat will call methods onDescribeGatewayInformationRequest.Builderto create a request. A JSON object containing the ID of the gateway.- Returns:
- Result of the DescribeGatewayInformation operation returned by the service.
- See Also:
-
describeMaintenanceStartTime
default DescribeMaintenanceStartTimeResponse describeMaintenanceStartTime(DescribeMaintenanceStartTimeRequest describeMaintenanceStartTimeRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Returns your gateway's maintenance window schedule information, with values for monthly or weekly cadence, specific day and time to begin maintenance, and which types of updates to apply. Time values returned are for the gateway's time zone.
- Parameters:
describeMaintenanceStartTimeRequest- A JSON object containing the Amazon Resource Name (ARN) of the gateway.- Returns:
- Result of the DescribeMaintenanceStartTime operation returned by the service.
- See Also:
-
describeMaintenanceStartTime
default DescribeMaintenanceStartTimeResponse describeMaintenanceStartTime(Consumer<DescribeMaintenanceStartTimeRequest.Builder> describeMaintenanceStartTimeRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Returns your gateway's maintenance window schedule information, with values for monthly or weekly cadence, specific day and time to begin maintenance, and which types of updates to apply. Time values returned are for the gateway's time zone.
This is a convenience which creates an instance of the
DescribeMaintenanceStartTimeRequest.Builderavoiding the need to create one manually viaDescribeMaintenanceStartTimeRequest.builder()- Parameters:
describeMaintenanceStartTimeRequest- AConsumerthat will call methods onDescribeMaintenanceStartTimeRequest.Builderto create a request. A JSON object containing the Amazon Resource Name (ARN) of the gateway.- Returns:
- Result of the DescribeMaintenanceStartTime operation returned by the service.
- See Also:
-
describeSMBSettings
default 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.
- Parameters:
describeSmbSettingsRequest-- Returns:
- Result of the DescribeSMBSettings operation returned by the service.
- See Also:
-
describeSMBSettings
default 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.Builderavoiding the need to create one manually viaDescribeSmbSettingsRequest.builder()- Parameters:
describeSmbSettingsRequest- AConsumerthat will call methods onDescribeSmbSettingsRequest.Builderto create a request.- Returns:
- Result of the DescribeSMBSettings operation returned by the service.
- See Also:
-
describeSnapshotSchedule
default 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.
- Parameters:
describeSnapshotScheduleRequest- A JSON object containing the DescribeSnapshotScheduleInputinvalid input: '$'VolumeARN of the volume.- Returns:
- Result of the DescribeSnapshotSchedule operation returned by the service.
- See Also:
-
describeSnapshotSchedule
default 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.Builderavoiding the need to create one manually viaDescribeSnapshotScheduleRequest.builder()- Parameters:
describeSnapshotScheduleRequest- AConsumerthat will call methods onDescribeSnapshotScheduleRequest.Builderto create a request. A JSON object containing the DescribeSnapshotScheduleInputinvalid input: '$'VolumeARN of the volume.- Returns:
- Result of the DescribeSnapshotSchedule operation returned by the service.
- See Also:
-
describeStorediSCSIVolumes
default 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, Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.
- Parameters:
describeStorediScsiVolumesRequest- A JSON object containing a list of DescribeStorediSCSIVolumesInputinvalid input: '$'VolumeARNs.- Returns:
- Result of the DescribeStorediSCSIVolumes operation returned by the service.
- See Also:
-
describeStorediSCSIVolumes
default 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, 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.Builderavoiding the need to create one manually viaDescribeStorediScsiVolumesRequest.builder()- Parameters:
describeStorediScsiVolumesRequest- AConsumerthat will call methods onDescribeStorediScsiVolumesRequest.Builderto create a request. A JSON object containing a list of DescribeStorediSCSIVolumesInputinvalid input: '$'VolumeARNs.- Returns:
- Result of the DescribeStorediSCSIVolumes operation returned by the service.
- See Also:
-
describeTapeArchives
default 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
TapeARNis not specified, Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.- Parameters:
describeTapeArchivesRequest- DescribeTapeArchivesInput- Returns:
- Result of the DescribeTapeArchives operation returned by the service.
- See Also:
-
describeTapeArchives
default 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
TapeARNis not specified, 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.Builderavoiding the need to create one manually viaDescribeTapeArchivesRequest.builder()- Parameters:
describeTapeArchivesRequest- AConsumerthat will call methods onDescribeTapeArchivesRequest.Builderto create a request. DescribeTapeArchivesInput- Returns:
- Result of the DescribeTapeArchives operation returned by the service.
- See Also:
-
describeTapeArchives
default DescribeTapeArchivesResponse describeTapeArchives() throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayExceptionReturns 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
TapeARNis not specified, Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.- Returns:
- Result of the DescribeTapeArchives operation returned by the service.
- See Also:
-
describeTapeArchivesPaginator
default DescribeTapeArchivesIterable describeTapeArchivesPaginator() throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayExceptionThis 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
2) Using For loopsoftware.amazon.awssdk.services.storagegateway.paginators.DescribeTapeArchivesIterable responses = client.describeTapeArchivesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.storagegateway.paginators.DescribeTapeArchivesIterable responses = client.describeTapeArchivesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeTapeArchives(software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeTapeArchivesPaginator
default DescribeTapeArchivesIterable describeTapeArchivesPaginator(DescribeTapeArchivesRequest describeTapeArchivesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException 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
2) Using For loopsoftware.amazon.awssdk.services.storagegateway.paginators.DescribeTapeArchivesIterable responses = client.describeTapeArchivesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.storagegateway.paginators.DescribeTapeArchivesIterable responses = client.describeTapeArchivesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeTapeArchives(software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesRequest)operation.- Parameters:
describeTapeArchivesRequest- DescribeTapeArchivesInput- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeTapeArchivesPaginator
default DescribeTapeArchivesIterable describeTapeArchivesPaginator(Consumer<DescribeTapeArchivesRequest.Builder> describeTapeArchivesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException 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
2) Using For loopsoftware.amazon.awssdk.services.storagegateway.paginators.DescribeTapeArchivesIterable responses = client.describeTapeArchivesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.storagegateway.paginators.DescribeTapeArchivesIterable responses = client.describeTapeArchivesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeTapeArchives(software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesRequest)operation.
This is a convenience which creates an instance of the
DescribeTapeArchivesRequest.Builderavoiding the need to create one manually viaDescribeTapeArchivesRequest.builder()- Parameters:
describeTapeArchivesRequest- AConsumerthat will call methods onDescribeTapeArchivesRequest.Builderto create a request. DescribeTapeArchivesInput- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeTapeRecoveryPoints
default 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.
- Parameters:
describeTapeRecoveryPointsRequest- DescribeTapeRecoveryPointsInput- Returns:
- Result of the DescribeTapeRecoveryPoints operation returned by the service.
- See Also:
-
describeTapeRecoveryPoints
default 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.Builderavoiding the need to create one manually viaDescribeTapeRecoveryPointsRequest.builder()- Parameters:
describeTapeRecoveryPointsRequest- AConsumerthat will call methods onDescribeTapeRecoveryPointsRequest.Builderto create a request. DescribeTapeRecoveryPointsInput- Returns:
- Result of the DescribeTapeRecoveryPoints operation returned by the service.
- See Also:
-
describeTapeRecoveryPointsPaginator
default DescribeTapeRecoveryPointsIterable describeTapeRecoveryPointsPaginator(DescribeTapeRecoveryPointsRequest describeTapeRecoveryPointsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException 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
2) Using For loopsoftware.amazon.awssdk.services.storagegateway.paginators.DescribeTapeRecoveryPointsIterable responses = client.describeTapeRecoveryPointsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.storagegateway.paginators.DescribeTapeRecoveryPointsIterable responses = client.describeTapeRecoveryPointsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeTapeRecoveryPoints(software.amazon.awssdk.services.storagegateway.model.DescribeTapeRecoveryPointsRequest)operation.- Parameters:
describeTapeRecoveryPointsRequest- DescribeTapeRecoveryPointsInput- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeTapeRecoveryPointsPaginator
default DescribeTapeRecoveryPointsIterable describeTapeRecoveryPointsPaginator(Consumer<DescribeTapeRecoveryPointsRequest.Builder> describeTapeRecoveryPointsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException 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
2) Using For loopsoftware.amazon.awssdk.services.storagegateway.paginators.DescribeTapeRecoveryPointsIterable responses = client.describeTapeRecoveryPointsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.storagegateway.paginators.DescribeTapeRecoveryPointsIterable responses = client.describeTapeRecoveryPointsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeTapeRecoveryPoints(software.amazon.awssdk.services.storagegateway.model.DescribeTapeRecoveryPointsRequest)operation.
This is a convenience which creates an instance of the
DescribeTapeRecoveryPointsRequest.Builderavoiding the need to create one manually viaDescribeTapeRecoveryPointsRequest.builder()- Parameters:
describeTapeRecoveryPointsRequest- AConsumerthat will call methods onDescribeTapeRecoveryPointsRequest.Builderto create a request. DescribeTapeRecoveryPointsInput- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeTapes
default DescribeTapesResponse describeTapes(DescribeTapesRequest describeTapesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Returns a description of virtual tapes that correspond to the specified Amazon Resource Names (ARNs). If
TapeARNis not specified, returns a description of the virtual tapes associated with the specified gateway. This operation is only supported for the tape gateway type.The operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the
Limitfield 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 aMarkerfield. You can use thisMarkervalue in your subsequent request to retrieve the next set of tapes.- Parameters:
describeTapesRequest- DescribeTapesInput- Returns:
- Result of the DescribeTapes operation returned by the service.
- See Also:
-
describeTapes
default DescribeTapesResponse describeTapes(Consumer<DescribeTapesRequest.Builder> describeTapesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Returns a description of virtual tapes that correspond to the specified Amazon Resource Names (ARNs). If
TapeARNis not specified, returns a description of the virtual tapes associated with the specified gateway. This operation is only supported for the tape gateway type.The operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the
Limitfield 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 aMarkerfield. You can use thisMarkervalue in your subsequent request to retrieve the next set of tapes.
This is a convenience which creates an instance of the
DescribeTapesRequest.Builderavoiding the need to create one manually viaDescribeTapesRequest.builder()- Parameters:
describeTapesRequest- AConsumerthat will call methods onDescribeTapesRequest.Builderto create a request. DescribeTapesInput- Returns:
- Result of the DescribeTapes operation returned by the service.
- See Also:
-
describeTapesPaginator
default DescribeTapesIterable describeTapesPaginator(DescribeTapesRequest describeTapesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException 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
2) Using For loopsoftware.amazon.awssdk.services.storagegateway.paginators.DescribeTapesIterable responses = client.describeTapesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.storagegateway.paginators.DescribeTapesIterable responses = client.describeTapesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeTapes(software.amazon.awssdk.services.storagegateway.model.DescribeTapesRequest)operation.- Parameters:
describeTapesRequest- DescribeTapesInput- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeTapesPaginator
default DescribeTapesIterable describeTapesPaginator(Consumer<DescribeTapesRequest.Builder> describeTapesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException 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
2) Using For loopsoftware.amazon.awssdk.services.storagegateway.paginators.DescribeTapesIterable responses = client.describeTapesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.storagegateway.paginators.DescribeTapesIterable responses = client.describeTapesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeTapes(software.amazon.awssdk.services.storagegateway.model.DescribeTapesRequest)operation.
This is a convenience which creates an instance of the
DescribeTapesRequest.Builderavoiding the need to create one manually viaDescribeTapesRequest.builder()- Parameters:
describeTapesRequest- AConsumerthat will call methods onDescribeTapesRequest.Builderto create a request. DescribeTapesInput- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeUploadBuffer
default 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.
- Parameters:
describeUploadBufferRequest-- Returns:
- Result of the DescribeUploadBuffer operation returned by the service.
- See Also:
-
describeUploadBuffer
default 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.Builderavoiding the need to create one manually viaDescribeUploadBufferRequest.builder()- Parameters:
describeUploadBufferRequest- AConsumerthat will call methods onDescribeUploadBufferRequest.Builderto create a request.- Returns:
- Result of the DescribeUploadBuffer operation returned by the service.
- See Also:
-
describeVTLDevices
default 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, Storage Gateway returns VTL device information.
This operation is only supported in the tape gateway type.
- Parameters:
describeVtlDevicesRequest- DescribeVTLDevicesInput- Returns:
- Result of the DescribeVTLDevices operation returned by the service.
- See Also:
-
describeVTLDevices
default 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, 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.Builderavoiding the need to create one manually viaDescribeVtlDevicesRequest.builder()- Parameters:
describeVtlDevicesRequest- AConsumerthat will call methods onDescribeVtlDevicesRequest.Builderto create a request. DescribeVTLDevicesInput- Returns:
- Result of the DescribeVTLDevices operation returned by the service.
- See Also:
-
describeVTLDevicesPaginator
default DescribeVTLDevicesIterable describeVTLDevicesPaginator(DescribeVtlDevicesRequest describeVtlDevicesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException 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
2) Using For loopsoftware.amazon.awssdk.services.storagegateway.paginators.DescribeVTLDevicesIterable responses = client.describeVTLDevicesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.storagegateway.paginators.DescribeVTLDevicesIterable responses = client.describeVTLDevicesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeVTLDevices(software.amazon.awssdk.services.storagegateway.model.DescribeVtlDevicesRequest)operation.- Parameters:
describeVtlDevicesRequest- DescribeVTLDevicesInput- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeVTLDevicesPaginator
default DescribeVTLDevicesIterable describeVTLDevicesPaginator(Consumer<DescribeVtlDevicesRequest.Builder> describeVtlDevicesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException 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
2) Using For loopsoftware.amazon.awssdk.services.storagegateway.paginators.DescribeVTLDevicesIterable responses = client.describeVTLDevicesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.storagegateway.paginators.DescribeVTLDevicesIterable responses = client.describeVTLDevicesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeVTLDevices(software.amazon.awssdk.services.storagegateway.model.DescribeVtlDevicesRequest)operation.
This is a convenience which creates an instance of the
DescribeVtlDevicesRequest.Builderavoiding the need to create one manually viaDescribeVtlDevicesRequest.builder()- Parameters:
describeVtlDevicesRequest- AConsumerthat will call methods onDescribeVtlDevicesRequest.Builderto create a request. DescribeVTLDevicesInput- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeWorkingStorage
default 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.
- Parameters:
describeWorkingStorageRequest- A JSON object containing the Amazon Resource Name (ARN) of the gateway.- Returns:
- Result of the DescribeWorkingStorage operation returned by the service.
- See Also:
-
describeWorkingStorage
default 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.Builderavoiding the need to create one manually viaDescribeWorkingStorageRequest.builder()- Parameters:
describeWorkingStorageRequest- AConsumerthat will call methods onDescribeWorkingStorageRequest.Builderto create a request. A JSON object containing the Amazon Resource Name (ARN) of the gateway.- Returns:
- Result of the DescribeWorkingStorage operation returned by the service.
- See Also:
-
detachVolume
default DetachVolumeResponse detachVolume(DetachVolumeRequest detachVolumeRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance. This operation is only supported in the volume gateway type.
- Parameters:
detachVolumeRequest- AttachVolumeInput- Returns:
- Result of the DetachVolume operation returned by the service.
- See Also:
-
detachVolume
default DetachVolumeResponse detachVolume(Consumer<DetachVolumeRequest.Builder> detachVolumeRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance. This operation is only supported in the volume gateway type.
This is a convenience which creates an instance of the
DetachVolumeRequest.Builderavoiding the need to create one manually viaDetachVolumeRequest.builder()- Parameters:
detachVolumeRequest- AConsumerthat will call methods onDetachVolumeRequest.Builderto create a request. AttachVolumeInput- Returns:
- Result of the DetachVolume operation returned by the service.
- See Also:
-
disableGateway
default 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.
After a gateway is disabled, it cannot be enabled.
- Parameters:
disableGatewayRequest- DisableGatewayInput- Returns:
- Result of the DisableGateway operation returned by the service.
- See Also:
-
disableGateway
default 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.
After a gateway is disabled, it cannot be enabled.
This is a convenience which creates an instance of the
DisableGatewayRequest.Builderavoiding the need to create one manually viaDisableGatewayRequest.builder()- Parameters:
disableGatewayRequest- AConsumerthat will call methods onDisableGatewayRequest.Builderto create a request. DisableGatewayInput- Returns:
- Result of the DisableGateway operation returned by the service.
- See Also:
-
disassociateFileSystem
default DisassociateFileSystemResponse disassociateFileSystem(DisassociateFileSystemRequest disassociateFileSystemRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Disassociates an Amazon FSx file system from the specified gateway. After the disassociation process finishes, the gateway can no longer access the Amazon FSx file system. This operation is only supported in the FSx File Gateway type.
- Parameters:
disassociateFileSystemRequest-- Returns:
- Result of the DisassociateFileSystem operation returned by the service.
- See Also:
-
disassociateFileSystem
default DisassociateFileSystemResponse disassociateFileSystem(Consumer<DisassociateFileSystemRequest.Builder> disassociateFileSystemRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Disassociates an Amazon FSx file system from the specified gateway. After the disassociation process finishes, the gateway can no longer access the Amazon FSx file system. This operation is only supported in the FSx File Gateway type.
This is a convenience which creates an instance of the
DisassociateFileSystemRequest.Builderavoiding the need to create one manually viaDisassociateFileSystemRequest.builder()- Parameters:
disassociateFileSystemRequest- AConsumerthat will call methods onDisassociateFileSystemRequest.Builderto create a request.- Returns:
- Result of the DisassociateFileSystem operation returned by the service.
- See Also:
-
joinDomain
default 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.
Joining a domain creates an Active Directory computer account in the default organizational unit, using the gateway's Gateway ID as the account name (for example, SGW-1234ADE). If your Active Directory environment requires that you pre-stage accounts to facilitate the join domain process, you will need to create this account ahead of time.
To create the gateway's computer account in an organizational unit other than the default, you must specify the organizational unit when joining the domain.
- Parameters:
joinDomainRequest- JoinDomainInput- Returns:
- Result of the JoinDomain operation returned by the service.
- See Also:
-
joinDomain
default 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.
Joining a domain creates an Active Directory computer account in the default organizational unit, using the gateway's Gateway ID as the account name (for example, SGW-1234ADE). If your Active Directory environment requires that you pre-stage accounts to facilitate the join domain process, you will need to create this account ahead of time.
To create the gateway's computer account in an organizational unit other than the default, you must specify the organizational unit when joining the domain.
This is a convenience which creates an instance of the
JoinDomainRequest.Builderavoiding the need to create one manually viaJoinDomainRequest.builder()- Parameters:
joinDomainRequest- AConsumerthat will call methods onJoinDomainRequest.Builderto create a request. JoinDomainInput- Returns:
- Result of the JoinDomain operation returned by the service.
- See Also:
-
listAutomaticTapeCreationPolicies
default ListAutomaticTapeCreationPoliciesResponse listAutomaticTapeCreationPolicies(ListAutomaticTapeCreationPoliciesRequest listAutomaticTapeCreationPoliciesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Lists the automatic tape creation policies for a gateway. If there are no automatic tape creation policies for the gateway, it returns an empty list.
This operation is only supported for tape gateways.
- Parameters:
listAutomaticTapeCreationPoliciesRequest-- Returns:
- Result of the ListAutomaticTapeCreationPolicies operation returned by the service.
- See Also:
-
listAutomaticTapeCreationPolicies
default ListAutomaticTapeCreationPoliciesResponse listAutomaticTapeCreationPolicies(Consumer<ListAutomaticTapeCreationPoliciesRequest.Builder> listAutomaticTapeCreationPoliciesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Lists the automatic tape creation policies for a gateway. If there are no automatic tape creation policies for the gateway, it returns an empty list.
This operation is only supported for tape gateways.
This is a convenience which creates an instance of the
ListAutomaticTapeCreationPoliciesRequest.Builderavoiding the need to create one manually viaListAutomaticTapeCreationPoliciesRequest.builder()- Parameters:
listAutomaticTapeCreationPoliciesRequest- AConsumerthat will call methods onListAutomaticTapeCreationPoliciesRequest.Builderto create a request.- Returns:
- Result of the ListAutomaticTapeCreationPolicies operation returned by the service.
- See Also:
-
listFileSystemAssociations
default ListFileSystemAssociationsResponse listFileSystemAssociations(ListFileSystemAssociationsRequest listFileSystemAssociationsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Gets a list of
FileSystemAssociationSummaryobjects. Each object contains a summary of a file system association. This operation is only supported for FSx File Gateways.- Parameters:
listFileSystemAssociationsRequest-- Returns:
- Result of the ListFileSystemAssociations operation returned by the service.
- See Also:
-
listFileSystemAssociations
default ListFileSystemAssociationsResponse listFileSystemAssociations(Consumer<ListFileSystemAssociationsRequest.Builder> listFileSystemAssociationsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Gets a list of
FileSystemAssociationSummaryobjects. Each object contains a summary of a file system association. This operation is only supported for FSx File Gateways.
This is a convenience which creates an instance of the
ListFileSystemAssociationsRequest.Builderavoiding the need to create one manually viaListFileSystemAssociationsRequest.builder()- Parameters:
listFileSystemAssociationsRequest- AConsumerthat will call methods onListFileSystemAssociationsRequest.Builderto create a request.- Returns:
- Result of the ListFileSystemAssociations operation returned by the service.
- See Also:
-
listFileSystemAssociationsPaginator
default ListFileSystemAssociationsIterable listFileSystemAssociationsPaginator(ListFileSystemAssociationsRequest listFileSystemAssociationsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException This is a variant of
listFileSystemAssociations(software.amazon.awssdk.services.storagegateway.model.ListFileSystemAssociationsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.storagegateway.paginators.ListFileSystemAssociationsIterable responses = client.listFileSystemAssociationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.storagegateway.paginators.ListFileSystemAssociationsIterable responses = client .listFileSystemAssociationsPaginator(request); for (software.amazon.awssdk.services.storagegateway.model.ListFileSystemAssociationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.storagegateway.paginators.ListFileSystemAssociationsIterable responses = client.listFileSystemAssociationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFileSystemAssociations(software.amazon.awssdk.services.storagegateway.model.ListFileSystemAssociationsRequest)operation.- Parameters:
listFileSystemAssociationsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFileSystemAssociationsPaginator
default ListFileSystemAssociationsIterable listFileSystemAssociationsPaginator(Consumer<ListFileSystemAssociationsRequest.Builder> listFileSystemAssociationsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException This is a variant of
listFileSystemAssociations(software.amazon.awssdk.services.storagegateway.model.ListFileSystemAssociationsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.storagegateway.paginators.ListFileSystemAssociationsIterable responses = client.listFileSystemAssociationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.storagegateway.paginators.ListFileSystemAssociationsIterable responses = client .listFileSystemAssociationsPaginator(request); for (software.amazon.awssdk.services.storagegateway.model.ListFileSystemAssociationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.storagegateway.paginators.ListFileSystemAssociationsIterable responses = client.listFileSystemAssociationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFileSystemAssociations(software.amazon.awssdk.services.storagegateway.model.ListFileSystemAssociationsRequest)operation.
This is a convenience which creates an instance of the
ListFileSystemAssociationsRequest.Builderavoiding the need to create one manually viaListFileSystemAssociationsRequest.builder()- Parameters:
listFileSystemAssociationsRequest- AConsumerthat will call methods onListFileSystemAssociationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listGateways
default ListGatewaysResponse listGateways(ListGatewaysRequest listGatewaysRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Lists gateways owned by an Amazon Web Services account in an Amazon Web Services Region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).
By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.
If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.
- Parameters:
listGatewaysRequest- A JSON object containing zero or more of the following fields:- Returns:
- Result of the ListGateways operation returned by the service.
- See Also:
-
listGateways
default ListGatewaysResponse listGateways(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Lists gateways owned by an Amazon Web Services account in an Amazon Web Services Region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).
By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.
If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.
This is a convenience which creates an instance of the
ListGatewaysRequest.Builderavoiding the need to create one manually viaListGatewaysRequest.builder()- Parameters:
listGatewaysRequest- AConsumerthat will call methods onListGatewaysRequest.Builderto create a request. A JSON object containing zero or more of the following fields:- Returns:
- Result of the ListGateways operation returned by the service.
- See Also:
-
listGateways
default ListGatewaysResponse listGateways() throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayExceptionLists gateways owned by an Amazon Web Services account in an Amazon Web Services Region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).
By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.
If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.
- Returns:
- Result of the ListGateways operation returned by the service.
- See Also:
-
listGatewaysPaginator
default ListGatewaysIterable listGatewaysPaginator() throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayExceptionThis 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
2) Using For loopsoftware.amazon.awssdk.services.storagegateway.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.storagegateway.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGateways(software.amazon.awssdk.services.storagegateway.model.ListGatewaysRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listGatewaysPaginator
default ListGatewaysIterable listGatewaysPaginator(ListGatewaysRequest listGatewaysRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException 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
2) Using For loopsoftware.amazon.awssdk.services.storagegateway.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.storagegateway.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGateways(software.amazon.awssdk.services.storagegateway.model.ListGatewaysRequest)operation.- Parameters:
listGatewaysRequest- A JSON object containing zero or more of the following fields:- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listGatewaysPaginator
default ListGatewaysIterable listGatewaysPaginator(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException 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
2) Using For loopsoftware.amazon.awssdk.services.storagegateway.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.storagegateway.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGateways(software.amazon.awssdk.services.storagegateway.model.ListGatewaysRequest)operation.
This is a convenience which creates an instance of the
ListGatewaysRequest.Builderavoiding the need to create one manually viaListGatewaysRequest.builder()- Parameters:
listGatewaysRequest- AConsumerthat will call methods onListGatewaysRequest.Builderto create a request. A JSON object containing zero or more of the following fields:- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listLocalDisks
default 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
DiskStatusfield. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted).- Parameters:
listLocalDisksRequest- A JSON object containing the Amazon Resource Name (ARN) of the gateway.- Returns:
- Result of the ListLocalDisks operation returned by the service.
- See Also:
-
listLocalDisks
default 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
DiskStatusfield. 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.Builderavoiding the need to create one manually viaListLocalDisksRequest.builder()- Parameters:
listLocalDisksRequest- AConsumerthat will call methods onListLocalDisksRequest.Builderto create a request. A JSON object containing the Amazon Resource Name (ARN) of the gateway.- Returns:
- Result of the ListLocalDisks operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Lists the tags that have been added to the specified resource. This operation is supported in storage gateways of all types.
- Parameters:
listTagsForResourceRequest- ListTagsForResourceInput- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default 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 supported in storage gateways of all types.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request. ListTagsForResourceInput- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException This is a variant of
listTagsForResource(software.amazon.awssdk.services.storagegateway.model.ListTagsForResourceRequest)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
2) Using For loopsoftware.amazon.awssdk.services.storagegateway.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.storagegateway.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.storagegateway.model.ListTagsForResourceResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.storagegateway.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.storagegateway.model.ListTagsForResourceRequest)operation.- Parameters:
listTagsForResourceRequest- ListTagsForResourceInput- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException This is a variant of
listTagsForResource(software.amazon.awssdk.services.storagegateway.model.ListTagsForResourceRequest)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
2) Using For loopsoftware.amazon.awssdk.services.storagegateway.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.storagegateway.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.storagegateway.model.ListTagsForResourceResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.storagegateway.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.storagegateway.model.ListTagsForResourceRequest)operation.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request. ListTagsForResourceInput- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTapePools
default ListTapePoolsResponse listTapePools(ListTapePoolsRequest listTapePoolsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Lists custom tape pools. You specify custom tape pools to list by specifying one or more custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN, the operation lists all custom tape pools.
This operation supports pagination. You can optionally specify the
Limitparameter in the body to limit the number of tape pools in the response. If the number of tape pools returned in the response is truncated, the response includes aMarkerelement that you can use in your subsequent request to retrieve the next set of tape pools.- Parameters:
listTapePoolsRequest-- Returns:
- Result of the ListTapePools operation returned by the service.
- See Also:
-
listTapePools
default ListTapePoolsResponse listTapePools(Consumer<ListTapePoolsRequest.Builder> listTapePoolsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Lists custom tape pools. You specify custom tape pools to list by specifying one or more custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN, the operation lists all custom tape pools.
This operation supports pagination. You can optionally specify the
Limitparameter in the body to limit the number of tape pools in the response. If the number of tape pools returned in the response is truncated, the response includes aMarkerelement that you can use in your subsequent request to retrieve the next set of tape pools.
This is a convenience which creates an instance of the
ListTapePoolsRequest.Builderavoiding the need to create one manually viaListTapePoolsRequest.builder()- Parameters:
listTapePoolsRequest- AConsumerthat will call methods onListTapePoolsRequest.Builderto create a request.- Returns:
- Result of the ListTapePools operation returned by the service.
- See Also:
-
listTapePoolsPaginator
default ListTapePoolsIterable listTapePoolsPaginator(ListTapePoolsRequest listTapePoolsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException This is a variant of
listTapePools(software.amazon.awssdk.services.storagegateway.model.ListTapePoolsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.storagegateway.paginators.ListTapePoolsIterable responses = client.listTapePoolsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.storagegateway.paginators.ListTapePoolsIterable responses = client .listTapePoolsPaginator(request); for (software.amazon.awssdk.services.storagegateway.model.ListTapePoolsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.storagegateway.paginators.ListTapePoolsIterable responses = client.listTapePoolsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTapePools(software.amazon.awssdk.services.storagegateway.model.ListTapePoolsRequest)operation.- Parameters:
listTapePoolsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTapePoolsPaginator
default ListTapePoolsIterable listTapePoolsPaginator(Consumer<ListTapePoolsRequest.Builder> listTapePoolsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException This is a variant of
listTapePools(software.amazon.awssdk.services.storagegateway.model.ListTapePoolsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.storagegateway.paginators.ListTapePoolsIterable responses = client.listTapePoolsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.storagegateway.paginators.ListTapePoolsIterable responses = client .listTapePoolsPaginator(request); for (software.amazon.awssdk.services.storagegateway.model.ListTapePoolsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.storagegateway.paginators.ListTapePoolsIterable responses = client.listTapePoolsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTapePools(software.amazon.awssdk.services.storagegateway.model.ListTapePoolsRequest)operation.
This is a convenience which creates an instance of the
ListTapePoolsRequest.Builderavoiding the need to create one manually viaListTapePoolsRequest.builder()- Parameters:
listTapePoolsRequest- AConsumerthat will call methods onListTapePoolsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTapes
default 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
Limitparameter 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 aMarkerelement 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.- Parameters:
listTapesRequest- A JSON object that contains one or more of the following fields:- Returns:
- Result of the ListTapes operation returned by the service.
- See Also:
-
listTapes
default 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
Limitparameter 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 aMarkerelement 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.Builderavoiding the need to create one manually viaListTapesRequest.builder()- Parameters:
listTapesRequest- AConsumerthat will call methods onListTapesRequest.Builderto create a request. A JSON object that contains one or more of the following fields:- Returns:
- Result of the ListTapes operation returned by the service.
- See Also:
-
listTapes
default ListTapesResponse listTapes() throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayExceptionLists 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
Limitparameter 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 aMarkerelement 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.- Returns:
- Result of the ListTapes operation returned by the service.
- See Also:
-
listTapesPaginator
default ListTapesIterable listTapesPaginator() throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayExceptionThis is a variant of
listTapes(software.amazon.awssdk.services.storagegateway.model.ListTapesRequest)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
2) Using For loopsoftware.amazon.awssdk.services.storagegateway.paginators.ListTapesIterable responses = client.listTapesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.storagegateway.paginators.ListTapesIterable responses = client.listTapesPaginator(request); for (software.amazon.awssdk.services.storagegateway.model.ListTapesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.storagegateway.paginators.ListTapesIterable responses = client.listTapesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTapes(software.amazon.awssdk.services.storagegateway.model.ListTapesRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTapesPaginator
default ListTapesIterable listTapesPaginator(ListTapesRequest listTapesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException This is a variant of
listTapes(software.amazon.awssdk.services.storagegateway.model.ListTapesRequest)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
2) Using For loopsoftware.amazon.awssdk.services.storagegateway.paginators.ListTapesIterable responses = client.listTapesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.storagegateway.paginators.ListTapesIterable responses = client.listTapesPaginator(request); for (software.amazon.awssdk.services.storagegateway.model.ListTapesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.storagegateway.paginators.ListTapesIterable responses = client.listTapesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTapes(software.amazon.awssdk.services.storagegateway.model.ListTapesRequest)operation.- Parameters:
listTapesRequest- A JSON object that contains one or more of the following fields:- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTapesPaginator
default ListTapesIterable listTapesPaginator(Consumer<ListTapesRequest.Builder> listTapesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException This is a variant of
listTapes(software.amazon.awssdk.services.storagegateway.model.ListTapesRequest)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
2) Using For loopsoftware.amazon.awssdk.services.storagegateway.paginators.ListTapesIterable responses = client.listTapesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.storagegateway.paginators.ListTapesIterable responses = client.listTapesPaginator(request); for (software.amazon.awssdk.services.storagegateway.model.ListTapesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.storagegateway.paginators.ListTapesIterable responses = client.listTapesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTapes(software.amazon.awssdk.services.storagegateway.model.ListTapesRequest)operation.
This is a convenience which creates an instance of the
ListTapesRequest.Builderavoiding the need to create one manually viaListTapesRequest.builder()- Parameters:
listTapesRequest- AConsumerthat will call methods onListTapesRequest.Builderto create a request. A JSON object that contains one or more of the following fields:- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listVolumeInitiators
default 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.
- Parameters:
listVolumeInitiatorsRequest- ListVolumeInitiatorsInput- Returns:
- Result of the ListVolumeInitiators operation returned by the service.
- See Also:
-
listVolumeInitiators
default 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.Builderavoiding the need to create one manually viaListVolumeInitiatorsRequest.builder()- Parameters:
listVolumeInitiatorsRequest- AConsumerthat will call methods onListVolumeInitiatorsRequest.Builderto create a request. ListVolumeInitiatorsInput- Returns:
- Result of the ListVolumeInitiators operation returned by the service.
- See Also:
-
listVolumeRecoveryPoints
default 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.
- Parameters:
listVolumeRecoveryPointsRequest-- Returns:
- Result of the ListVolumeRecoveryPoints operation returned by the service.
- See Also:
-
listVolumeRecoveryPoints
default 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.Builderavoiding the need to create one manually viaListVolumeRecoveryPointsRequest.builder()- Parameters:
listVolumeRecoveryPointsRequest- AConsumerthat will call methods onListVolumeRecoveryPointsRequest.Builderto create a request.- Returns:
- Result of the ListVolumeRecoveryPoints operation returned by the service.
- See Also:
-
listVolumes
default 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
Limitfield 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.- Parameters:
listVolumesRequest- A JSON object that contains one or more of the following fields:- Returns:
- Result of the ListVolumes operation returned by the service.
- See Also:
-
listVolumes
default 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
Limitfield 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.Builderavoiding the need to create one manually viaListVolumesRequest.builder()- Parameters:
listVolumesRequest- AConsumerthat will call methods onListVolumesRequest.Builderto create a request. A JSON object that contains one or more of the following fields:- Returns:
- Result of the ListVolumes operation returned by the service.
- See Also:
-
listVolumes
default ListVolumesResponse listVolumes() throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayExceptionLists 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
Limitfield 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.- Returns:
- Result of the ListVolumes operation returned by the service.
- See Also:
-
listVolumesPaginator
default ListVolumesIterable listVolumesPaginator() throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayExceptionThis 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
2) Using For loopsoftware.amazon.awssdk.services.storagegateway.paginators.ListVolumesIterable responses = client.listVolumesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.storagegateway.paginators.ListVolumesIterable responses = client.listVolumesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVolumes(software.amazon.awssdk.services.storagegateway.model.ListVolumesRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listVolumesPaginator
default ListVolumesIterable listVolumesPaginator(ListVolumesRequest listVolumesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException 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
2) Using For loopsoftware.amazon.awssdk.services.storagegateway.paginators.ListVolumesIterable responses = client.listVolumesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.storagegateway.paginators.ListVolumesIterable responses = client.listVolumesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVolumes(software.amazon.awssdk.services.storagegateway.model.ListVolumesRequest)operation.- Parameters:
listVolumesRequest- A JSON object that contains one or more of the following fields:- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listVolumesPaginator
default ListVolumesIterable listVolumesPaginator(Consumer<ListVolumesRequest.Builder> listVolumesRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException 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
2) Using For loopsoftware.amazon.awssdk.services.storagegateway.paginators.ListVolumesIterable responses = client.listVolumesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.storagegateway.paginators.ListVolumesIterable responses = client.listVolumesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVolumes(software.amazon.awssdk.services.storagegateway.model.ListVolumesRequest)operation.
This is a convenience which creates an instance of the
ListVolumesRequest.Builderavoiding the need to create one manually viaListVolumesRequest.builder()- Parameters:
listVolumesRequest- AConsumerthat will call methods onListVolumesRequest.Builderto create a request. A JSON object that contains one or more of the following fields:- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
notifyWhenUploaded
default NotifyWhenUploadedResponse notifyWhenUploaded(NotifyWhenUploadedRequest notifyWhenUploadedRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to Amazon S3.
Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.
For more information, see Getting file upload notification in the Amazon S3 File Gateway User Guide.
- Parameters:
notifyWhenUploadedRequest-- Returns:
- Result of the NotifyWhenUploaded operation returned by the service.
- See Also:
-
notifyWhenUploaded
default NotifyWhenUploadedResponse notifyWhenUploaded(Consumer<NotifyWhenUploadedRequest.Builder> notifyWhenUploadedRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to Amazon S3.
Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.
For more information, see Getting file upload notification in the Amazon S3 File Gateway User Guide.
This is a convenience which creates an instance of the
NotifyWhenUploadedRequest.Builderavoiding the need to create one manually viaNotifyWhenUploadedRequest.builder()- Parameters:
notifyWhenUploadedRequest- AConsumerthat will call methods onNotifyWhenUploadedRequest.Builderto create a request.- Returns:
- Result of the NotifyWhenUploaded operation returned by the service.
- See Also:
-
refreshCache
default RefreshCacheResponse refreshCache(RefreshCacheRequest refreshCacheRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Refreshes the cached inventory of objects for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed, or replaced since the gateway last listed the bucket's contents and cached the results. This operation does not import files into the S3 File Gateway cache storage. It only updates the cached inventory to reflect changes in the inventory of the objects in the S3 bucket. This operation is only supported in the S3 File Gateway types.
You can subscribe to be notified through an Amazon CloudWatch event when your
RefreshCacheoperation completes. For more information, see Getting notified about file operations in the Amazon S3 File Gateway User Guide. This operation is Only supported for S3 File Gateways.When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through a CloudWatch event when your
RefreshCacheoperation completes.Throttle limit: This API is asynchronous, so the gateway will accept no more than two refreshes at any time. We recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more information, see Getting notified about file operations in the Amazon S3 File Gateway User Guide.
-
Wait at least 60 seconds between consecutive RefreshCache API requests.
-
If you invoke the RefreshCache API when two requests are already being processed, any new request will cause an
InvalidGatewayRequestExceptionerror because too many requests were sent to the server.
The S3 bucket name does not need to be included when entering the list of folders in the FolderList parameter.
For more information, see Getting notified about file operations in the Amazon S3 File Gateway User Guide.
- Parameters:
refreshCacheRequest- RefreshCacheInput- Returns:
- Result of the RefreshCache operation returned by the service.
- See Also:
-
-
refreshCache
default RefreshCacheResponse refreshCache(Consumer<RefreshCacheRequest.Builder> refreshCacheRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Refreshes the cached inventory of objects for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed, or replaced since the gateway last listed the bucket's contents and cached the results. This operation does not import files into the S3 File Gateway cache storage. It only updates the cached inventory to reflect changes in the inventory of the objects in the S3 bucket. This operation is only supported in the S3 File Gateway types.
You can subscribe to be notified through an Amazon CloudWatch event when your
RefreshCacheoperation completes. For more information, see Getting notified about file operations in the Amazon S3 File Gateway User Guide. This operation is Only supported for S3 File Gateways.When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through a CloudWatch event when your
RefreshCacheoperation completes.Throttle limit: This API is asynchronous, so the gateway will accept no more than two refreshes at any time. We recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more information, see Getting notified about file operations in the Amazon S3 File Gateway User Guide.
-
Wait at least 60 seconds between consecutive RefreshCache API requests.
-
If you invoke the RefreshCache API when two requests are already being processed, any new request will cause an
InvalidGatewayRequestExceptionerror because too many requests were sent to the server.
The S3 bucket name does not need to be included when entering the list of folders in the FolderList parameter.
For more information, see Getting notified about file operations in the Amazon S3 File Gateway User Guide.
This is a convenience which creates an instance of the
RefreshCacheRequest.Builderavoiding the need to create one manually viaRefreshCacheRequest.builder()- Parameters:
refreshCacheRequest- AConsumerthat will call methods onRefreshCacheRequest.Builderto create a request. RefreshCacheInput- Returns:
- Result of the RefreshCache operation returned by the service.
- See Also:
-
-
removeTagsFromResource
default RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Removes one or more tags from the specified resource. This operation is supported in storage gateways of all types.
- Parameters:
removeTagsFromResourceRequest- RemoveTagsFromResourceInput- Returns:
- Result of the RemoveTagsFromResource operation returned by the service.
- See Also:
-
removeTagsFromResource
default RemoveTagsFromResourceResponse removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Removes one or more tags from the specified resource. This operation is supported in storage gateways of all types.
This is a convenience which creates an instance of the
RemoveTagsFromResourceRequest.Builderavoiding the need to create one manually viaRemoveTagsFromResourceRequest.builder()- Parameters:
removeTagsFromResourceRequest- AConsumerthat will call methods onRemoveTagsFromResourceRequest.Builderto create a request. RemoveTagsFromResourceInput- Returns:
- Result of the RemoveTagsFromResource operation returned by the service.
- See Also:
-
resetCache
default ResetCacheResponse resetCache(ResetCacheRequest resetCacheRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Resets all cache disks that have encountered an error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters an error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point, you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types.
If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.
- Parameters:
resetCacheRequest-- Returns:
- Result of the ResetCache operation returned by the service.
- See Also:
-
resetCache
default ResetCacheResponse resetCache(Consumer<ResetCacheRequest.Builder> resetCacheRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Resets all cache disks that have encountered an error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters an error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point, you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types.
If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.
This is a convenience which creates an instance of the
ResetCacheRequest.Builderavoiding the need to create one manually viaResetCacheRequest.builder()- Parameters:
resetCacheRequest- AConsumerthat will call methods onResetCacheRequest.Builderto create a request.- Returns:
- Result of the ResetCache operation returned by the service.
- See Also:
-
retrieveTapeArchive
default 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.
- Parameters:
retrieveTapeArchiveRequest- RetrieveTapeArchiveInput- Returns:
- Result of the RetrieveTapeArchive operation returned by the service.
- See Also:
-
retrieveTapeArchive
default 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.Builderavoiding the need to create one manually viaRetrieveTapeArchiveRequest.builder()- Parameters:
retrieveTapeArchiveRequest- AConsumerthat will call methods onRetrieveTapeArchiveRequest.Builderto create a request. RetrieveTapeArchiveInput- Returns:
- Result of the RetrieveTapeArchive operation returned by the service.
- See Also:
-
retrieveTapeRecoveryPoint
default 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.
- Parameters:
retrieveTapeRecoveryPointRequest- RetrieveTapeRecoveryPointInput- Returns:
- Result of the RetrieveTapeRecoveryPoint operation returned by the service.
- See Also:
-
retrieveTapeRecoveryPoint
default 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.Builderavoiding the need to create one manually viaRetrieveTapeRecoveryPointRequest.builder()- Parameters:
retrieveTapeRecoveryPointRequest- AConsumerthat will call methods onRetrieveTapeRecoveryPointRequest.Builderto create a request. RetrieveTapeRecoveryPointInput- Returns:
- Result of the RetrieveTapeRecoveryPoint operation returned by the service.
- See Also:
-
setLocalConsolePassword
default 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.
- Parameters:
setLocalConsolePasswordRequest- SetLocalConsolePasswordInput- Returns:
- Result of the SetLocalConsolePassword operation returned by the service.
- See Also:
-
setLocalConsolePassword
default 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.Builderavoiding the need to create one manually viaSetLocalConsolePasswordRequest.builder()- Parameters:
setLocalConsolePasswordRequest- AConsumerthat will call methods onSetLocalConsolePasswordRequest.Builderto create a request. SetLocalConsolePasswordInput- Returns:
- Result of the SetLocalConsolePassword operation returned by the service.
- See Also:
-
setSMBGuestPassword
default SetSmbGuestPasswordResponse setSMBGuestPassword(SetSmbGuestPasswordRequest setSmbGuestPasswordRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Sets the password for the guest user
smbguest. Thesmbguestuser is the user when the authentication method for the file share is set toGuestAccess. This operation only supported for S3 File Gateways- Parameters:
setSmbGuestPasswordRequest- SetSMBGuestPasswordInput- Returns:
- Result of the SetSMBGuestPassword operation returned by the service.
- See Also:
-
setSMBGuestPassword
default SetSmbGuestPasswordResponse setSMBGuestPassword(Consumer<SetSmbGuestPasswordRequest.Builder> setSmbGuestPasswordRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Sets the password for the guest user
smbguest. Thesmbguestuser is the user when the authentication method for the file share is set toGuestAccess. This operation only supported for S3 File Gateways
This is a convenience which creates an instance of the
SetSmbGuestPasswordRequest.Builderavoiding the need to create one manually viaSetSmbGuestPasswordRequest.builder()- Parameters:
setSmbGuestPasswordRequest- AConsumerthat will call methods onSetSmbGuestPasswordRequest.Builderto create a request. SetSMBGuestPasswordInput- Returns:
- Result of the SetSMBGuestPassword operation returned by the service.
- See Also:
-
shutdownGateway
default ShutdownGatewayResponse shutdownGateway(ShutdownGatewayRequest shutdownGatewayRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Shuts down a Tape Gateway or Volume Gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.
This API action cannot be used to shut down S3 File Gateway or FSx File Gateway.
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 OKsuccess response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway.If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.
- Parameters:
shutdownGatewayRequest- A JSON object containing the Amazon Resource Name (ARN) of the gateway to shut down.- Returns:
- Result of the ShutdownGateway operation returned by the service.
- See Also:
-
shutdownGateway
default ShutdownGatewayResponse shutdownGateway(Consumer<ShutdownGatewayRequest.Builder> shutdownGatewayRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Shuts down a Tape Gateway or Volume Gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.
This API action cannot be used to shut down S3 File Gateway or FSx File Gateway.
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 OKsuccess 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.Builderavoiding the need to create one manually viaShutdownGatewayRequest.builder()- Parameters:
shutdownGatewayRequest- AConsumerthat will call methods onShutdownGatewayRequest.Builderto create a request. A JSON object containing the Amazon Resource Name (ARN) of the gateway to shut down.- Returns:
- Result of the ShutdownGateway operation returned by the service.
- See Also:
-
startAvailabilityMonitorTest
default StartAvailabilityMonitorTestResponse startAvailabilityMonitorTest(StartAvailabilityMonitorTestRequest startAvailabilityMonitorTestRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment. This request only initiates the test and that a successful response only indicates that the test was started. It doesn't indicate that the test passed. For the status of the test, invoke the
DescribeAvailabilityMonitorTestAPI.Starting this test will cause your gateway to go offline for a brief period.
- Parameters:
startAvailabilityMonitorTestRequest-- Returns:
- Result of the StartAvailabilityMonitorTest operation returned by the service.
- See Also:
-
startAvailabilityMonitorTest
default StartAvailabilityMonitorTestResponse startAvailabilityMonitorTest(Consumer<StartAvailabilityMonitorTestRequest.Builder> startAvailabilityMonitorTestRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment. This request only initiates the test and that a successful response only indicates that the test was started. It doesn't indicate that the test passed. For the status of the test, invoke the
DescribeAvailabilityMonitorTestAPI.Starting this test will cause your gateway to go offline for a brief period.
This is a convenience which creates an instance of the
StartAvailabilityMonitorTestRequest.Builderavoiding the need to create one manually viaStartAvailabilityMonitorTestRequest.builder()- Parameters:
startAvailabilityMonitorTestRequest- AConsumerthat will call methods onStartAvailabilityMonitorTestRequest.Builderto create a request.- Returns:
- Result of the StartAvailabilityMonitorTest operation returned by the service.
- See Also:
-
startGateway
default 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.
- Parameters:
startGatewayRequest- A JSON object containing the Amazon Resource Name (ARN) of the gateway to start.- Returns:
- Result of the StartGateway operation returned by the service.
- See Also:
-
startGateway
default 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.Builderavoiding the need to create one manually viaStartGatewayRequest.builder()- Parameters:
startGatewayRequest- AConsumerthat will call methods onStartGatewayRequest.Builderto create a request. A JSON object containing the Amazon Resource Name (ARN) of the gateway to start.- Returns:
- Result of the StartGateway operation returned by the service.
- See Also:
-
updateAutomaticTapeCreationPolicy
default UpdateAutomaticTapeCreationPolicyResponse updateAutomaticTapeCreationPolicy(UpdateAutomaticTapeCreationPolicyRequest updateAutomaticTapeCreationPolicyRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Updates the automatic tape creation policy of a gateway. Use this to update the policy with a new set of automatic tape creation rules. This is only supported for tape gateways.
By default, there is no automatic tape creation policy.
A gateway can have only one automatic tape creation policy.
- Parameters:
updateAutomaticTapeCreationPolicyRequest-- Returns:
- Result of the UpdateAutomaticTapeCreationPolicy operation returned by the service.
- See Also:
-
updateAutomaticTapeCreationPolicy
default UpdateAutomaticTapeCreationPolicyResponse updateAutomaticTapeCreationPolicy(Consumer<UpdateAutomaticTapeCreationPolicyRequest.Builder> updateAutomaticTapeCreationPolicyRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Updates the automatic tape creation policy of a gateway. Use this to update the policy with a new set of automatic tape creation rules. This is only supported for tape gateways.
By default, there is no automatic tape creation policy.
A gateway can have only one automatic tape creation policy.
This is a convenience which creates an instance of the
UpdateAutomaticTapeCreationPolicyRequest.Builderavoiding the need to create one manually viaUpdateAutomaticTapeCreationPolicyRequest.builder()- Parameters:
updateAutomaticTapeCreationPolicyRequest- AConsumerthat will call methods onUpdateAutomaticTapeCreationPolicyRequest.Builderto create a request.- Returns:
- Result of the UpdateAutomaticTapeCreationPolicy operation returned by the service.
- See Also:
-
updateBandwidthRateLimit
default 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. This operation is supported only for the stored volume, cached volume, and tape gateway types. To update bandwidth rate limits for S3 file gateways, use UpdateBandwidthRateLimitSchedule.
By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.
To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
- Parameters:
updateBandwidthRateLimitRequest- A JSON object containing one or more of the following fields:- Returns:
- Result of the UpdateBandwidthRateLimit operation returned by the service.
- See Also:
-
updateBandwidthRateLimit
default 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. This operation is supported only for the stored volume, cached volume, and tape gateway types. To update bandwidth rate limits for S3 file gateways, use UpdateBandwidthRateLimitSchedule.
By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.
To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
This is a convenience which creates an instance of the
UpdateBandwidthRateLimitRequest.Builderavoiding the need to create one manually viaUpdateBandwidthRateLimitRequest.builder()- Parameters:
updateBandwidthRateLimitRequest- AConsumerthat will call methods onUpdateBandwidthRateLimitRequest.Builderto create a request. A JSON object containing one or more of the following fields:- Returns:
- Result of the UpdateBandwidthRateLimit operation returned by the service.
- See Also:
-
updateBandwidthRateLimitSchedule
default UpdateBandwidthRateLimitScheduleResponse updateBandwidthRateLimitSchedule(UpdateBandwidthRateLimitScheduleRequest updateBandwidthRateLimitScheduleRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This operation is supported for volume, tape, and S3 file gateways. S3 file gateways support bandwidth rate limits for upload only. FSx file gateways do not support bandwidth rate limits.
- Parameters:
updateBandwidthRateLimitScheduleRequest-- Returns:
- Result of the UpdateBandwidthRateLimitSchedule operation returned by the service.
- See Also:
-
updateBandwidthRateLimitSchedule
default UpdateBandwidthRateLimitScheduleResponse updateBandwidthRateLimitSchedule(Consumer<UpdateBandwidthRateLimitScheduleRequest.Builder> updateBandwidthRateLimitScheduleRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This operation is supported for volume, tape, and S3 file gateways. S3 file gateways support bandwidth rate limits for upload only. FSx file gateways do not support bandwidth rate limits.
This is a convenience which creates an instance of the
UpdateBandwidthRateLimitScheduleRequest.Builderavoiding the need to create one manually viaUpdateBandwidthRateLimitScheduleRequest.builder()- Parameters:
updateBandwidthRateLimitScheduleRequest- AConsumerthat will call methods onUpdateBandwidthRateLimitScheduleRequest.Builderto create a request.- Returns:
- Result of the UpdateBandwidthRateLimitSchedule operation returned by the service.
- See Also:
-
updateChapCredentials
default 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. This operation is supported in the volume and tape gateway types.
When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.
- Parameters:
updateChapCredentialsRequest- A JSON object containing one or more of the following fields:- Returns:
- Result of the UpdateChapCredentials operation returned by the service.
- See Also:
-
updateChapCredentials
default 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. This operation is supported in the volume and tape gateway types.
When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.
This is a convenience which creates an instance of the
UpdateChapCredentialsRequest.Builderavoiding the need to create one manually viaUpdateChapCredentialsRequest.builder()- Parameters:
updateChapCredentialsRequest- AConsumerthat will call methods onUpdateChapCredentialsRequest.Builderto create a request. A JSON object containing one or more of the following fields:- Returns:
- Result of the UpdateChapCredentials operation returned by the service.
- See Also:
-
updateFileSystemAssociation
default UpdateFileSystemAssociationResponse updateFileSystemAssociation(UpdateFileSystemAssociationRequest updateFileSystemAssociationRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Updates a file system association. This operation is only supported in the FSx File Gateways.
- Parameters:
updateFileSystemAssociationRequest-- Returns:
- Result of the UpdateFileSystemAssociation operation returned by the service.
- See Also:
-
updateFileSystemAssociation
default UpdateFileSystemAssociationResponse updateFileSystemAssociation(Consumer<UpdateFileSystemAssociationRequest.Builder> updateFileSystemAssociationRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Updates a file system association. This operation is only supported in the FSx File Gateways.
This is a convenience which creates an instance of the
UpdateFileSystemAssociationRequest.Builderavoiding the need to create one manually viaUpdateFileSystemAssociationRequest.builder()- Parameters:
updateFileSystemAssociationRequest- AConsumerthat will call methods onUpdateFileSystemAssociationRequest.Builderto create a request.- Returns:
- Result of the UpdateFileSystemAssociation operation returned by the service.
- See Also:
-
updateGatewayInformation
default UpdateGatewayInformationResponse updateGatewayInformation(UpdateGatewayInformationRequest updateGatewayInformationRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Updates a gateway's metadata, which includes the gateway's name, time zone, and metadata cache size. 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.
- Parameters:
updateGatewayInformationRequest-- Returns:
- Result of the UpdateGatewayInformation operation returned by the service.
- See Also:
-
updateGatewayInformation
default UpdateGatewayInformationResponse updateGatewayInformation(Consumer<UpdateGatewayInformationRequest.Builder> updateGatewayInformationRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Updates a gateway's metadata, which includes the gateway's name, time zone, and metadata cache size. 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.Builderavoiding the need to create one manually viaUpdateGatewayInformationRequest.builder()- Parameters:
updateGatewayInformationRequest- AConsumerthat will call methods onUpdateGatewayInformationRequest.Builderto create a request.- Returns:
- Result of the UpdateGatewayInformation operation returned by the service.
- See Also:
-
updateGatewaySoftwareNow
default 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 OKsuccess response immediately. However, it might take some time for the update to complete. You can call DescribeGatewayInformation to verify the gateway is in theSTATE_RUNNINGstate.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.
- Parameters:
updateGatewaySoftwareNowRequest- A JSON object containing the Amazon Resource Name (ARN) of the gateway to update.- Returns:
- Result of the UpdateGatewaySoftwareNow operation returned by the service.
- See Also:
-
updateGatewaySoftwareNow
default 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 OKsuccess response immediately. However, it might take some time for the update to complete. You can call DescribeGatewayInformation to verify the gateway is in theSTATE_RUNNINGstate.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.Builderavoiding the need to create one manually viaUpdateGatewaySoftwareNowRequest.builder()- Parameters:
updateGatewaySoftwareNowRequest- AConsumerthat will call methods onUpdateGatewaySoftwareNowRequest.Builderto create a request. A JSON object containing the Amazon Resource Name (ARN) of the gateway to update.- Returns:
- Result of the UpdateGatewaySoftwareNow operation returned by the service.
- See Also:
-
updateMaintenanceStartTime
default UpdateMaintenanceStartTimeResponse updateMaintenanceStartTime(UpdateMaintenanceStartTimeRequest updateMaintenanceStartTimeRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Updates a gateway's maintenance window schedule, with settings for monthly or weekly cadence, specific day and time to begin maintenance, and which types of updates to apply. Time configuration uses the gateway's time zone. You can pass values for a complete maintenance schedule, or update policy, or both. Previous values will persist for whichever setting you choose not to modify. If an incomplete or invalid maintenance schedule is passed, the entire request will be rejected with an error and no changes will occur.
A complete maintenance schedule must include values for both
MinuteOfHourandHourOfDay, and eitherDayOfMonthorDayOfWeek.We recommend keeping maintenance updates turned on, except in specific use cases where the brief disruptions caused by updating the gateway could critically impact your deployment.
- Parameters:
updateMaintenanceStartTimeRequest- A JSON object containing the following fields:-
UpdateMaintenanceStartTimeInputinvalid input: '$'SoftwareUpdatePreferences
-
UpdateMaintenanceStartTimeInputinvalid input: '$'DayOfMonth
-
UpdateMaintenanceStartTimeInputinvalid input: '$'DayOfWeek
-
UpdateMaintenanceStartTimeInputinvalid input: '$'HourOfDay
-
UpdateMaintenanceStartTimeInputinvalid input: '$'MinuteOfHour
-
- Returns:
- Result of the UpdateMaintenanceStartTime operation returned by the service.
- See Also:
-
updateMaintenanceStartTime
default UpdateMaintenanceStartTimeResponse updateMaintenanceStartTime(Consumer<UpdateMaintenanceStartTimeRequest.Builder> updateMaintenanceStartTimeRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Updates a gateway's maintenance window schedule, with settings for monthly or weekly cadence, specific day and time to begin maintenance, and which types of updates to apply. Time configuration uses the gateway's time zone. You can pass values for a complete maintenance schedule, or update policy, or both. Previous values will persist for whichever setting you choose not to modify. If an incomplete or invalid maintenance schedule is passed, the entire request will be rejected with an error and no changes will occur.
A complete maintenance schedule must include values for both
MinuteOfHourandHourOfDay, and eitherDayOfMonthorDayOfWeek.We recommend keeping maintenance updates turned on, except in specific use cases where the brief disruptions caused by updating the gateway could critically impact your deployment.
This is a convenience which creates an instance of the
UpdateMaintenanceStartTimeRequest.Builderavoiding the need to create one manually viaUpdateMaintenanceStartTimeRequest.builder()- Parameters:
updateMaintenanceStartTimeRequest- AConsumerthat will call methods onUpdateMaintenanceStartTimeRequest.Builderto create a request. A JSON object containing the following fields:-
UpdateMaintenanceStartTimeInputinvalid input: '$'SoftwareUpdatePreferences
-
UpdateMaintenanceStartTimeInputinvalid input: '$'DayOfMonth
-
UpdateMaintenanceStartTimeInputinvalid input: '$'DayOfWeek
-
UpdateMaintenanceStartTimeInputinvalid input: '$'HourOfDay
-
UpdateMaintenanceStartTimeInputinvalid input: '$'MinuteOfHour
-
- Returns:
- Result of the UpdateMaintenanceStartTime operation returned by the service.
- See Also:
-
updateSMBLocalGroups
default UpdateSmbLocalGroupsResponse updateSMBLocalGroups(UpdateSmbLocalGroupsRequest updateSmbLocalGroupsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Updates the list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.
- Parameters:
updateSmbLocalGroupsRequest-- Returns:
- Result of the UpdateSMBLocalGroups operation returned by the service.
- See Also:
-
updateSMBLocalGroups
default UpdateSmbLocalGroupsResponse updateSMBLocalGroups(Consumer<UpdateSmbLocalGroupsRequest.Builder> updateSmbLocalGroupsRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Updates the list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.
This is a convenience which creates an instance of the
UpdateSmbLocalGroupsRequest.Builderavoiding the need to create one manually viaUpdateSmbLocalGroupsRequest.builder()- Parameters:
updateSmbLocalGroupsRequest- AConsumerthat will call methods onUpdateSmbLocalGroupsRequest.Builderto create a request.- Returns:
- Result of the UpdateSMBLocalGroups operation returned by the service.
- See Also:
-
updateSMBSecurityStrategy
default UpdateSmbSecurityStrategyResponse updateSMBSecurityStrategy(UpdateSmbSecurityStrategyRequest updateSmbSecurityStrategyRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Updates the SMB security strategy level for an Amazon S3 file gateway. This action is only supported for Amazon S3 file gateways.
For information about configuring this setting using the Amazon Web Services console, see Setting a security level for your gateway in the Amazon S3 File Gateway User Guide.
A higher security strategy level can affect performance of the gateway.
- Parameters:
updateSmbSecurityStrategyRequest-- Returns:
- Result of the UpdateSMBSecurityStrategy operation returned by the service.
- See Also:
-
updateSMBSecurityStrategy
default UpdateSmbSecurityStrategyResponse updateSMBSecurityStrategy(Consumer<UpdateSmbSecurityStrategyRequest.Builder> updateSmbSecurityStrategyRequest) throws InvalidGatewayRequestException, InternalServerErrorException, AwsServiceException, SdkClientException, StorageGatewayException Updates the SMB security strategy level for an Amazon S3 file gateway. This action is only supported for Amazon S3 file gateways.
For information about configuring this setting using the Amazon Web Services console, see Setting a security level for your gateway in the Amazon S3 File Gateway User Guide.
A higher security strategy level can affect performance of the gateway.
This is a convenience which creates an instance of the
UpdateSmbSecurityStrategyRequest.Builderavoiding the need to create one manually viaUpdateSmbSecurityStrategyRequest.builder()- Parameters:
updateSmbSecurityStrategyRequest- AConsumerthat will call methods onUpdateSmbSecurityStrategyRequest.Builderto create a request.- Returns:
- Result of the UpdateSMBSecurityStrategy operation returned by the service.
- See Also:
-
updateSnapshotSchedule
default 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.
- Parameters:
updateSnapshotScheduleRequest- A JSON object containing one or more of the following fields:- Returns:
- Result of the UpdateSnapshotSchedule operation returned by the service.
- See Also:
-
updateSnapshotSchedule
default 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.Builderavoiding the need to create one manually viaUpdateSnapshotScheduleRequest.builder()- Parameters:
updateSnapshotScheduleRequest- AConsumerthat will call methods onUpdateSnapshotScheduleRequest.Builderto create a request. A JSON object containing one or more of the following fields:- Returns:
- Result of the UpdateSnapshotSchedule operation returned by the service.
- See Also:
-
updateVTLDeviceType
default 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.
- Parameters:
updateVtlDeviceTypeRequest-- Returns:
- Result of the UpdateVTLDeviceType operation returned by the service.
- See Also:
-
updateVTLDeviceType
default 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.Builderavoiding the need to create one manually viaUpdateVtlDeviceTypeRequest.builder()- Parameters:
updateVtlDeviceTypeRequest- AConsumerthat will call methods onUpdateVtlDeviceTypeRequest.Builderto create a request.- Returns:
- Result of the UpdateVTLDeviceType operation returned by the service.
- See Also:
-
create
Create aStorageGatewayClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aStorageGatewayClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-