Class: AWS::StorageGateway::Client

Inherits:
Core::JSONClient show all
Defined in:
lib/aws/storage_gateway/client.rb

Overview

Client class for AWS Storage Gateway.

Instance Attribute Summary

Attributes inherited from Core::Client

#config

Instance Method Summary collapse

Methods inherited from Core::Client

#initialize, #log_warning, #operations, operations, #with_http_handler, #with_options

Constructor Details

This class inherits a constructor from AWS::Core::Client

Instance Method Details

#activate_gateway(options = {}) ⇒ Core::Response

Calls the ActivateGateway API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :activation_key - required - (String)
    • :gateway_name - required - (String)
    • :gateway_timezone - required - (String) Valid values include:
      • GMT-12:00
      • GMT-11:00
      • GMT-10:00
      • GMT-9:00
      • GMT-8:00
      • GMT-7:00
      • GMT-6:00
      • GMT-5:00
      • GMT-4:00
      • GMT-3:30
      • GMT-3:00
      • GMT-2:00
      • GMT-1:00
      • GMT
      • GMT1:00+
      • GMT2:00+
      • GMT3:00+
      • GMT3:30+
      • GMT4:00+
      • GMT4:30+
      • GMT5:00+
      • GMT5:30+
      • GMT5:45+
      • GMT6:00+
      • GMT7:00+
      • GMT8:00+
      • GMT9:00+
      • GMT9:30+
      • GMT10:00+
      • GMT11:00+
      • GMT12:00+
    • :gateway_region - required - (String)
    • :gateway_type - (String) Valid values include:
      • STORED
      • CACHED

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :gateway_arn - (String)



# File 'lib/aws/storage_gateway/client.rb', line 25

#add_cache(options = {}) ⇒ Core::Response

Calls the AddCache API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :gateway_arn - required - (String)
    • :disk_ids - required - (Array)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :gateway_arn - (String)



# File 'lib/aws/storage_gateway/client.rb', line 71

#add_upload_buffer(options = {}) ⇒ Core::Response

Calls the AddUploadBuffer API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :gateway_arn - required - (String)
    • :disk_ids - required - (Array)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :gateway_arn - (String)



# File 'lib/aws/storage_gateway/client.rb', line 81

#add_working_storage(options = {}) ⇒ Core::Response

Calls the AddWorkingStorage API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :gateway_arn - required - (String)
    • :disk_ids - required - (Array)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :gateway_arn - (String)



# File 'lib/aws/storage_gateway/client.rb', line 91

#create_cachedi_scsi_volume(options = {}) ⇒ Core::Response

Calls the CreateCachediSCSIVolume API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :gateway_arn - required - (String)
    • :volume_size_in_bytes - required - (Integer)
    • :snapshot_id - (String)
    • :target_name - required - (String)
    • :network_interface_id - required - (String)
    • :client_token - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :volume_arn - (String)
    • :target_arn - (String)



# File 'lib/aws/storage_gateway/client.rb', line 101

#create_snapshot(options = {}) ⇒ Core::Response

Calls the CreateSnapshot API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :volume_arn - required - (String)
    • :snapshot_description - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :volume_arn - (String)
    • :snapshot_id - (String)



# File 'lib/aws/storage_gateway/client.rb', line 116

#create_snapshot_from_volume_recovery_point(options = {}) ⇒ Core::Response

Calls the CreateSnapshotFromVolumeRecoveryPoint API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :volume_arn - required - (String)
    • :snapshot_description - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :snapshot_id - (String)
    • :volume_arn - (String)
    • :volume_recovery_point_time - (String)



# File 'lib/aws/storage_gateway/client.rb', line 127

#create_storedi_scsi_volume(options = {}) ⇒ Core::Response

Calls the CreateStorediSCSIVolume API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :gateway_arn - required - (String)
    • :disk_id - required - (String)
    • :snapshot_id - (String)
    • :preserve_existing_data - required - (Boolean)
    • :target_name - required - (String)
    • :network_interface_id - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :volume_arn - (String)
    • :volume_size_in_bytes - (Integer)
    • :target_arn - (String)



# File 'lib/aws/storage_gateway/client.rb', line 139

#delete_bandwidth_rate_limit(options = {}) ⇒ Core::Response

Calls the DeleteBandwidthRateLimit API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :gateway_arn - required - (String)
    • :bandwidth_type - required - (String) Valid values include:
      • UPLOAD
      • DOWNLOAD
      • ALL

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :gateway_arn - (String)



# File 'lib/aws/storage_gateway/client.rb', line 155

#delete_chap_credentials(options = {}) ⇒ Core::Response

Calls the DeleteChapCredentials API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :target_arn - required - (String)
    • :initiator_name - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :target_arn - (String)
    • :initiator_name - (String)



# File 'lib/aws/storage_gateway/client.rb', line 168

#delete_gateway(options = {}) ⇒ Core::Response

Calls the DeleteGateway API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :gateway_arn - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :gateway_arn - (String)



# File 'lib/aws/storage_gateway/client.rb', line 179

#delete_snapshot_schedule(options = {}) ⇒ Core::Response

Calls the DeleteSnapshotSchedule API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :volume_arn - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :volume_arn - (String)



# File 'lib/aws/storage_gateway/client.rb', line 188

#delete_volume(options = {}) ⇒ Core::Response

Calls the DeleteVolume API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :volume_arn - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :volume_arn - (String)



# File 'lib/aws/storage_gateway/client.rb', line 197

#describe_bandwidth_rate_limit(options = {}) ⇒ Core::Response

Calls the DescribeBandwidthRateLimit API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :gateway_arn - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :gateway_arn - (String)
    • :average_upload_rate_limit_in_bits_per_sec - (Integer)
    • :average_download_rate_limit_in_bits_per_sec - (Integer)



# File 'lib/aws/storage_gateway/client.rb', line 206

#describe_cache(options = {}) ⇒ Core::Response

Calls the DescribeCache API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :gateway_arn - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :gateway_arn - (String)
    • :disk_ids - (Array)
    • :cache_allocated_in_bytes - (Integer)
    • :cache_used_percentage - (Numeric)
    • :cache_dirty_percentage - (Numeric)
    • :cache_hit_percentage - (Numeric)
    • :cache_miss_percentage - (Numeric)



# File 'lib/aws/storage_gateway/client.rb', line 217

#describe_cachedi_scsi_volumes(options = {}) ⇒ Core::Response

Calls the DescribeCachediSCSIVolumes API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :volume_ar_ns - required - (Array)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :cachedi_scsi_volumes - (Array)
      • :volume_arn - (String)
      • :volume_id - (String)
      • :volume_type - (String)
      • :volume_status - (String)
      • :volume_size_in_bytes - (Integer)
      • :volume_progress - (Numeric)
      • :source_snapshot_id - (String)
      • :volumei_scsi_attributes - (Hash)
      • :target_arn - (String)
      • :network_interface_id - (String)
      • :network_interface_port - (Integer)
      • :lun_number - (Integer)
      • :chap_enabled - (Boolean)



# File 'lib/aws/storage_gateway/client.rb', line 232

#describe_chap_credentials(options = {}) ⇒ Core::Response

Calls the DescribeChapCredentials API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :target_arn - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :chap_credentials - (Array)
      • :target_arn - (String)
      • :secret_to_authenticate_initiator - (String)
      • :initiator_name - (String)
      • :secret_to_authenticate_target - (String)



# File 'lib/aws/storage_gateway/client.rb', line 254

#describe_gateway_information(options = {}) ⇒ Core::Response

Calls the DescribeGatewayInformation API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :gateway_arn - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :gateway_arn - (String)
    • :gateway_id - (String)
    • :gateway_timezone - (String)
    • :gateway_state - (String)
    • :gateway_network_interfaces - (Array)
      • :ipv_4_address - (String)
      • :mac_address - (String)
      • :ipv_6_address - (String)
    • :gateway_type - (String)
    • :next_update_availability_date - (String)



# File 'lib/aws/storage_gateway/client.rb', line 267

#describe_maintenance_start_time(options = {}) ⇒ Core::Response

Calls the DescribeMaintenanceStartTime API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :gateway_arn - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :gateway_arn - (String)
    • :hour_of_day - (Integer)
    • :minute_of_hour - (Integer)
    • :day_of_week - (Integer)
    • :timezone - (String)



# File 'lib/aws/storage_gateway/client.rb', line 285

#describe_snapshot_schedule(options = {}) ⇒ Core::Response

Calls the DescribeSnapshotSchedule API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :volume_arn - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :volume_arn - (String)
    • :start_at - (Integer)
    • :recurrence_in_hours - (Integer)
    • :description - (String)
    • :timezone - (String)



# File 'lib/aws/storage_gateway/client.rb', line 298

#describe_storedi_scsi_volumes(options = {}) ⇒ Core::Response

Calls the DescribeStorediSCSIVolumes API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :volume_ar_ns - required - (Array)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :storedi_scsi_volumes - (Array)
      • :volume_arn - (String)
      • :volume_id - (String)
      • :volume_type - (String)
      • :volume_status - (String)
      • :volume_size_in_bytes - (Integer)
      • :volume_progress - (Numeric)
      • :volume_disk_id - (String)
      • :source_snapshot_id - (String)
      • :preserved_existing_data - (Boolean)
      • :volumei_scsi_attributes - (Hash)
      • :target_arn - (String)
      • :network_interface_id - (String)
      • :network_interface_port - (Integer)
      • :lun_number - (Integer)
      • :chap_enabled - (Boolean)



# File 'lib/aws/storage_gateway/client.rb', line 311

#describe_upload_buffer(options = {}) ⇒ Core::Response

Calls the DescribeUploadBuffer API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :gateway_arn - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :gateway_arn - (String)
    • :disk_ids - (Array)
    • :upload_buffer_used_in_bytes - (Integer)
    • :upload_buffer_allocated_in_bytes - (Integer)



# File 'lib/aws/storage_gateway/client.rb', line 335

#describe_working_storage(options = {}) ⇒ Core::Response

Calls the DescribeWorkingStorage API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :gateway_arn - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :gateway_arn - (String)
    • :disk_ids - (Array)
    • :working_storage_used_in_bytes - (Integer)
    • :working_storage_allocated_in_bytes - (Integer)



# File 'lib/aws/storage_gateway/client.rb', line 347

#list_gateways(options = {}) ⇒ Core::Response

Calls the ListGateways API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :marker - (String)
    • :limit - (Integer)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :gateways - (Array)
      • :gateway_arn - (String)
    • :marker - (String)



# File 'lib/aws/storage_gateway/client.rb', line 359

#list_local_disks(options = {}) ⇒ Core::Response

Calls the ListLocalDisks API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :gateway_arn - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :gateway_arn - (String)
    • :disks - (Array)
      • :disk_id - (String)
      • :disk_path - (String)
      • :disk_node - (String)
      • :disk_size_in_bytes - (Integer)
      • :disk_allocation_type - (String)
      • :disk_allocation_resource - (String)



# File 'lib/aws/storage_gateway/client.rb', line 371

#list_volume_recovery_points(options = {}) ⇒ Core::Response

Calls the ListVolumeRecoveryPoints API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :gateway_arn - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :gateway_arn - (String)
    • :volume_recovery_point_infos - (Array)
      • :volume_arn - (String)
      • :volume_size_in_bytes - (Integer)
      • :volume_usage_in_bytes - (Integer)
      • :volume_recovery_point_time - (String)



# File 'lib/aws/storage_gateway/client.rb', line 387

#list_volumes(options = {}) ⇒ Core::Response

Calls the ListVolumes API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :gateway_arn - required - (String)
    • :marker - (String)
    • :limit - (Integer)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :gateway_arn - (String)
    • :marker - (String)
    • :volume_infos - (Array)
      • :volume_arn - (String)
      • :volume_type - (String)



# File 'lib/aws/storage_gateway/client.rb', line 401

#shutdown_gateway(options = {}) ⇒ Core::Response

Calls the ShutdownGateway API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :gateway_arn - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :gateway_arn - (String)



# File 'lib/aws/storage_gateway/client.rb', line 416

#start_gateway(options = {}) ⇒ Core::Response

Calls the StartGateway API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :gateway_arn - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :gateway_arn - (String)



# File 'lib/aws/storage_gateway/client.rb', line 425

#update_bandwidth_rate_limit(options = {}) ⇒ Core::Response

Calls the UpdateBandwidthRateLimit API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :gateway_arn - required - (String)
    • :average_upload_rate_limit_in_bits_per_sec - (Integer)
    • :average_download_rate_limit_in_bits_per_sec - (Integer)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :gateway_arn - (String)



# File 'lib/aws/storage_gateway/client.rb', line 434

#update_chap_credentials(options = {}) ⇒ Core::Response

Calls the UpdateChapCredentials API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :target_arn - required - (String)
    • :secret_to_authenticate_initiator - required - (String)
    • :initiator_name - required - (String)
    • :secret_to_authenticate_target - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :target_arn - (String)
    • :initiator_name - (String)



# File 'lib/aws/storage_gateway/client.rb', line 445

#update_gateway_information(options = {}) ⇒ Core::Response

Calls the UpdateGatewayInformation API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :gateway_arn - required - (String)
    • :gateway_name - (String)
    • :gateway_timezone - (String) Valid values include:
      • GMT-12:00
      • GMT-11:00
      • GMT-10:00
      • GMT-9:00
      • GMT-8:00
      • GMT-7:00
      • GMT-6:00
      • GMT-5:00
      • GMT-4:00
      • GMT-3:30
      • GMT-3:00
      • GMT-2:00
      • GMT-1:00
      • GMT
      • GMT1:00+
      • GMT2:00+
      • GMT3:00+
      • GMT3:30+
      • GMT4:00+
      • GMT4:30+
      • GMT5:00+
      • GMT5:30+
      • GMT5:45+
      • GMT6:00+
      • GMT7:00+
      • GMT8:00+
      • GMT9:00+
      • GMT9:30+
      • GMT10:00+
      • GMT11:00+
      • GMT12:00+

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :gateway_arn - (String)



# File 'lib/aws/storage_gateway/client.rb', line 458

#update_gateway_software_now(options = {}) ⇒ Core::Response

Calls the UpdateGatewaySoftwareNow API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :gateway_arn - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :gateway_arn - (String)



# File 'lib/aws/storage_gateway/client.rb', line 500

#update_maintenance_start_time(options = {}) ⇒ Core::Response

Calls the UpdateMaintenanceStartTime API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :gateway_arn - required - (String)
    • :hour_of_day - required - (Integer)
    • :minute_of_hour - required - (Integer)
    • :day_of_week - required - (Integer)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :gateway_arn - (String)



# File 'lib/aws/storage_gateway/client.rb', line 509

#update_snapshot_schedule(options = {}) ⇒ Core::Response

Calls the UpdateSnapshotSchedule API operation.

Parameters:

  • options (Hash) (defaults to: {}) —
    • :volume_arn - required - (String)
    • :start_at - required - (Integer)
    • :recurrence_in_hours - required - (Integer)
    • :description - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :volume_arn - (String)



# File 'lib/aws/storage_gateway/client.rb', line 521