lib/aws/storage_gateway/client.rb in aws-sdk-1.11.2 vs lib/aws/storage_gateway/client.rb in aws-sdk-1.11.3
- old
+ new
@@ -23,10 +23,11 @@
# client methods #
# @!method activate_gateway(options = {})
# Calls the ActivateGateway API operation.
# @param [Hash] options
+ #
# * `:activation_key` - *required* - (String)
# * `:gateway_name` - *required* - (String)
# * `:gateway_timezone` - *required* - (String) Valid values include:
# * `GMT-12:00`
# * `GMT-11:00`
@@ -70,10 +71,11 @@
# * `:gateway_arn` - (String)
# @!method add_cache(options = {})
# Calls the AddCache API operation.
# @param [Hash] options
+ #
# * `:gateway_arn` - *required* - (String)
# * `:disk_ids` - *required* - (Array<String>)
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
@@ -81,10 +83,11 @@
# * `:gateway_arn` - (String)
# @!method add_upload_buffer(options = {})
# Calls the AddUploadBuffer API operation.
# @param [Hash] options
+ #
# * `:gateway_arn` - *required* - (String)
# * `:disk_ids` - *required* - (Array<String>)
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
@@ -92,10 +95,11 @@
# * `:gateway_arn` - (String)
# @!method add_working_storage(options = {})
# Calls the AddWorkingStorage API operation.
# @param [Hash] options
+ #
# * `:gateway_arn` - *required* - (String)
# * `:disk_ids` - *required* - (Array<String>)
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
@@ -103,10 +107,11 @@
# * `:gateway_arn` - (String)
# @!method create_cachedi_scsi_volume(options = {})
# Calls the CreateCachediSCSIVolume API operation.
# @param [Hash] options
+ #
# * `:gateway_arn` - *required* - (String)
# * `:volume_size_in_bytes` - *required* - (Integer)
# * `:snapshot_id` - (String)
# * `:target_name` - *required* - (String)
# * `:network_interface_id` - *required* - (String)
@@ -119,10 +124,11 @@
# * `:target_arn` - (String)
# @!method create_snapshot(options = {})
# Calls the CreateSnapshot API operation.
# @param [Hash] options
+ #
# * `:volume_arn` - *required* - (String)
# * `:snapshot_description` - *required* - (String)
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
@@ -131,10 +137,11 @@
# * `:snapshot_id` - (String)
# @!method create_snapshot_from_volume_recovery_point(options = {})
# Calls the CreateSnapshotFromVolumeRecoveryPoint API operation.
# @param [Hash] options
+ #
# * `:volume_arn` - *required* - (String)
# * `:snapshot_description` - *required* - (String)
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
@@ -144,10 +151,11 @@
# * `:volume_recovery_point_time` - (String)
# @!method create_storedi_scsi_volume(options = {})
# Calls the CreateStorediSCSIVolume API operation.
# @param [Hash] options
+ #
# * `:gateway_arn` - *required* - (String)
# * `:disk_id` - *required* - (String)
# * `:snapshot_id` - (String)
# * `:preserve_existing_data` - *required* - (Boolean)
# * `:target_name` - *required* - (String)
@@ -161,10 +169,11 @@
# * `:target_arn` - (String)
# @!method delete_bandwidth_rate_limit(options = {})
# Calls the DeleteBandwidthRateLimit API operation.
# @param [Hash] options
+ #
# * `:gateway_arn` - *required* - (String)
# * `:bandwidth_type` - *required* - (String) Valid values include:
# * `UPLOAD`
# * `DOWNLOAD`
# * `ALL`
@@ -175,10 +184,11 @@
# * `:gateway_arn` - (String)
# @!method delete_chap_credentials(options = {})
# Calls the DeleteChapCredentials API operation.
# @param [Hash] options
+ #
# * `:target_arn` - *required* - (String)
# * `:initiator_name` - *required* - (String)
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
@@ -187,40 +197,44 @@
# * `:initiator_name` - (String)
# @!method delete_gateway(options = {})
# Calls the DeleteGateway API operation.
# @param [Hash] options
+ #
# * `:gateway_arn` - *required* - (String)
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
# * `:gateway_arn` - (String)
# @!method delete_snapshot_schedule(options = {})
# Calls the DeleteSnapshotSchedule API operation.
# @param [Hash] options
+ #
# * `:volume_arn` - *required* - (String)
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
# * `:volume_arn` - (String)
# @!method delete_volume(options = {})
# Calls the DeleteVolume API operation.
# @param [Hash] options
+ #
# * `:volume_arn` - *required* - (String)
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
# * `:volume_arn` - (String)
# @!method describe_bandwidth_rate_limit(options = {})
# Calls the DescribeBandwidthRateLimit API operation.
# @param [Hash] options
+ #
# * `:gateway_arn` - *required* - (String)
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
@@ -229,10 +243,11 @@
# * `:average_download_rate_limit_in_bits_per_sec` - (Integer)
# @!method describe_cache(options = {})
# Calls the DescribeCache API operation.
# @param [Hash] options
+ #
# * `:gateway_arn` - *required* - (String)
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
@@ -245,10 +260,11 @@
# * `:cache_miss_percentage` - (Numeric)
# @!method describe_cachedi_scsi_volumes(options = {})
# Calls the DescribeCachediSCSIVolumes API operation.
# @param [Hash] options
+ #
# * `:volume_ar_ns` - *required* - (Array<String>)
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
@@ -268,10 +284,11 @@
# * `:chap_enabled` - (Boolean)
# @!method describe_chap_credentials(options = {})
# Calls the DescribeChapCredentials API operation.
# @param [Hash] options
+ #
# * `:target_arn` - *required* - (String)
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
@@ -282,10 +299,11 @@
# * `:secret_to_authenticate_target` - (String)
# @!method describe_gateway_information(options = {})
# Calls the DescribeGatewayInformation API operation.
# @param [Hash] options
+ #
# * `:gateway_arn` - *required* - (String)
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
@@ -301,10 +319,11 @@
# * `:next_update_availability_date` - (String)
# @!method describe_maintenance_start_time(options = {})
# Calls the DescribeMaintenanceStartTime API operation.
# @param [Hash] options
+ #
# * `:gateway_arn` - *required* - (String)
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
@@ -315,10 +334,11 @@
# * `:timezone` - (String)
# @!method describe_snapshot_schedule(options = {})
# Calls the DescribeSnapshotSchedule API operation.
# @param [Hash] options
+ #
# * `:volume_arn` - *required* - (String)
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
@@ -329,10 +349,11 @@
# * `:timezone` - (String)
# @!method describe_storedi_scsi_volumes(options = {})
# Calls the DescribeStorediSCSIVolumes API operation.
# @param [Hash] options
+ #
# * `:volume_ar_ns` - *required* - (Array<String>)
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
@@ -354,10 +375,11 @@
# * `:chap_enabled` - (Boolean)
# @!method describe_upload_buffer(options = {})
# Calls the DescribeUploadBuffer API operation.
# @param [Hash] options
+ #
# * `:gateway_arn` - *required* - (String)
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
@@ -367,10 +389,11 @@
# * `:upload_buffer_allocated_in_bytes` - (Integer)
# @!method describe_working_storage(options = {})
# Calls the DescribeWorkingStorage API operation.
# @param [Hash] options
+ #
# * `:gateway_arn` - *required* - (String)
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
@@ -380,10 +403,11 @@
# * `:working_storage_allocated_in_bytes` - (Integer)
# @!method list_gateways(options = {})
# Calls the ListGateways API operation.
# @param [Hash] options
+ #
# * `:marker` - (String)
# * `:limit` - (Integer)
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
@@ -393,10 +417,11 @@
# * `:marker` - (String)
# @!method list_local_disks(options = {})
# Calls the ListLocalDisks API operation.
# @param [Hash] options
+ #
# * `:gateway_arn` - *required* - (String)
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
@@ -410,10 +435,11 @@
# * `:disk_allocation_resource` - (String)
# @!method list_volume_recovery_points(options = {})
# Calls the ListVolumeRecoveryPoints API operation.
# @param [Hash] options
+ #
# * `:gateway_arn` - *required* - (String)
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
@@ -425,10 +451,11 @@
# * `:volume_recovery_point_time` - (String)
# @!method list_volumes(options = {})
# Calls the ListVolumes API operation.
# @param [Hash] options
+ #
# * `:gateway_arn` - *required* - (String)
# * `:marker` - (String)
# * `:limit` - (Integer)
# @return [Core::Response]
# The #data method of the response object returns
@@ -441,30 +468,33 @@
# * `:volume_type` - (String)
# @!method shutdown_gateway(options = {})
# Calls the ShutdownGateway API operation.
# @param [Hash] options
+ #
# * `:gateway_arn` - *required* - (String)
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
# * `:gateway_arn` - (String)
# @!method start_gateway(options = {})
# Calls the StartGateway API operation.
# @param [Hash] options
+ #
# * `:gateway_arn` - *required* - (String)
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
# * `:gateway_arn` - (String)
# @!method update_bandwidth_rate_limit(options = {})
# Calls the UpdateBandwidthRateLimit API operation.
# @param [Hash] options
+ #
# * `:gateway_arn` - *required* - (String)
# * `:average_upload_rate_limit_in_bits_per_sec` - (Integer)
# * `:average_download_rate_limit_in_bits_per_sec` - (Integer)
# @return [Core::Response]
# The #data method of the response object returns
@@ -473,10 +503,11 @@
# * `:gateway_arn` - (String)
# @!method update_chap_credentials(options = {})
# Calls the UpdateChapCredentials API operation.
# @param [Hash] options
+ #
# * `:target_arn` - *required* - (String)
# * `:secret_to_authenticate_initiator` - *required* - (String)
# * `:initiator_name` - *required* - (String)
# * `:secret_to_authenticate_target` - (String)
# @return [Core::Response]
@@ -487,10 +518,11 @@
# * `:initiator_name` - (String)
# @!method update_gateway_information(options = {})
# Calls the UpdateGatewayInformation API operation.
# @param [Hash] options
+ #
# * `:gateway_arn` - *required* - (String)
# * `:gateway_name` - (String)
# * `:gateway_timezone` - (String) Valid values include:
# * `GMT-12:00`
# * `GMT-11:00`
@@ -530,20 +562,22 @@
# * `:gateway_arn` - (String)
# @!method update_gateway_software_now(options = {})
# Calls the UpdateGatewaySoftwareNow API operation.
# @param [Hash] options
+ #
# * `:gateway_arn` - *required* - (String)
# @return [Core::Response]
# The #data method of the response object returns
# a hash with the following structure:
#
# * `:gateway_arn` - (String)
# @!method update_maintenance_start_time(options = {})
# Calls the UpdateMaintenanceStartTime API operation.
# @param [Hash] options
+ #
# * `:gateway_arn` - *required* - (String)
# * `:hour_of_day` - *required* - (Integer)
# * `:minute_of_hour` - *required* - (Integer)
# * `:day_of_week` - *required* - (Integer)
# @return [Core::Response]
@@ -553,9 +587,10 @@
# * `:gateway_arn` - (String)
# @!method update_snapshot_schedule(options = {})
# Calls the UpdateSnapshotSchedule API operation.
# @param [Hash] options
+ #
# * `:volume_arn` - *required* - (String)
# * `:start_at` - *required* - (Integer)
# * `:recurrence_in_hours` - *required* - (Integer)
# * `:description` - (String)
# @return [Core::Response]