Class: Aws::StorageGateway::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::StorageGateway::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb
Overview
An API client for StorageGateway. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::StorageGateway::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#activate_gateway(params = {}) ⇒ Types::ActivateGatewayOutput
Activates the gateway you previously deployed on your host.
-
#add_cache(params = {}) ⇒ Types::AddCacheOutput
Configures one or more gateway local disks as cache for a gateway.
-
#add_tags_to_resource(params = {}) ⇒ Types::AddTagsToResourceOutput
Adds one or more tags to the specified resource.
-
#add_upload_buffer(params = {}) ⇒ Types::AddUploadBufferOutput
Configures one or more gateway local disks as upload buffer for a specified gateway.
-
#add_working_storage(params = {}) ⇒ Types::AddWorkingStorageOutput
Configures one or more gateway local disks as working storage for a gateway.
-
#assign_tape_pool(params = {}) ⇒ Types::AssignTapePoolOutput
Assigns a tape to a tape pool for archiving.
-
#associate_file_system(params = {}) ⇒ Types::AssociateFileSystemOutput
Associate an Amazon FSx file system with the FSx File Gateway.
-
#attach_volume(params = {}) ⇒ Types::AttachVolumeOutput
Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway.
-
#cancel_archival(params = {}) ⇒ Types::CancelArchivalOutput
Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.
-
#cancel_retrieval(params = {}) ⇒ Types::CancelRetrievalOutput
Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated.
-
#create_cached_iscsi_volume(params = {}) ⇒ Types::CreateCachediSCSIVolumeOutput
Creates a cached volume on a specified cached volume gateway.
-
#create_nfs_file_share(params = {}) ⇒ Types::CreateNFSFileShareOutput
Creates a Network File System (NFS) file share on an existing S3 File Gateway.
-
#create_smb_file_share(params = {}) ⇒ Types::CreateSMBFileShareOutput
Creates a Server Message Block (SMB) file share on an existing S3 File Gateway.
-
#create_snapshot(params = {}) ⇒ Types::CreateSnapshotOutput
Initiates a snapshot of a volume.
-
#create_snapshot_from_volume_recovery_point(params = {}) ⇒ Types::CreateSnapshotFromVolumeRecoveryPointOutput
Initiates a snapshot of a gateway from a volume recovery point.
-
#create_stored_iscsi_volume(params = {}) ⇒ Types::CreateStorediSCSIVolumeOutput
Creates a volume on a specified gateway.
-
#create_tape_pool(params = {}) ⇒ Types::CreateTapePoolOutput
Creates a new custom tape pool.
-
#create_tape_with_barcode(params = {}) ⇒ Types::CreateTapeWithBarcodeOutput
Creates a virtual tape by using your own barcode.
-
#create_tapes(params = {}) ⇒ Types::CreateTapesOutput
Creates one or more virtual tapes.
-
#delete_automatic_tape_creation_policy(params = {}) ⇒ Types::DeleteAutomaticTapeCreationPolicyOutput
Deletes the automatic tape creation policy of a gateway.
-
#delete_bandwidth_rate_limit(params = {}) ⇒ Types::DeleteBandwidthRateLimitOutput
Deletes the bandwidth rate limits of a gateway.
-
#delete_chap_credentials(params = {}) ⇒ Types::DeleteChapCredentialsOutput
Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.
-
#delete_file_share(params = {}) ⇒ Types::DeleteFileShareOutput
Deletes a file share from an S3 File Gateway.
-
#delete_gateway(params = {}) ⇒ Types::DeleteGatewayOutput
Deletes a gateway.
-
#delete_snapshot_schedule(params = {}) ⇒ Types::DeleteSnapshotScheduleOutput
Deletes a snapshot of a volume.
-
#delete_tape(params = {}) ⇒ Types::DeleteTapeOutput
Deletes the specified virtual tape.
-
#delete_tape_archive(params = {}) ⇒ Types::DeleteTapeArchiveOutput
Deletes the specified virtual tape from the virtual tape shelf (VTS).
-
#delete_tape_pool(params = {}) ⇒ Types::DeleteTapePoolOutput
Delete a custom tape pool.
-
#delete_volume(params = {}) ⇒ Types::DeleteVolumeOutput
Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API.
-
#describe_availability_monitor_test(params = {}) ⇒ Types::DescribeAvailabilityMonitorTestOutput
Returns information about the most recent high availability monitoring test that was performed on the host in a cluster.
-
#describe_bandwidth_rate_limit(params = {}) ⇒ Types::DescribeBandwidthRateLimitOutput
Returns the bandwidth rate limits of a gateway.
-
#describe_bandwidth_rate_limit_schedule(params = {}) ⇒ Types::DescribeBandwidthRateLimitScheduleOutput
Returns information about the bandwidth rate limit schedule of a gateway.
-
#describe_cache(params = {}) ⇒ Types::DescribeCacheOutput
Returns information about the cache of a gateway.
-
#describe_cached_iscsi_volumes(params = {}) ⇒ Types::DescribeCachediSCSIVolumesOutput
Returns a description of the gateway volumes specified in the request.
-
#describe_chap_credentials(params = {}) ⇒ Types::DescribeChapCredentialsOutput
Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.
-
#describe_file_system_associations(params = {}) ⇒ Types::DescribeFileSystemAssociationsOutput
Gets the file system association information.
-
#describe_gateway_information(params = {}) ⇒ Types::DescribeGatewayInformationOutput
Returns metadata about a gateway such as its name, network interfaces, time zone, status, and software version.
-
#describe_maintenance_start_time(params = {}) ⇒ Types::DescribeMaintenanceStartTimeOutput
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.
-
#describe_nfs_file_shares(params = {}) ⇒ Types::DescribeNFSFileSharesOutput
Gets a description for one or more Network File System (NFS) file shares from an S3 File Gateway.
-
#describe_smb_file_shares(params = {}) ⇒ Types::DescribeSMBFileSharesOutput
Gets a description for one or more Server Message Block (SMB) file shares from a S3 File Gateway.
-
#describe_smb_settings(params = {}) ⇒ Types::DescribeSMBSettingsOutput
Gets a description of a Server Message Block (SMB) file share settings from a file gateway.
-
#describe_snapshot_schedule(params = {}) ⇒ Types::DescribeSnapshotScheduleOutput
Describes the snapshot schedule for the specified gateway volume.
-
#describe_stored_iscsi_volumes(params = {}) ⇒ Types::DescribeStorediSCSIVolumesOutput
Returns the description of the gateway volumes specified in the request.
-
#describe_tape_archives(params = {}) ⇒ Types::DescribeTapeArchivesOutput
Returns a description of specified virtual tapes in the virtual tape shelf (VTS).
-
#describe_tape_recovery_points(params = {}) ⇒ Types::DescribeTapeRecoveryPointsOutput
Returns a list of virtual tape recovery points that are available for the specified tape gateway.
-
#describe_tapes(params = {}) ⇒ Types::DescribeTapesOutput
Returns a description of virtual tapes that correspond to the specified Amazon Resource Names (ARNs).
-
#describe_upload_buffer(params = {}) ⇒ Types::DescribeUploadBufferOutput
Returns information about the upload buffer of a gateway.
-
#describe_vtl_devices(params = {}) ⇒ Types::DescribeVTLDevicesOutput
Returns a description of virtual tape library (VTL) devices for the specified tape gateway.
-
#describe_working_storage(params = {}) ⇒ Types::DescribeWorkingStorageOutput
Returns information about the working storage of a gateway.
-
#detach_volume(params = {}) ⇒ Types::DetachVolumeOutput
Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway.
-
#disable_gateway(params = {}) ⇒ Types::DisableGatewayOutput
Disables a tape gateway when the gateway is no longer functioning.
-
#disassociate_file_system(params = {}) ⇒ Types::DisassociateFileSystemOutput
Disassociates an Amazon FSx file system from the specified gateway.
-
#join_domain(params = {}) ⇒ Types::JoinDomainOutput
Adds a file gateway to an Active Directory domain.
-
#list_automatic_tape_creation_policies(params = {}) ⇒ Types::ListAutomaticTapeCreationPoliciesOutput
Lists the automatic tape creation policies for a gateway.
-
#list_file_shares(params = {}) ⇒ Types::ListFileSharesOutput
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.
-
#list_file_system_associations(params = {}) ⇒ Types::ListFileSystemAssociationsOutput
Gets a list of
FileSystemAssociationSummary
objects. -
#list_gateways(params = {}) ⇒ Types::ListGatewaysOutput
Lists gateways owned by an Amazon Web Services account in an Amazon Web Services Region specified in the request.
-
#list_local_disks(params = {}) ⇒ Types::ListLocalDisksOutput
Returns a list of the gateway's local disks.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Lists the tags that have been added to the specified resource.
-
#list_tape_pools(params = {}) ⇒ Types::ListTapePoolsOutput
Lists custom tape pools.
-
#list_tapes(params = {}) ⇒ Types::ListTapesOutput
Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS).
-
#list_volume_initiators(params = {}) ⇒ Types::ListVolumeInitiatorsOutput
Lists iSCSI initiators that are connected to a volume.
-
#list_volume_recovery_points(params = {}) ⇒ Types::ListVolumeRecoveryPointsOutput
Lists the recovery points for a specified gateway.
-
#list_volumes(params = {}) ⇒ Types::ListVolumesOutput
Lists the iSCSI stored volumes of a gateway.
-
#notify_when_uploaded(params = {}) ⇒ Types::NotifyWhenUploadedOutput
Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to Amazon S3.
-
#refresh_cache(params = {}) ⇒ Types::RefreshCacheOutput
Refreshes the cached inventory of objects for the specified file share.
-
#remove_tags_from_resource(params = {}) ⇒ Types::RemoveTagsFromResourceOutput
Removes one or more tags from the specified resource.
-
#reset_cache(params = {}) ⇒ Types::ResetCacheOutput
Resets all cache disks that have encountered an error and makes the disks available for reconfiguration as cache storage.
-
#retrieve_tape_archive(params = {}) ⇒ Types::RetrieveTapeArchiveOutput
Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway.
-
#retrieve_tape_recovery_point(params = {}) ⇒ Types::RetrieveTapeRecoveryPointOutput
Retrieves the recovery point for the specified virtual tape.
-
#set_local_console_password(params = {}) ⇒ Types::SetLocalConsolePasswordOutput
Sets the password for your VM local console.
-
#set_smb_guest_password(params = {}) ⇒ Types::SetSMBGuestPasswordOutput
Sets the password for the guest user
smbguest
. -
#shutdown_gateway(params = {}) ⇒ Types::ShutdownGatewayOutput
Shuts down a Tape Gateway or Volume Gateway.
-
#start_availability_monitor_test(params = {}) ⇒ Types::StartAvailabilityMonitorTestOutput
Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment.
-
#start_gateway(params = {}) ⇒ Types::StartGatewayOutput
Starts a gateway that you previously shut down (see ShutdownGateway).
-
#update_automatic_tape_creation_policy(params = {}) ⇒ Types::UpdateAutomaticTapeCreationPolicyOutput
Updates the automatic tape creation policy of a gateway.
-
#update_bandwidth_rate_limit(params = {}) ⇒ Types::UpdateBandwidthRateLimitOutput
Updates the bandwidth rate limits of a gateway.
-
#update_bandwidth_rate_limit_schedule(params = {}) ⇒ Types::UpdateBandwidthRateLimitScheduleOutput
Updates the bandwidth rate limit schedule for a specified gateway.
-
#update_chap_credentials(params = {}) ⇒ Types::UpdateChapCredentialsOutput
Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target.
-
#update_file_system_association(params = {}) ⇒ Types::UpdateFileSystemAssociationOutput
Updates a file system association.
-
#update_gateway_information(params = {}) ⇒ Types::UpdateGatewayInformationOutput
Updates a gateway's metadata, which includes the gateway's name, time zone, and metadata cache size.
-
#update_gateway_software_now(params = {}) ⇒ Types::UpdateGatewaySoftwareNowOutput
Updates the gateway virtual machine (VM) software.
-
#update_maintenance_start_time(params = {}) ⇒ Types::UpdateMaintenanceStartTimeOutput
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.
-
#update_nfs_file_share(params = {}) ⇒ Types::UpdateNFSFileShareOutput
Updates a Network File System (NFS) file share.
-
#update_smb_file_share(params = {}) ⇒ Types::UpdateSMBFileShareOutput
Updates a Server Message Block (SMB) file share.
-
#update_smb_file_share_visibility(params = {}) ⇒ Types::UpdateSMBFileShareVisibilityOutput
Controls whether the shares on an S3 File Gateway are visible in a net view or browse list.
-
#update_smb_local_groups(params = {}) ⇒ Types::UpdateSMBLocalGroupsOutput
Updates the list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.
-
#update_smb_security_strategy(params = {}) ⇒ Types::UpdateSMBSecurityStrategyOutput
Updates the SMB security strategy level for an Amazon S3 file gateway.
-
#update_snapshot_schedule(params = {}) ⇒ Types::UpdateSnapshotScheduleOutput
Updates a snapshot schedule configured for a gateway volume.
-
#update_vtl_device_type(params = {}) ⇒ Types::UpdateVTLDeviceTypeOutput
Updates the type of medium changer in a tape gateway.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
420 421 422 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 420 def initialize(*args) super end |
Instance Method Details
#activate_gateway(params = {}) ⇒ Types::ActivateGatewayOutput
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.
565 566 567 568 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 565 def activate_gateway(params = {}, = {}) req = build_request(:activate_gateway, params) req.send_request() end |
#add_cache(params = {}) ⇒ Types::AddCacheOutput
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.
629 630 631 632 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 629 def add_cache(params = {}, = {}) req = build_request(:add_cache, params) req.send_request() end |
#add_tags_to_resource(params = {}) ⇒ Types::AddTagsToResourceOutput
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.
714 715 716 717 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 714 def (params = {}, = {}) req = build_request(:add_tags_to_resource, params) req.send_request() end |
#add_upload_buffer(params = {}) ⇒ Types::AddUploadBufferOutput
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.
774 775 776 777 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 774 def add_upload_buffer(params = {}, = {}) req = build_request(:add_upload_buffer, params) req.send_request() end |
#add_working_storage(params = {}) ⇒ Types::AddWorkingStorageOutput
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.
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.
842 843 844 845 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 842 def add_working_storage(params = {}, = {}) req = build_request(:add_working_storage, params) req.send_request() end |
#assign_tape_pool(params = {}) ⇒ Types::AssignTapePoolOutput
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.
894 895 896 897 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 894 def assign_tape_pool(params = {}, = {}) req = build_request(:assign_tape_pool, params) req.send_request() end |
#associate_file_system(params = {}) ⇒ Types::AssociateFileSystemOutput
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.
979 980 981 982 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 979 def associate_file_system(params = {}, = {}) req = build_request(:associate_file_system, params) req.send_request() end |
#attach_volume(params = {}) ⇒ Types::AttachVolumeOutput
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.
1045 1046 1047 1048 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 1045 def attach_volume(params = {}, = {}) req = build_request(:attach_volume, params) req.send_request() end |
#cancel_archival(params = {}) ⇒ Types::CancelArchivalOutput
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.
1097 1098 1099 1100 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 1097 def cancel_archival(params = {}, = {}) req = build_request(:cancel_archival, params) req.send_request() end |
#cancel_retrieval(params = {}) ⇒ Types::CancelRetrievalOutput
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.
1151 1152 1153 1154 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 1151 def cancel_retrieval(params = {}, = {}) req = build_request(:cancel_retrieval, params) req.send_request() end |
#create_cached_iscsi_volume(params = {}) ⇒ Types::CreateCachediSCSIVolumeOutput
Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type.
In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.
Optionally, you can provide the ARN for an existing volume as the
SourceVolumeARN
for this cached volume, which creates an exact copy
of the existing volume’s latest recovery point. The
VolumeSizeInBytes
value must be equal to or larger than the size of
the copied volume, in bytes.
1304 1305 1306 1307 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 1304 def create_cached_iscsi_volume(params = {}, = {}) req = build_request(:create_cached_iscsi_volume, params) req.send_request() end |
#create_nfs_file_share(params = {}) ⇒ Types::CreateNFSFileShareOutput
Creates a Network File System (NFS) file share on an existing S3 File Gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using an NFS interface. This operation is only supported for S3 File Gateways.
S3 File gateway requires Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your S3 File Gateway in. If Amazon Web Services STS is not activated in the Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region in the Identity and Access Management User Guide.
S3 File Gateways do not support creating hard or symbolic links on a file share.
1563 1564 1565 1566 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 1563 def create_nfs_file_share(params = {}, = {}) req = build_request(:create_nfs_file_share, params) req.send_request() end |
#create_smb_file_share(params = {}) ⇒ Types::CreateSMBFileShareOutput
Creates a Server Message Block (SMB) file share on an existing S3 File Gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using an SMB interface. This operation is only supported for S3 File Gateways.
S3 File Gateways require Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure that Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your S3 File Gateway in. If Amazon Web Services STS is not activated in this Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region in the Identity and Access Management User Guide.
File gateways don't support creating hard or symbolic links on a file share.
1870 1871 1872 1873 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 1870 def create_smb_file_share(params = {}, = {}) req = build_request(:create_smb_file_share, params) req.send_request() end |
#create_snapshot(params = {}) ⇒ Types::CreateSnapshotOutput
Initiates a snapshot of a volume.
Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (Amazon S3) for durable off-site recovery, and also import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis. This API enables you to take an ad hoc snapshot. For more information, see Editing a snapshot schedule.
In the CreateSnapshot
request, you identify the volume by providing
its Amazon Resource Name (ARN). You must also provide description for
the snapshot. When Storage Gateway takes the snapshot of specified
volume, the snapshot and description appears in the Storage Gateway
console. In response, Storage Gateway returns you a snapshot ID. You
can use this snapshot ID to check the snapshot progress or later use
it when you want to create a volume from a snapshot. This operation is
only supported in stored and cached volume gateway type.
Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page.
1974 1975 1976 1977 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 1974 def create_snapshot(params = {}, = {}) req = build_request(:create_snapshot, params) req.send_request() end |
#create_snapshot_from_volume_recovery_point(params = {}) ⇒ Types::CreateSnapshotFromVolumeRecoveryPointOutput
Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type.
A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for cached volume gateway, use ListVolumeRecoveryPoints.
In the CreateSnapshotFromVolumeRecoveryPoint
request, you identify
the volume by providing its Amazon Resource Name (ARN). You must also
provide a description for the snapshot. When the gateway takes a
snapshot of the specified volume, the snapshot and its description
appear in the Storage Gateway console. In response, the gateway
returns you a snapshot ID. You can use this snapshot ID to check the
snapshot progress or later use it when you want to create a volume
from a snapshot.
2075 2076 2077 2078 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 2075 def create_snapshot_from_volume_recovery_point(params = {}, = {}) req = build_request(:create_snapshot_from_volume_recovery_point, params) req.send_request() end |
#create_stored_iscsi_volume(params = {}) ⇒ Types::CreateStorediSCSIVolumeOutput
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.
2223 2224 2225 2226 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 2223 def create_stored_iscsi_volume(params = {}, = {}) req = build_request(:create_stored_iscsi_volume, params) req.send_request() end |
#create_tape_pool(params = {}) ⇒ Types::CreateTapePoolOutput
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.
2290 2291 2292 2293 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 2290 def create_tape_pool(params = {}, = {}) req = build_request(:create_tape_pool, params) req.send_request() end |
#create_tape_with_barcode(params = {}) ⇒ Types::CreateTapeWithBarcodeOutput
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.
2408 2409 2410 2411 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 2408 def (params = {}, = {}) req = build_request(:create_tape_with_barcode, params) req.send_request() end |
#create_tapes(params = {}) ⇒ Types::CreateTapesOutput
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.
2547 2548 2549 2550 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 2547 def create_tapes(params = {}, = {}) req = build_request(:create_tapes, params) req.send_request() end |
#delete_automatic_tape_creation_policy(params = {}) ⇒ Types::DeleteAutomaticTapeCreationPolicyOutput
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.
2580 2581 2582 2583 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 2580 def delete_automatic_tape_creation_policy(params = {}, = {}) req = build_request(:delete_automatic_tape_creation_policy, params) req.send_request() end |
#delete_bandwidth_rate_limit(params = {}) ⇒ Types::DeleteBandwidthRateLimitOutput
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.
2638 2639 2640 2641 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 2638 def delete_bandwidth_rate_limit(params = {}, = {}) req = build_request(:delete_bandwidth_rate_limit, params) req.send_request() end |
#delete_chap_credentials(params = {}) ⇒ Types::DeleteChapCredentialsOutput
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.
2692 2693 2694 2695 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 2692 def delete_chap_credentials(params = {}, = {}) req = build_request(:delete_chap_credentials, params) req.send_request() end |
#delete_file_share(params = {}) ⇒ Types::DeleteFileShareOutput
Deletes a file share from an S3 File Gateway. This operation is only supported for S3 File Gateways.
2731 2732 2733 2734 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 2731 def delete_file_share(params = {}, = {}) req = build_request(:delete_file_share, params) req.send_request() end |
#delete_gateway(params = {}) ⇒ Types::DeleteGatewayOutput
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.
2797 2798 2799 2800 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 2797 def delete_gateway(params = {}, = {}) req = build_request(:delete_gateway, params) req.send_request() end |
#delete_snapshot_schedule(params = {}) ⇒ Types::DeleteSnapshotScheduleOutput
Deletes a snapshot of a volume.
You can take snapshots of your gateway volumes on a scheduled or ad
hoc basis. This API action enables you to delete a snapshot schedule
for a volume. For more information, see Backing up your volumes.
In the DeleteSnapshotSchedule
request, you identify the volume by
providing its Amazon Resource Name (ARN). This operation is only
supported for cached volume gateway types.
2857 2858 2859 2860 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 2857 def delete_snapshot_schedule(params = {}, = {}) req = build_request(:delete_snapshot_schedule, params) req.send_request() end |
#delete_tape(params = {}) ⇒ Types::DeleteTapeOutput
Deletes the specified virtual tape. This operation is only supported in the tape gateway type.
2915 2916 2917 2918 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 2915 def delete_tape(params = {}, = {}) req = build_request(:delete_tape, params) req.send_request() end |
#delete_tape_archive(params = {}) ⇒ Types::DeleteTapeArchiveOutput
Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.
2966 2967 2968 2969 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 2966 def delete_tape_archive(params = {}, = {}) req = build_request(:delete_tape_archive, params) req.send_request() end |
#delete_tape_pool(params = {}) ⇒ Types::DeleteTapePoolOutput
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.
2996 2997 2998 2999 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 2996 def delete_tape_pool(params = {}, = {}) req = build_request(:delete_tape_pool, params) req.send_request() end |
#delete_volume(params = {}) ⇒ Types::DeleteVolumeOutput
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.
3060 3061 3062 3063 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 3060 def delete_volume(params = {}, = {}) req = build_request(:delete_volume, params) req.send_request() end |
#describe_availability_monitor_test(params = {}) ⇒ Types::DescribeAvailabilityMonitorTestOutput
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.
3096 3097 3098 3099 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 3096 def describe_availability_monitor_test(params = {}, = {}) req = build_request(:describe_availability_monitor_test, params) req.send_request() end |
#describe_bandwidth_rate_limit(params = {}) ⇒ Types::DescribeBandwidthRateLimitOutput
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.
3156 3157 3158 3159 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 3156 def describe_bandwidth_rate_limit(params = {}, = {}) req = build_request(:describe_bandwidth_rate_limit, params) req.send_request() end |
#describe_bandwidth_rate_limit_schedule(params = {}) ⇒ Types::DescribeBandwidthRateLimitScheduleOutput
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.
3216 3217 3218 3219 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 3216 def describe_bandwidth_rate_limit_schedule(params = {}, = {}) req = build_request(:describe_bandwidth_rate_limit_schedule, params) req.send_request() end |
#describe_cache(params = {}) ⇒ Types::DescribeCacheOutput
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.
3286 3287 3288 3289 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 3286 def describe_cache(params = {}, = {}) req = build_request(:describe_cache, params) req.send_request() end |
#describe_cached_iscsi_volumes(params = {}) ⇒ Types::DescribeCachediSCSIVolumesOutput
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).
3370 3371 3372 3373 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 3370 def describe_cached_iscsi_volumes(params = {}, = {}) req = build_request(:describe_cached_iscsi_volumes, params) req.send_request() end |
#describe_chap_credentials(params = {}) ⇒ Types::DescribeChapCredentialsOutput
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.
3429 3430 3431 3432 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 3429 def describe_chap_credentials(params = {}, = {}) req = build_request(:describe_chap_credentials, params) req.send_request() end |
#describe_file_system_associations(params = {}) ⇒ Types::DescribeFileSystemAssociationsOutput
Gets the file system association information. This operation is only supported for FSx File Gateways.
3472 3473 3474 3475 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 3472 def describe_file_system_associations(params = {}, = {}) req = build_request(:describe_file_system_associations, params) req.send_request() end |
#describe_gateway_information(params = {}) ⇒ Types::DescribeGatewayInformationOutput
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.
3580 3581 3582 3583 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 3580 def describe_gateway_information(params = {}, = {}) req = build_request(:describe_gateway_information, params) req.send_request() end |
#describe_maintenance_start_time(params = {}) ⇒ Types::DescribeMaintenanceStartTimeOutput
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.
3643 3644 3645 3646 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 3643 def describe_maintenance_start_time(params = {}, = {}) req = build_request(:describe_maintenance_start_time, params) req.send_request() end |
#describe_nfs_file_shares(params = {}) ⇒ Types::DescribeNFSFileSharesOutput
Gets a description for one or more Network File System (NFS) file shares from an S3 File Gateway. This operation is only supported for S3 File Gateways.
3704 3705 3706 3707 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 3704 def describe_nfs_file_shares(params = {}, = {}) req = build_request(:describe_nfs_file_shares, params) req.send_request() end |
#describe_smb_file_shares(params = {}) ⇒ Types::DescribeSMBFileSharesOutput
Gets a description for one or more Server Message Block (SMB) file shares from a S3 File Gateway. This operation is only supported for S3 File Gateways.
3769 3770 3771 3772 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 3769 def describe_smb_file_shares(params = {}, = {}) req = build_request(:describe_smb_file_shares, params) req.send_request() end |
#describe_smb_settings(params = {}) ⇒ Types::DescribeSMBSettingsOutput
Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.
3814 3815 3816 3817 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 3814 def describe_smb_settings(params = {}, = {}) req = build_request(:describe_smb_settings, params) req.send_request() end |
#describe_snapshot_schedule(params = {}) ⇒ Types::DescribeSnapshotScheduleOutput
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.
3877 3878 3879 3880 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 3877 def describe_snapshot_schedule(params = {}, = {}) req = build_request(:describe_snapshot_schedule, params) req.send_request() end |
#describe_stored_iscsi_volumes(params = {}) ⇒ Types::DescribeStorediSCSIVolumesOutput
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.
3963 3964 3965 3966 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 3963 def describe_stored_iscsi_volumes(params = {}, = {}) req = build_request(:describe_stored_iscsi_volumes, params) req.send_request() end |
#describe_tape_archives(params = {}) ⇒ Types::DescribeTapeArchivesOutput
Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.
If a specific TapeARN
is not specified, Storage Gateway returns a
description of all virtual tapes found in the VTS associated with your
account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4060 4061 4062 4063 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 4060 def describe_tape_archives(params = {}, = {}) req = build_request(:describe_tape_archives, params) req.send_request() end |
#describe_tape_recovery_points(params = {}) ⇒ Types::DescribeTapeRecoveryPointsOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4142 4143 4144 4145 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 4142 def describe_tape_recovery_points(params = {}, = {}) req = build_request(:describe_tape_recovery_points, params) req.send_request() end |
#describe_tapes(params = {}) ⇒ Types::DescribeTapesOutput
Returns a description of virtual tapes that correspond to the
specified Amazon Resource Names (ARNs). If TapeARN
is 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 Limit
field in the body to limit the number of tapes in the response. If the
number of tapes returned in the response is truncated, the response
includes a Marker
field. You can use this Marker
value in your
subsequent request to retrieve the next set of tapes.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4259 4260 4261 4262 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 4259 def describe_tapes(params = {}, = {}) req = build_request(:describe_tapes, params) req.send_request() end |
#describe_upload_buffer(params = {}) ⇒ Types::DescribeUploadBufferOutput
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.
4343 4344 4345 4346 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 4343 def describe_upload_buffer(params = {}, = {}) req = build_request(:describe_upload_buffer, params) req.send_request() end |
#describe_vtl_devices(params = {}) ⇒ Types::DescribeVTLDevicesOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4469 4470 4471 4472 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 4469 def describe_vtl_devices(params = {}, = {}) req = build_request(:describe_vtl_devices, params) req.send_request() end |
#describe_working_storage(params = {}) ⇒ Types::DescribeWorkingStorageOutput
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.
The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.
4539 4540 4541 4542 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 4539 def describe_working_storage(params = {}, = {}) req = build_request(:describe_working_storage, params) req.send_request() end |
#detach_volume(params = {}) ⇒ Types::DetachVolumeOutput
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.
4583 4584 4585 4586 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 4583 def detach_volume(params = {}, = {}) req = build_request(:detach_volume, params) req.send_request() end |
#disable_gateway(params = {}) ⇒ Types::DisableGatewayOutput
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.
4636 4637 4638 4639 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 4636 def disable_gateway(params = {}, = {}) req = build_request(:disable_gateway, params) req.send_request() end |
#disassociate_file_system(params = {}) ⇒ Types::DisassociateFileSystemOutput
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.
4676 4677 4678 4679 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 4676 def disassociate_file_system(params = {}, = {}) req = build_request(:disassociate_file_system, params) req.send_request() end |
#join_domain(params = {}) ⇒ Types::JoinDomainOutput
Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.
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.
4757 4758 4759 4760 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 4757 def join_domain(params = {}, = {}) req = build_request(:join_domain, params) req.send_request() end |
#list_automatic_tape_creation_policies(params = {}) ⇒ Types::ListAutomaticTapeCreationPoliciesOutput
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.
4798 4799 4800 4801 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 4798 def list_automatic_tape_creation_policies(params = {}, = {}) req = build_request(:list_automatic_tape_creation_policies, params) req.send_request() end |
#list_file_shares(params = {}) ⇒ Types::ListFileSharesOutput
Gets a list of the file shares for a specific S3 File Gateway, or the list of file shares that belong to the calling Amazon Web Services account. This operation is only supported for S3 File Gateways.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4852 4853 4854 4855 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 4852 def list_file_shares(params = {}, = {}) req = build_request(:list_file_shares, params) req.send_request() end |
#list_file_system_associations(params = {}) ⇒ Types::ListFileSystemAssociationsOutput
Gets a list of FileSystemAssociationSummary
objects. Each object
contains a summary of a file system association. This operation is
only supported for FSx File Gateways.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4907 4908 4909 4910 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 4907 def list_file_system_associations(params = {}, = {}) req = build_request(:list_file_system_associations, params) req.send_request() end |
#list_gateways(params = {}) ⇒ Types::ListGatewaysOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4991 4992 4993 4994 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 4991 def list_gateways(params = {}, = {}) req = build_request(:list_gateways, params) req.send_request() end |
#list_local_disks(params = {}) ⇒ Types::ListLocalDisksOutput
Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request.
The request returns a list of all disks, specifying which are
configured as working storage, cache storage, or stored volume or not
configured at all. The response includes a DiskStatus
field. This
field can have a value of present (the disk is available to use),
missing (the disk is no longer connected to the gateway), or mismatch
(the disk node is occupied by a disk that has incorrect metadata or
the disk content is corrupted).
5076 5077 5078 5079 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 5076 def list_local_disks(params = {}, = {}) req = build_request(:list_local_disks, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Lists the tags that have been added to the specified resource. This operation is supported in storage gateways of all types.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5147 5148 5149 5150 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 5147 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_tape_pools(params = {}) ⇒ Types::ListTapePoolsOutput
Lists custom tape pools. You specify custom tape pools to list by specifying one or more custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN, the operation lists all custom tape pools.
This operation supports pagination. You can optionally specify the
Limit
parameter in the body to limit the number of tape pools in the
response. If the number of tape pools returned in the response is
truncated, the response includes a Marker
element that you can use
in your subsequent request to retrieve the next set of tape pools.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5206 5207 5208 5209 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 5206 def list_tape_pools(params = {}, = {}) req = build_request(:list_tape_pools, params) req.send_request() end |
#list_tapes(params = {}) ⇒ Types::ListTapesOutput
Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS.
This operation supports pagination. By default, the operation returns
a maximum of up to 100 tapes. You can optionally specify the Limit
parameter in the body to limit the number of tapes in the response. If
the number of tapes returned in the response is truncated, the
response includes a Marker
element that you can use in your
subsequent request to retrieve the next set of tapes. This operation
is only supported in the tape gateway type.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5270 5271 5272 5273 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 5270 def list_tapes(params = {}, = {}) req = build_request(:list_tapes, params) req.send_request() end |
#list_volume_initiators(params = {}) ⇒ Types::ListVolumeInitiatorsOutput
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.
5303 5304 5305 5306 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 5303 def list_volume_initiators(params = {}, = {}) req = build_request(:list_volume_initiators, params) req.send_request() end |
#list_volume_recovery_points(params = {}) ⇒ Types::ListVolumeRecoveryPointsOutput
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.
5368 5369 5370 5371 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 5368 def list_volume_recovery_points(params = {}, = {}) req = build_request(:list_volume_recovery_points, params) req.send_request() end |
#list_volumes(params = {}) ⇒ Types::ListVolumesOutput
Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the DescribeCachediSCSIVolumes API.
The operation supports pagination. By default, the operation returns a
maximum of up to 100 volumes. You can optionally specify the Limit
field in the body to limit the number of volumes in the response. If
the number of volumes returned in the response is truncated, the
response includes a Marker field. You can use this Marker value in
your subsequent request to retrieve the next set of volumes. This
operation is only supported in the cached volume and stored volume
gateway types.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5469 5470 5471 5472 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 5469 def list_volumes(params = {}, = {}) req = build_request(:list_volumes, params) req.send_request() end |
#notify_when_uploaded(params = {}) ⇒ Types::NotifyWhenUploadedOutput
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.
5517 5518 5519 5520 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 5517 def notify_when_uploaded(params = {}, = {}) req = build_request(:notify_when_uploaded, params) req.send_request() end |
#refresh_cache(params = {}) ⇒ Types::RefreshCacheOutput
Refreshes the cached inventory of objects for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed, or replaced since the gateway last listed the bucket's contents and cached the results. This operation does not import files into the S3 File Gateway cache storage. It only updates the cached inventory to reflect changes in the inventory of the objects in the S3 bucket. This operation is only supported in the S3 File Gateway types.
You can subscribe to be notified through an Amazon CloudWatch event
when your RefreshCache
operation completes. For more information,
see Getting notified about file operations in the 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
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 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
InvalidGatewayRequestException
error because too many requests were sent to the server.
For more information, see Getting notified about file operations in the Amazon S3 File Gateway User Guide.
5617 5618 5619 5620 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 5617 def refresh_cache(params = {}, = {}) req = build_request(:refresh_cache, params) req.send_request() end |
#remove_tags_from_resource(params = {}) ⇒ Types::RemoveTagsFromResourceOutput
Removes one or more tags from the specified resource. This operation is supported in storage gateways of all types.
5670 5671 5672 5673 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 5670 def (params = {}, = {}) req = build_request(:remove_tags_from_resource, params) req.send_request() end |
#reset_cache(params = {}) ⇒ Types::ResetCacheOutput
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.
5727 5728 5729 5730 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 5727 def reset_cache(params = {}, = {}) req = build_request(:reset_cache, params) req.send_request() end |
#retrieve_tape_archive(params = {}) ⇒ Types::RetrieveTapeArchiveOutput
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.
5791 5792 5793 5794 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 5791 def retrieve_tape_archive(params = {}, = {}) req = build_request(:retrieve_tape_archive, params) req.send_request() end |
#retrieve_tape_recovery_point(params = {}) ⇒ Types::RetrieveTapeRecoveryPointOutput
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.
5853 5854 5855 5856 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 5853 def retrieve_tape_recovery_point(params = {}, = {}) req = build_request(:retrieve_tape_recovery_point, params) req.send_request() end |
#set_local_console_password(params = {}) ⇒ Types::SetLocalConsolePasswordOutput
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.
5905 5906 5907 5908 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 5905 def set_local_console_password(params = {}, = {}) req = build_request(:set_local_console_password, params) req.send_request() end |
#set_smb_guest_password(params = {}) ⇒ Types::SetSMBGuestPasswordOutput
Sets the password for the guest user smbguest
. The smbguest
user
is the user when the authentication method for the file share is set
to GuestAccess
. This operation only supported for S3 File Gateways
5940 5941 5942 5943 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 5940 def set_smb_guest_password(params = {}, = {}) req = build_request(:set_smb_guest_password, params) req.send_request() end |
#shutdown_gateway(params = {}) ⇒ Types::ShutdownGatewayOutput
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.
The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM.
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.
200 OK
success
response immediately. However, it might take some time for the gateway
to shut down. You can call the DescribeGatewayInformation API to check
the status. For more information, see ActivateGateway.
If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.
6018 6019 6020 6021 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 6018 def shutdown_gateway(params = {}, = {}) req = build_request(:shutdown_gateway, params) req.send_request() end |
#start_availability_monitor_test(params = {}) ⇒ Types::StartAvailabilityMonitorTestOutput
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.
6058 6059 6060 6061 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 6058 def start_availability_monitor_test(params = {}, = {}) req = build_request(:start_availability_monitor_test, params) req.send_request() end |
#start_gateway(params = {}) ⇒ Types::StartGatewayOutput
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.
To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.
6116 6117 6118 6119 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 6116 def start_gateway(params = {}, = {}) req = build_request(:start_gateway, params) req.send_request() end |
#update_automatic_tape_creation_policy(params = {}) ⇒ Types::UpdateAutomaticTapeCreationPolicyOutput
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.
6168 6169 6170 6171 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 6168 def update_automatic_tape_creation_policy(params = {}, = {}) req = build_request(:update_automatic_tape_creation_policy, params) req.send_request() end |
#update_bandwidth_rate_limit(params = {}) ⇒ Types::UpdateBandwidthRateLimitOutput
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.
6236 6237 6238 6239 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 6236 def update_bandwidth_rate_limit(params = {}, = {}) req = build_request(:update_bandwidth_rate_limit, params) req.send_request() end |
#update_bandwidth_rate_limit_schedule(params = {}) ⇒ Types::UpdateBandwidthRateLimitScheduleOutput
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.
6288 6289 6290 6291 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 6288 def update_bandwidth_rate_limit_schedule(params = {}, = {}) req = build_request(:update_bandwidth_rate_limit_schedule, params) req.send_request() end |
#update_chap_credentials(params = {}) ⇒ Types::UpdateChapCredentialsOutput
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.
6369 6370 6371 6372 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 6369 def update_chap_credentials(params = {}, = {}) req = build_request(:update_chap_credentials, params) req.send_request() end |
#update_file_system_association(params = {}) ⇒ Types::UpdateFileSystemAssociationOutput
Updates a file system association. This operation is only supported in the FSx File Gateways.
6419 6420 6421 6422 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 6419 def update_file_system_association(params = {}, = {}) req = build_request(:update_file_system_association, params) req.send_request() end |
#update_gateway_information(params = {}) ⇒ Types::UpdateGatewayInformationOutput
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.
6507 6508 6509 6510 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 6507 def update_gateway_information(params = {}, = {}) req = build_request(:update_gateway_information, params) req.send_request() end |
#update_gateway_software_now(params = {}) ⇒ Types::UpdateGatewaySoftwareNowOutput
Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.
200 OK
success response
immediately. However, it might take some time for the update to
complete. You can call DescribeGatewayInformation to verify the
gateway is in the STATE_RUNNING
state.
A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see Customizing your Windows iSCSI settings and Customizing your Linux iSCSI settings, respectively.
6571 6572 6573 6574 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 6571 def update_gateway_software_now(params = {}, = {}) req = build_request(:update_gateway_software_now, params) req.send_request() end |
#update_maintenance_start_time(params = {}) ⇒ Types::UpdateMaintenanceStartTimeOutput
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
MinuteOfHour
and HourOfDay
, and either DayOfMonth
or
DayOfWeek
.
6675 6676 6677 6678 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 6675 def update_maintenance_start_time(params = {}, = {}) req = build_request(:update_maintenance_start_time, params) req.send_request() end |
#update_nfs_file_share(params = {}) ⇒ Types::UpdateNFSFileShareOutput
Updates a Network File System (NFS) file share. This operation is only supported in S3 File Gateways.
Updates the following file share settings:
Default storage class for your S3 bucket
Metadata defaults for your S3 bucket
Allowed NFS clients for your file share
Squash settings
Write status of your file share
6849 6850 6851 6852 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 6849 def update_nfs_file_share(params = {}, = {}) req = build_request(:update_nfs_file_share, params) req.send_request() end |
#update_smb_file_share(params = {}) ⇒ Types::UpdateSMBFileShareOutput
Updates a Server Message Block (SMB) file share. This operation is only supported for S3 File Gateways.
File gateways require Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure that Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your file gateway in. If Amazon Web Services STS is not activated in this Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region in the Identity and Access Management User Guide.
File gateways don't support creating hard or symbolic links on a file share.
7068 7069 7070 7071 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 7068 def update_smb_file_share(params = {}, = {}) req = build_request(:update_smb_file_share, params) req.send_request() end |
#update_smb_file_share_visibility(params = {}) ⇒ Types::UpdateSMBFileShareVisibilityOutput
Controls whether the shares on an S3 File Gateway are visible in a net view or browse list. The operation is only supported for S3 File Gateways.
7104 7105 7106 7107 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 7104 def update_smb_file_share_visibility(params = {}, = {}) req = build_request(:update_smb_file_share_visibility, params) req.send_request() end |
#update_smb_local_groups(params = {}) ⇒ Types::UpdateSMBLocalGroupsOutput
Updates the list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.
7142 7143 7144 7145 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 7142 def update_smb_local_groups(params = {}, = {}) req = build_request(:update_smb_local_groups, params) req.send_request() end |
#update_smb_security_strategy(params = {}) ⇒ Types::UpdateSMBSecurityStrategyOutput
Updates the SMB security strategy level for an Amazon S3 file gateway. This action is only supported for Amazon S3 file gateways.
A higher security strategy level can affect performance of the gateway.
7213 7214 7215 7216 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 7213 def update_smb_security_strategy(params = {}, = {}) req = build_request(:update_smb_security_strategy, params) req.send_request() end |
#update_snapshot_schedule(params = {}) ⇒ Types::UpdateSnapshotScheduleOutput
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.
7302 7303 7304 7305 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 7302 def update_snapshot_schedule(params = {}, = {}) req = build_request(:update_snapshot_schedule, params) req.send_request() end |
#update_vtl_device_type(params = {}) ⇒ Types::UpdateVTLDeviceTypeOutput
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.
7356 7357 7358 7359 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/client.rb', line 7356 def update_vtl_device_type(params = {}, = {}) req = build_request(:update_vtl_device_type, params) req.send_request() end |