aws_storage_gateway

AWS Storage Gateway Service

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

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

• AWS Storage Gateway required request headers: Describes the required headers that you must send with every POST request to AWS Storage Gateway.

• Signing requests: AWS Storage Gateway requires that you authenticate every request you send; this topic describes how sign such a request.

• Error responses: Provides reference information about AWS Storage Gateway errors.

• Operations in AWS Storage Gateway: Contains detailed descriptions of all AWS Storage Gateway operations, their request parameters, response elements, possible errors, and examples of requests and responses.

• AWS Storage Gateway endpoints and quotas: Provides a list of each AWS Region and the endpoints available for use with AWS Storage Gateway.

Summary

Functions

• activate_gateway(Client, Input)
  Activates the gateway you previously deployed on your host.
• activate_gateway(Client, Input, Options)
• add_cache(Client, Input)
  Configures one or more gateway local disks as cache for a gateway.
• add_cache(Client, Input, Options)
• add_tags_to_resource(Client, Input)
  Adds one or more tags to the specified resource.
• add_tags_to_resource(Client, Input, Options)
• add_upload_buffer(Client, Input)
  Configures one or more gateway local disks as upload buffer for a specified gateway.
• add_upload_buffer(Client, Input, Options)
• add_working_storage(Client, Input)
  Configures one or more gateway local disks as working storage for a gateway.
• add_working_storage(Client, Input, Options)
• assign_tape_pool(Client, Input)
  Assigns a tape to a tape pool for archiving.
• assign_tape_pool(Client, Input, Options)
• attach_volume(Client, Input)
  Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway.
• attach_volume(Client, Input, Options)
• cancel_archival(Client, Input)
  Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.
• cancel_archival(Client, Input, Options)
• cancel_retrieval(Client, Input)
  Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated.
• cancel_retrieval(Client, Input, Options)
• create_cached_iscsi_volume(Client, Input)
  Creates a cached volume on a specified cached volume gateway.
• create_cached_iscsi_volume(Client, Input, Options)
• create_nfs_file_share(Client, Input)
  Creates a Network File System (NFS) file share on an existing file gateway.
• create_nfs_file_share(Client, Input, Options)
• create_s_m_b_file_share(Client, Input)
  Creates a Server Message Block (SMB) file share on an existing file gateway.
• create_s_m_b_file_share(Client, Input, Options)
• create_snapshot(Client, Input)
  Initiates a snapshot of a volume.
• create_snapshot(Client, Input, Options)
• create_snapshot_from_volume_recovery_point(Client, Input)
  Initiates a snapshot of a gateway from a volume recovery point.
• create_snapshot_from_volume_recovery_point(Client, Input, Options)
• create_stored_iscsi_volume(Client, Input)
  Creates a volume on a specified gateway.
• create_stored_iscsi_volume(Client, Input, Options)
• create_tape_with_barcode(Client, Input)
  Creates a virtual tape by using your own barcode.
• create_tape_with_barcode(Client, Input, Options)
• create_tapes(Client, Input)
  Creates one or more virtual tapes.
• create_tapes(Client, Input, Options)
• delete_automatic_tape_creation_policy(Client, Input)
  Deletes the automatic tape creation policy of a gateway.
• delete_automatic_tape_creation_policy(Client, Input, Options)
• delete_bandwidth_rate_limit(Client, Input)
  Deletes the bandwidth rate limits of a gateway.
• delete_bandwidth_rate_limit(Client, Input, Options)
• delete_chap_credentials(Client, Input)
  Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.
• delete_chap_credentials(Client, Input, Options)
• delete_file_share(Client, Input)
  Deletes a file share from a file gateway.
• delete_file_share(Client, Input, Options)
• delete_gateway(Client, Input)
  Deletes a gateway.
• delete_gateway(Client, Input, Options)
• delete_snapshot_schedule(Client, Input)
  Deletes a snapshot of a volume.
• delete_snapshot_schedule(Client, Input, Options)
• delete_tape(Client, Input)
  Deletes the specified virtual tape.
• delete_tape(Client, Input, Options)
• delete_tape_archive(Client, Input)
  Deletes the specified virtual tape from the virtual tape shelf (VTS).
• delete_tape_archive(Client, Input, Options)
• delete_volume(Client, Input)
  Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API.
• delete_volume(Client, Input, Options)
• describe_availability_monitor_test(Client, Input)
  Returns information about the most recent High Availability monitoring test that was performed on the host in a cluster.
• describe_availability_monitor_test(Client, Input, Options)
• describe_bandwidth_rate_limit(Client, Input)
  Returns the bandwidth rate limits of a gateway.
• describe_bandwidth_rate_limit(Client, Input, Options)
• describe_cache(Client, Input)
  Returns information about the cache of a gateway.
• describe_cache(Client, Input, Options)
• describe_cached_iscsi_volumes(Client, Input)
  Returns a description of the gateway volumes specified in the request.
• describe_cached_iscsi_volumes(Client, Input, Options)
• describe_chap_credentials(Client, Input)
  Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.
• describe_chap_credentials(Client, Input, Options)
• describe_gateway_information(Client, Input)
  Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not).
• describe_gateway_information(Client, Input, Options)
• describe_maintenance_start_time(Client, Input)
  Returns your gateway's weekly maintenance start time including the day and time of the week.
• describe_maintenance_start_time(Client, Input, Options)
• describe_nfs_file_shares(Client, Input)
  Gets a description for one or more Network File System (NFS) file shares from a file gateway.
• describe_nfs_file_shares(Client, Input, Options)
• describe_s_m_b_file_shares(Client, Input)
  Gets a description for one or more Server Message Block (SMB) file shares from a file gateway.
• describe_s_m_b_file_shares(Client, Input, Options)
• describe_s_m_b_settings(Client, Input)
  Gets a description of a Server Message Block (SMB) file share settings from a file gateway.
• describe_s_m_b_settings(Client, Input, Options)
• describe_snapshot_schedule(Client, Input)
  Describes the snapshot schedule for the specified gateway volume.
• describe_snapshot_schedule(Client, Input, Options)
• describe_stored_iscsi_volumes(Client, Input)
  Returns the description of the gateway volumes specified in the request.
• describe_stored_iscsi_volumes(Client, Input, Options)
• describe_tape_archives(Client, Input)
  Returns a description of specified virtual tapes in the virtual tape shelf (VTS).
• describe_tape_archives(Client, Input, Options)
• describe_tape_recovery_points(Client, Input)
  Returns a list of virtual tape recovery points that are available for the specified tape gateway.
• describe_tape_recovery_points(Client, Input, Options)
• describe_tapes(Client, Input)
  Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes.
• describe_tapes(Client, Input, Options)
• describe_upload_buffer(Client, Input)
  Returns information about the upload buffer of a gateway.
• describe_upload_buffer(Client, Input, Options)
• describe_vtl_devices(Client, Input)
  Returns a description of virtual tape library (VTL) devices for the specified tape gateway.
• describe_vtl_devices(Client, Input, Options)
• describe_working_storage(Client, Input)
  Returns information about the working storage of a gateway.
• describe_working_storage(Client, Input, Options)
• detach_volume(Client, Input)
  Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway.
• detach_volume(Client, Input, Options)
• disable_gateway(Client, Input)
  Disables a tape gateway when the gateway is no longer functioning.
• disable_gateway(Client, Input, Options)
• join_domain(Client, Input)
  Adds a file gateway to an Active Directory domain.
• join_domain(Client, Input, Options)
• list_automatic_tape_creation_policies(Client, Input)
  Lists the automatic tape creation policies for a gateway.
• list_automatic_tape_creation_policies(Client, Input, Options)
• list_file_shares(Client, Input)
  Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling user account.
• list_file_shares(Client, Input, Options)
• list_gateways(Client, Input)
  Lists gateways owned by an AWS account in an AWS Region specified in the request.
• list_gateways(Client, Input, Options)
• list_local_disks(Client, Input)
  Returns a list of the gateway's local disks.
• list_local_disks(Client, Input, Options)
• list_tags_for_resource(Client, Input)
  Lists the tags that have been added to the specified resource.
• list_tags_for_resource(Client, Input, Options)
• list_tapes(Client, Input)
  Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS).
• list_tapes(Client, Input, Options)
• list_volume_initiators(Client, Input)
  Lists iSCSI initiators that are connected to a volume.
• list_volume_initiators(Client, Input, Options)
• list_volume_recovery_points(Client, Input)
  Lists the recovery points for a specified gateway.
• list_volume_recovery_points(Client, Input, Options)
• list_volumes(Client, Input)
  Lists the iSCSI stored volumes of a gateway.
• list_volumes(Client, Input, Options)
• notify_when_uploaded(Client, Input)
  Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to Amazon S3.
• notify_when_uploaded(Client, Input, Options)
• refresh_cache(Client, Input)
  Refreshes the cache for the specified file share.
• refresh_cache(Client, Input, Options)
• remove_tags_from_resource(Client, Input)
  Removes one or more tags from the specified resource.
• remove_tags_from_resource(Client, Input, Options)
• reset_cache(Client, Input)
  Resets all cache disks that have encountered an error and makes the disks available for reconfiguration as cache storage.
• reset_cache(Client, Input, Options)
• retrieve_tape_archive(Client, Input)
  Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway.
• retrieve_tape_archive(Client, Input, Options)
• retrieve_tape_recovery_point(Client, Input)
  Retrieves the recovery point for the specified virtual tape.
• retrieve_tape_recovery_point(Client, Input, Options)
• set_local_console_password(Client, Input)
  Sets the password for your VM local console.
• set_local_console_password(Client, Input, Options)
• set_s_m_b_guest_password(Client, Input)
  Sets the password for the guest user smbguest.
• set_s_m_b_guest_password(Client, Input, Options)
• shutdown_gateway(Client, Input)
  Shuts down a gateway.
• shutdown_gateway(Client, Input, Options)
• start_availability_monitor_test(Client, Input)
  Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment.
• start_availability_monitor_test(Client, Input, Options)
• start_gateway(Client, Input)
  Starts a gateway that you previously shut down (see ShutdownGateway).
• start_gateway(Client, Input, Options)
• update_automatic_tape_creation_policy(Client, Input)
  Updates the automatic tape creation policy of a gateway.
• update_automatic_tape_creation_policy(Client, Input, Options)
• update_bandwidth_rate_limit(Client, Input)
  Updates the bandwidth rate limits of a gateway.
• update_bandwidth_rate_limit(Client, Input, Options)
• update_chap_credentials(Client, Input)
  Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target.
• update_chap_credentials(Client, Input, Options)
• update_gateway_information(Client, Input)
  Updates a gateway's metadata, which includes the gateway's name and time zone.
• update_gateway_information(Client, Input, Options)
• update_gateway_software_now(Client, Input)
  Updates the gateway virtual machine (VM) software.
• update_gateway_software_now(Client, Input, Options)
• update_maintenance_start_time(Client, Input)
  Updates a gateway's weekly maintenance start time information, including day and time of the week.
• update_maintenance_start_time(Client, Input, Options)
• update_nfs_file_share(Client, Input)
  Updates a Network File System (NFS) file share.
• update_nfs_file_share(Client, Input, Options)
• update_s_m_b_file_share(Client, Input)
  Updates a Server Message Block (SMB) file share.
• update_s_m_b_file_share(Client, Input, Options)
• update_s_m_b_security_strategy(Client, Input)
  Updates the SMB security strategy on a file gateway.
• update_s_m_b_security_strategy(Client, Input, Options)
• update_snapshot_schedule(Client, Input)
  Updates a snapshot schedule configured for a gateway volume.
• update_snapshot_schedule(Client, Input, Options)
• update_vtl_device_type(Client, Input)
  Updates the type of medium changer in a tape gateway.
• update_vtl_device_type(Client, Input, Options)

Functions

Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the AWS 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.

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 AWS Storage Gateway works (architecture).

Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following AWS Storage Gateway resources:

• Storage gateways of all types

• Storage volumes

• Virtual tapes

• NFS and SMB file shares

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.

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.

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.

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.

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.

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.

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.

Creates a Network File System (NFS) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using an NFS interface. This operation is only supported for file gateways.

Creates a Server Message Block (SMB) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway expose file shares using an SMB interface. This operation is only supported for file gateways.

Initiates a snapshot of a volume.

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

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

Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type.

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

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

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.

Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and can not be reused if it has already been used on a tape. This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type.

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.

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.

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 for the stored volume, cached volume and tape gateway types.

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.

Deletes a file share from a file gateway. This operation is only supported for file gateways.

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.

Deletes a snapshot of a volume.

You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Backing up your volumes. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported in stored and cached volume gateway types.

Deletes the specified virtual tape. This operation is only supported in the tape gateway type.

Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

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.

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.

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 for the stored volume, cached volume and tape gateway types.

Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape, and file gateway types.

Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types.

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.

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

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

Gets a description for one or more Network File System (NFS) file shares from a file gateway. This operation is only supported for file gateways.

Gets a description for one or more Server Message Block (SMB) file shares from a file gateway. This operation is only supported for file gateways.

Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.

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.

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, AWS Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.

Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

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

Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes associated with the specified gateway. This operation is only supported in the tape gateway type.

Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume, and tape gateway types.

Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, AWS Storage Gateway returns VTL device information.

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.

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.

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.

Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.

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.

Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling user account. This operation is only supported for file gateways.

Lists gateways owned by an AWS account in an AWS 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.

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.

Lists the tags that have been added to the specified resource. This operation is supported in storage gateways of all types.

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.

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.

Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type.

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.

Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to Amazon S3.

AWS Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or AWS Lambda function. This operation is only supported for file gateways.

Refreshes the cache for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed, or replaced since the gateway last listed the bucket's contents and cached the results. This operation is only supported in the file gateway type. You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see Getting notified about file operations in the AWS Storage Gateway User Guide.

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 an CloudWatch event when your RefreshCache operation completes.

Throttle limit: This API is asynchronous so the gateway will accept no more than two refreshes at any time. We recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more information, see Getting notified about file operations in the AWS Storage Gateway User Guide.

If you invoke the RefreshCache API when two requests are already being processed, any new request will cause an InvalidGatewayRequestException error because too many requests were sent to the server.

Removes one or more tags from the specified resource. This operation is supported in storage gateways of all types.

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.

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.

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.

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.

Sets the password for the guest user smbguest. The smbguest user is the user when the authentication method for the file share is set to GuestAccess.

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

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

If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions. After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.

Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment. This request only initiates the test and that a successful response only indicates that the test was started. It doesn't indicate that the test passed. For the status of the test, invoke the DescribeAvailabilityMonitorTest API.

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.

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.

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 for the stored volume, cached volume, and tape gateway types.

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.

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.

Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.

Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone.

Updates a Network File System (NFS) file share. This operation is only supported in the file gateway type.

To leave a file share field unchanged, set the corresponding input field to null. Updates the following file share setting:

• Default storage class for your S3 bucket

• Metadata defaults for your S3 bucket

• Allowed NFS clients for your file share

• Squash settings

• Write status of your file share

Updates a Server Message Block (SMB) file share.

Updates the SMB security strategy on a file gateway. This action is only supported in file gateways.

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.

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.