aws storagegateway
Amazon FSx File Gateway is no longer available to new customers. AWS CLI reference
96 commands Its page in the AWS CLI reference
Commands
activate-gatewayActivates the gateway you previously deployed on your host.add-cacheConfigures one or more gateway local disks as cache for a gateway.add-tags-to-resourceAdds one or more tags to the specified resource.add-upload-bufferConfigures one or more gateway local disks as upload buffer for a specified gateway.add-working-storageConfigures one or more gateway local disks as working storage for a gateway.assign-tape-poolAssigns a tape to a tape pool for archiving.associate-file-systemAssociate an Amazon FSx file system with the FSx File Gateway.attach-volumeConnects a volume to an iSCSI connection and then attaches the volume to the specified gateway.cancel-archivalCancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.cancel-cache-reportCancels generation of a specified cache report.cancel-retrievalCancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated.create-cached-iscsi-volumeCreates a cached volume on a specified cached volume gateway.create-nfs-file-shareCreates a Network File System (NFS) file share on an existing S3 File Gateway.create-smb-file-shareCreates a Server Message Block (SMB) file share on an existing S3 File Gateway.create-snapshotInitiates a snapshot of a volume.create-snapshot-from-volume-recovery-pointInitiates a snapshot of a gateway from a volume recovery point.create-stored-iscsi-volumeCreates a volume on a specified gateway.create-tape-poolCreates a new custom tape pool.create-tape-with-barcodeCreates a virtual tape by using your own barcode.create-tapesCreates one or more virtual tapes.delete-automatic-tape-creation-policyDeletes the automatic tape creation policy of a gateway.delete-bandwidth-rate-limitDeletes the bandwidth rate limits of a gateway.delete-cache-reportDeletes the specified cache report and any associated tags from the Storage Gateway database.delete-chap-credentialsDeletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.delete-file-shareDeletes a file share from an S3 File Gateway.delete-gatewayDeletes a gateway.delete-snapshot-scheduleDeletes a snapshot of a volume.delete-tapeDeletes the specified virtual tape.delete-tape-archiveDeletes the specified virtual tape from the virtual tape shelf (VTS).delete-tape-poolDelete a custom tape pool.delete-volumeDeletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API.describe-availability-monitor-testReturns information about the most recent high availability monitoring test that was performed on the host in a cluster.describe-bandwidth-rate-limitReturns the bandwidth rate limits of a gateway.describe-bandwidth-rate-limit-scheduleReturns information about the bandwidth rate limit schedule of a gateway.describe-cacheReturns information about the cache of a gateway.describe-cache-reportReturns information about the specified cache report, including completion status and generation progress.describe-cached-iscsi-volumesReturns a description of the gateway volumes specified in the request.describe-chap-credentialsReturns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.describe-file-system-associationsGets the file system association information.describe-gateway-informationReturns metadata about a gateway such as its name, network interfaces, time zone, status, and software version.describe-maintenance-start-timeReturns 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.describe-nfs-file-sharesGets a description for one or more Network File System (NFS) file shares from an S3 File Gateway.describe-smb-file-sharesGets a description for one or more Server Message Block (SMB) file shares from a S3 File Gateway.describe-smb-settingsGets a description of a Server Message Block (SMB) file share settings from a file gateway.describe-snapshot-scheduleDescribes the snapshot schedule for the specified gateway volume.describe-stored-iscsi-volumesReturns the description of the gateway volumes specified in the request.describe-tape-archivesReturns a description of specified virtual tapes in the virtual tape shelf (VTS).describe-tape-recovery-pointsReturns a list of virtual tape recovery points that are available for the specified tape gateway.describe-tapesReturns a description of virtual tapes that correspond to the specified Amazon Resource Names (ARNs).describe-upload-bufferReturns information about the upload buffer of a gateway.describe-vtl-devicesReturns a description of virtual tape library (VTL) devices for the specified tape gateway.describe-working-storageReturns information about the working storage of a gateway.detach-volumeDisconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway.disable-gatewayDisables a tape gateway when the gateway is no longer functioning.disassociate-file-systemDisassociates an Amazon FSx file system from the specified gateway.evict-files-failing-uploadStarts a process that cleans the specified file share's cache of file entries that are failing upload to Amazon S3.join-domainAdds a file gateway to an Active Directory domain.list-automatic-tape-creation-policiesLists the automatic tape creation policies for a gateway.list-cache-reportsReturns a list of existing cache reports for all file shares associated with your Amazon Web Services account.list-file-sharesGets 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.list-file-system-associationsGets a list of FileSystemAssociationSummary objects.list-gatewaysLists gateways owned by an Amazon Web Services account in an Amazon Web Services Region specified in the request.list-local-disksReturns a list of the gateway's local disks.list-tags-for-resourceLists the tags that have been added to the specified resource.list-tape-poolsLists custom tape pools.list-tapesLists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS).list-volume-initiatorsLists iSCSI initiators that are connected to a volume.list-volume-recovery-pointsLists the recovery points for a specified gateway.list-volumesLists the iSCSI stored volumes of a gateway.notify-when-uploadedSends you notification through Amazon EventBridge when all files written to your file share have been uploaded to Amazon S3.refresh-cacheRefreshes the cached inventory of objects for the specified file share.remove-tags-from-resourceRemoves one or more tags from the specified resource.reset-cacheResets all cache disks that have encountered an error and makes the disks available for reconfiguration as cache storage.retrieve-tape-archiveRetrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway.retrieve-tape-recovery-pointRetrieves the recovery point for the specified virtual tape.set-local-console-passwordSets the password for your VM local console.set-smb-guest-passwordSets the password for the guest user smbguest.shutdown-gatewayShuts down a Tape Gateway or Volume Gateway.start-availability-monitor-testStart a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment.start-cache-reportStarts generating a report of the file metadata currently cached by an S3 File Gateway for a specific file share.start-gatewayStarts a gateway that you previously shut down (see ShutdownGateway).update-automatic-tape-creation-policyUpdates the automatic tape creation policy of a gateway.update-bandwidth-rate-limitUpdates the bandwidth rate limits of a gateway.update-bandwidth-rate-limit-scheduleUpdates the bandwidth rate limit schedule for a specified gateway.update-chap-credentialsUpdates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target.update-file-system-associationUpdates a file system association.update-gateway-informationUpdates a gateway's metadata, which includes the gateway's name, time zone, and metadata cache size.update-gateway-software-nowUpdates the gateway virtual machine (VM) software.update-maintenance-start-timeUpdates 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.update-nfs-file-shareUpdates a Network File System (NFS) file share.update-smb-file-shareUpdates a Server Message Block (SMB) file share.update-smb-file-share-visibilityControls whether the shares on an S3 File Gateway are visible in a net view or browse list.update-smb-local-groupsUpdates the list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.update-smb-security-strategyUpdates the SMB security strategy level for an Amazon S3 file gateway.update-snapshot-scheduleUpdates a snapshot schedule configured for a gateway volume.update-vtl-device-typeUpdates the type of medium changer in a tape gateway.