ExAws.StorageGateway.Core

AWS Storage Gateway

AWS Storage Gateway Service

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

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

Source

Summary

activate_gateway!(client, input)

Same as activate_gateway/2 but raise on error

activate_gateway(client, input)

ActivateGateway

add_cache!(client, input)

Same as add_cache/2 but raise on error

add_cache(client, input)

AddCache

add_upload_buffer!(client, input)

Same as add_upload_buffer/2 but raise on error

add_upload_buffer(client, input)

AddUploadBuffer

add_working_storage!(client, input)

Same as add_working_storage/2 but raise on error

add_working_storage(client, input)

AddWorkingStorage

cancel_archival!(client, input)

Same as cancel_archival/2 but raise on error

cancel_archival(client, input)

CancelArchival

cancel_retrieval!(client, input)

Same as cancel_retrieval/2 but raise on error

cancel_retrieval(client, input)

CancelRetrieval

create_cachedi_scsi_volume!(client, input)

Same as create_cachedi_scsi_volume/2 but raise on error

create_cachedi_scsi_volume(client, input)

CreateCachediSCSIVolume

create_snapshot!(client, input)

Same as create_snapshot/2 but raise on error

create_snapshot(client, input)

CreateSnapshot

create_snapshot_from_volume_recovery_point!(client, input)

Same as create_snapshot_from_volume_recovery_point/2 but raise on error

create_snapshot_from_volume_recovery_point(client, input)

CreateSnapshotFromVolumeRecoveryPoint

create_storedi_scsi_volume!(client, input)

Same as create_storedi_scsi_volume/2 but raise on error

create_storedi_scsi_volume(client, input)

CreateStorediSCSIVolume

create_tapes!(client, input)

Same as create_tapes/2 but raise on error

create_tapes(client, input)

CreateTapes

delete_bandwidth_rate_limit!(client, input)

Same as delete_bandwidth_rate_limit/2 but raise on error

delete_bandwidth_rate_limit(client, input)

DeleteBandwidthRateLimit

delete_chap_credentials!(client, input)

Same as delete_chap_credentials/2 but raise on error

delete_chap_credentials(client, input)

DeleteChapCredentials

delete_gateway!(client, input)

Same as delete_gateway/2 but raise on error

delete_gateway(client, input)

DeleteGateway

delete_snapshot_schedule!(client, input)

Same as delete_snapshot_schedule/2 but raise on error

delete_snapshot_schedule(client, input)

DeleteSnapshotSchedule

delete_tape!(client, input)

Same as delete_tape/2 but raise on error

delete_tape(client, input)

DeleteTape

delete_tape_archive!(client, input)

Same as delete_tape_archive/2 but raise on error

delete_tape_archive(client, input)

DeleteTapeArchive

delete_volume!(client, input)

Same as delete_volume/2 but raise on error

delete_volume(client, input)

DeleteVolume

describe_bandwidth_rate_limit!(client, input)

Same as describe_bandwidth_rate_limit/2 but raise on error

describe_bandwidth_rate_limit(client, input)

DescribeBandwidthRateLimit

describe_cache!(client, input)

Same as describe_cache/2 but raise on error

describe_cache(client, input)

DescribeCache

describe_cachedi_scsi_volumes!(client, input)

Same as describe_cachedi_scsi_volumes/2 but raise on error

describe_cachedi_scsi_volumes(client, input)

DescribeCachediSCSIVolumes

describe_chap_credentials!(client, input)

Same as describe_chap_credentials/2 but raise on error

describe_chap_credentials(client, input)

DescribeChapCredentials

describe_gateway_information!(client, input)

Same as describe_gateway_information/2 but raise on error

describe_gateway_information(client, input)

DescribeGatewayInformation

describe_maintenance_start_time!(client, input)

Same as describe_maintenance_start_time/2 but raise on error

describe_maintenance_start_time(client, input)

DescribeMaintenanceStartTime

describe_snapshot_schedule!(client, input)

Same as describe_snapshot_schedule/2 but raise on error

describe_snapshot_schedule(client, input)

DescribeSnapshotSchedule

describe_storedi_scsi_volumes!(client, input)

Same as describe_storedi_scsi_volumes/2 but raise on error

describe_storedi_scsi_volumes(client, input)

DescribeStorediSCSIVolumes

describe_tape_archives!(client, input)

Same as describe_tape_archives/2 but raise on error

describe_tape_archives(client, input)

DescribeTapeArchives

describe_tape_recovery_points!(client, input)

Same as describe_tape_recovery_points/2 but raise on error

describe_tape_recovery_points(client, input)

DescribeTapeRecoveryPoints

describe_tapes!(client, input)

Same as describe_tapes/2 but raise on error

describe_tapes(client, input)

DescribeTapes

describe_upload_buffer!(client, input)

Same as describe_upload_buffer/2 but raise on error

describe_upload_buffer(client, input)

DescribeUploadBuffer

describe_vtl_devices!(client, input)

Same as describe_vtl_devices/2 but raise on error

describe_vtl_devices(client, input)

DescribeVTLDevices

describe_working_storage!(client, input)

Same as describe_working_storage/2 but raise on error

describe_working_storage(client, input)

DescribeWorkingStorage

disable_gateway!(client, input)

Same as disable_gateway/2 but raise on error

disable_gateway(client, input)

DisableGateway

list_gateways!(client, input)

Same as list_gateways/2 but raise on error

list_gateways(client, input)

ListGateways

list_local_disks!(client, input)

Same as list_local_disks/2 but raise on error

list_local_disks(client, input)

ListLocalDisks

list_volume_initiators!(client, input)

Same as list_volume_initiators/2 but raise on error

list_volume_initiators(client, input)

ListVolumeInitiators

list_volume_recovery_points!(client, input)

Same as list_volume_recovery_points/2 but raise on error

list_volume_recovery_points(client, input)

ListVolumeRecoveryPoints

list_volumes!(client, input)

Same as list_volumes/2 but raise on error

list_volumes(client, input)

ListVolumes

reset_cache!(client, input)

Same as reset_cache/2 but raise on error

reset_cache(client, input)

ResetCache

retrieve_tape_archive!(client, input)

Same as retrieve_tape_archive/2 but raise on error

retrieve_tape_archive(client, input)

RetrieveTapeArchive

retrieve_tape_recovery_point!(client, input)

Same as retrieve_tape_recovery_point/2 but raise on error

retrieve_tape_recovery_point(client, input)

RetrieveTapeRecoveryPoint

shutdown_gateway!(client, input)

Same as shutdown_gateway/2 but raise on error

shutdown_gateway(client, input)

ShutdownGateway

start_gateway!(client, input)

Same as start_gateway/2 but raise on error

start_gateway(client, input)

StartGateway

update_bandwidth_rate_limit!(client, input)

Same as update_bandwidth_rate_limit/2 but raise on error

update_bandwidth_rate_limit(client, input)

UpdateBandwidthRateLimit

update_chap_credentials!(client, input)

Same as update_chap_credentials/2 but raise on error

update_chap_credentials(client, input)

UpdateChapCredentials

update_gateway_information!(client, input)

Same as update_gateway_information/2 but raise on error

update_gateway_information(client, input)

UpdateGatewayInformation

update_gateway_software_now!(client, input)

Same as update_gateway_software_now/2 but raise on error

update_gateway_software_now(client, input)

UpdateGatewaySoftwareNow

update_maintenance_start_time!(client, input)

Same as update_maintenance_start_time/2 but raise on error

update_maintenance_start_time(client, input)

UpdateMaintenanceStartTime

update_snapshot_schedule!(client, input)

Same as update_snapshot_schedule/2 but raise on error

update_snapshot_schedule(client, input)

UpdateSnapshotSchedule

update_vtl_device_type!(client, input)

Same as update_vtl_device_type/2 but raise on error

update_vtl_device_type(client, input)

UpdateVTLDeviceType

Types

add_upload_buffer_output :: [{:gateway_arn, gateway_arn}]

hour_of_day :: integer

disable_gateway_input :: [{:gateway_arn, gateway_arn}]

activation_key :: binary

describe_tape_recovery_points_output :: [gateway_arn: gateway_arn, marker: marker, tape_recovery_point_infos: tape_recovery_point_infos]

reset_cache_input :: [{:gateway_arn, gateway_arn}]

delete_chap_credentials_output :: [initiator_name: iqn_name, target_arn: target_arn]

describe_cache_output :: [cache_allocated_in_bytes: long, cache_dirty_percentage: double, cache_hit_percentage: double, cache_miss_percentage: double, cache_used_percentage: double, disk_ids: disk_ids, gateway_arn: gateway_arn]

create_snapshot_output :: [snapshot_id: snapshot_id, volume_arn: volume_arn]

start_gateway_input :: [{:gateway_arn, gateway_arn}]

cancel_retrieval_output :: [{:tape_arn, tape_arn}]

tape_drive_type :: binary

disk :: [disk_allocation_resource: binary, disk_allocation_type: disk_allocation_type, disk_id: disk_id, disk_node: binary, disk_path: binary, disk_size_in_bytes: long, disk_status: binary]

region_id :: binary

add_cache_output :: [{:gateway_arn, gateway_arn}]

delete_gateway_output :: [{:gateway_arn, gateway_arn}]

recurrence_in_hours :: integer

tapes :: [tape]

shutdown_gateway_input :: [{:gateway_arn, gateway_arn}]

target_name :: binary

disks :: [disk]

device_type :: binary

storage_gateway_error :: [error_code: error_code, error_details: error_details]

day_of_week :: integer

describe_snapshot_schedule_output :: [description: description, recurrence_in_hours: recurrence_in_hours, start_at: hour_of_day, timezone: gateway_timezone, volume_arn: volume_arn]

describe_upload_buffer_output :: [disk_ids: disk_ids, gateway_arn: gateway_arn, upload_buffer_allocated_in_bytes: long, upload_buffer_used_in_bytes: long]

chap_secret :: binary

create_snapshot_from_volume_recovery_point_output :: [snapshot_id: snapshot_id, volume_arn: volume_arn, volume_recovery_point_time: binary]

cancel_retrieval_input :: [gateway_arn: gateway_arn, tape_arn: tape_arn]

describe_maintenance_start_time_output :: [day_of_week: day_of_week, gateway_arn: gateway_arn, hour_of_day: hour_of_day, minute_of_hour: minute_of_hour, timezone: gateway_timezone]

client_token :: binary

describe_tape_archives_output :: [marker: marker, tape_archives: tape_archives]

delete_bandwidth_rate_limit_input :: [bandwidth_type: bandwidth_type, gateway_arn: gateway_arn]

describe_vtl_devices_input :: [gateway_arn: gateway_arn, limit: positive_int_object, marker: marker, vtl_device_ar_ns: vtl_device_ar_ns]

bandwidth_type :: binary

create_storedi_scsi_volume_output :: [target_arn: target_arn, volume_arn: volume_arn, volume_size_in_bytes: long]

cachedi_scsi_volume :: [source_snapshot_id: snapshot_id, volume_arn: volume_arn, volume_id: volume_id, volume_progress: double_object, volume_size_in_bytes: long, volume_status: volume_status, volume_type: volume_type, volumei_scsi_attributes: volumei_scsi_attributes]

devicei_scsi_attributes :: [chap_enabled: boolean, network_interface_id: network_interface_id, network_interface_port: integer, target_arn: target_arn]

vtl_device_arn :: binary

update_chap_credentials_output :: [initiator_name: iqn_name, target_arn: target_arn]

describe_working_storage_output :: [disk_ids: disk_ids, gateway_arn: gateway_arn, working_storage_allocated_in_bytes: long, working_storage_used_in_bytes: long]

gateway_info :: [gateway_arn: gateway_arn, gateway_operational_state: gateway_operational_state, gateway_type: gateway_type]

shutdown_gateway_output :: [{:gateway_arn, gateway_arn}]

description :: binary

create_snapshot_input :: [snapshot_description: snapshot_description, volume_arn: volume_arn]

chap_info :: [initiator_name: iqn_name, secret_to_authenticate_initiator: chap_secret, secret_to_authenticate_target: chap_secret, target_arn: target_arn]

update_chap_credentials_input :: [initiator_name: iqn_name, secret_to_authenticate_initiator: chap_secret, secret_to_authenticate_target: chap_secret, target_arn: target_arn]

error_code :: binary

gateway_arn :: binary

tape :: [progress: double_object, tape_arn: tape_arn, tape_barcode: tape_barcode, tape_size_in_bytes: tape_size, tape_status: tape_status, vtl_device: vtl_device_arn]

describe_vtl_devices_output :: [gateway_arn: gateway_arn, marker: marker, vtl_devices: vtl_devices]

double_object :: float

double :: float

snapshot_id :: binary

vtl_device_type :: binary

activate_gateway_input :: [activation_key: activation_key, gateway_name: gateway_name, gateway_region: region_id, gateway_timezone: gateway_timezone, gateway_type: gateway_type, medium_changer_type: medium_changer_type, tape_drive_type: tape_drive_type]

retrieve_tape_archive_input :: [gateway_arn: gateway_arn, tape_arn: tape_arn]

vtl_device_vendor :: binary

delete_chap_credentials_input :: [initiator_name: iqn_name, target_arn: target_arn]

describe_tapes_input :: [gateway_arn: gateway_arn, limit: positive_int_object, marker: marker, tape_ar_ns: tape_ar_ns]

long :: integer

tape_size :: integer

tape_barcode :: binary

volume_status :: binary

initiator :: binary

describe_bandwidth_rate_limit_output :: [average_download_rate_limit_in_bits_per_sec: bandwidth_download_rate_limit, average_upload_rate_limit_in_bits_per_sec: bandwidth_upload_rate_limit, gateway_arn: gateway_arn]

volume_id :: binary

error_details :: [{binary, binary}]

target_arn :: binary

update_snapshot_schedule_input :: [description: description, recurrence_in_hours: recurrence_in_hours, start_at: hour_of_day, volume_arn: volume_arn]

gateway_name :: binary

tape_status :: binary

add_cache_input :: [disk_ids: disk_ids, gateway_arn: gateway_arn]

delete_tape_output :: [{:tape_arn, tape_arn}]

internal_server_error :: [error: storage_gateway_error, message: binary]

describe_cache_input :: [{:gateway_arn, gateway_arn}]

describe_gateway_information_output :: [gateway_arn: gateway_arn, gateway_id: gateway_id, gateway_network_interfaces: gateway_network_interfaces, gateway_state: gateway_state, gateway_timezone: gateway_timezone, gateway_type: gateway_type, last_software_update: last_software_update, next_update_availability_date: next_update_availability_date]

create_cachedi_scsi_volume_input :: [client_token: client_token, gateway_arn: gateway_arn, network_interface_id: network_interface_id, snapshot_id: snapshot_id, target_name: target_name, volume_size_in_bytes: long]

list_volumes_output :: [gateway_arn: gateway_arn, marker: marker, volume_infos: volume_infos]

gateway_type :: binary

volume_arn :: binary

add_upload_buffer_input :: [disk_ids: disk_ids, gateway_arn: gateway_arn]

describe_tapes_output :: [marker: marker, tapes: tapes]

start_gateway_output :: [{:gateway_arn, gateway_arn}]

marker :: binary

disable_gateway_output :: [{:gateway_arn, gateway_arn}]

create_storedi_scsi_volume_input :: [disk_id: disk_id, gateway_arn: gateway_arn, network_interface_id: network_interface_id, preserve_existing_data: boolean, snapshot_id: snapshot_id, target_name: target_name]

delete_volume_output :: [{:volume_arn, volume_arn}]

gateway_id :: binary

create_tapes_input :: [client_token: client_token, gateway_arn: gateway_arn, num_tapes_to_create: num_tapes_to_create, tape_barcode_prefix: tape_barcode_prefix, tape_size_in_bytes: tape_size]

storedi_scsi_volume :: [preserved_existing_data: boolean, source_snapshot_id: snapshot_id, volume_arn: volume_arn, volume_disk_id: disk_id, volume_id: volume_id, volume_progress: double_object, volume_size_in_bytes: long, volume_status: volume_status, volume_type: volume_type, volumei_scsi_attributes: volumei_scsi_attributes]

iqn_name :: binary

volume_info :: [volume_arn: volume_arn, volume_type: volume_type]

gateway_state :: binary

cancel_archival_input :: [gateway_arn: gateway_arn, tape_arn: tape_arn]

update_vtl_device_type_input :: [device_type: device_type, vtl_device_arn: vtl_device_arn]

list_local_disks_output :: [disks: disks, gateway_arn: gateway_arn]

list_volume_recovery_points_output :: [gateway_arn: gateway_arn, volume_recovery_point_infos: volume_recovery_point_infos]

delete_gateway_input :: [{:gateway_arn, gateway_arn}]

time :: integer

reset_cache_output :: [{:gateway_arn, gateway_arn}]

delete_tape_input :: [gateway_arn: gateway_arn, tape_arn: tape_arn]

tape_recovery_point_info :: [tape_arn: tape_arn, tape_recovery_point_time: time, tape_size_in_bytes: tape_size, tape_status: tape_recovery_point_status]

volume_type :: binary

gateway_timezone :: binary

update_bandwidth_rate_limit_input :: [average_download_rate_limit_in_bits_per_sec: bandwidth_download_rate_limit, average_upload_rate_limit_in_bits_per_sec: bandwidth_upload_rate_limit, gateway_arn: gateway_arn]

volume_recovery_point_info :: [volume_arn: volume_arn, volume_recovery_point_time: binary, volume_size_in_bytes: long, volume_usage_in_bytes: long]

list_local_disks_input :: [{:gateway_arn, gateway_arn}]

add_working_storage_input :: [disk_ids: disk_ids, gateway_arn: gateway_arn]

create_tapes_output :: [{:tape_ar_ns, tape_ar_ns}]

tape_archive :: [completion_time: time, retrieved_to: gateway_arn, tape_arn: tape_arn, tape_barcode: tape_barcode, tape_size_in_bytes: tape_size, tape_status: tape_archive_status]

activate_gateway_output :: [{:gateway_arn, gateway_arn}]

delete_volume_input :: [{:volume_arn, volume_arn}]

list_gateways_output :: [gateways: gateways, marker: marker]

update_gateway_information_input :: [gateway_arn: gateway_arn, gateway_name: gateway_name, gateway_timezone: gateway_timezone]

minute_of_hour :: integer

cancel_archival_output :: [{:tape_arn, tape_arn}]

list_volumes_input :: [gateway_arn: gateway_arn, limit: positive_int_object, marker: marker]

positive_int_object :: integer

disk_id :: binary

vtl_device :: [devicei_scsi_attributes: devicei_scsi_attributes, vtl_device_arn: vtl_device_arn, vtl_device_product_identifier: vtl_device_product_identifier, vtl_device_type: vtl_device_type, vtl_device_vendor: vtl_device_vendor]

volumei_scsi_attributes :: [chap_enabled: boolean, lun_number: positive_int_object, network_interface_id: network_interface_id, network_interface_port: integer, target_arn: target_arn]

tape_arn :: binary

network_interface :: [ipv4_address: binary, ipv6_address: binary, mac_address: binary]

num_tapes_to_create :: integer

update_maintenance_start_time_input :: [day_of_week: day_of_week, gateway_arn: gateway_arn, hour_of_day: hour_of_day, minute_of_hour: minute_of_hour]

Functions

activate_gateway(client, input)

Specs:

  • activate_gateway(client :: ExAws.StorageGateway.t, input :: activate_gateway_input) :: ExAws.Request.JSON.response_t

ActivateGateway

This operation activates the gateway you previously deployed on your host. For more information, see Activate the AWS Storage Gateway. In the activation process, you specify information such as the region you want to use for storing snapshots, 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.

Note:You must turn on the gateway VM before you can activate your gateway.

Source
activate_gateway!(client, input)

Specs:

  • activate_gateway!(client :: ExAws.StorageGateway.t, input :: activate_gateway_input) :: ExAws.Request.JSON.success_t | no_return

Same as activate_gateway/2 but raise on error.

Source
add_cache(client, input)

Specs:

  • add_cache(client :: ExAws.StorageGateway.t, input :: add_cache_input) :: ExAws.Request.JSON.response_t

AddCache

This operation configures one or more gateway local disks as cache for a cached-volume gateway. This operation is supported only for the gateway-cached volume architecture (see Storage Gateway Concepts).

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.

Source
add_cache!(client, input)

Specs:

  • add_cache!(client :: ExAws.StorageGateway.t, input :: add_cache_input) :: ExAws.Request.JSON.success_t | no_return

Same as add_cache/2 but raise on error.

Source
add_upload_buffer(client, input)

Specs:

  • add_upload_buffer(client :: ExAws.StorageGateway.t, input :: add_upload_buffer_input) :: ExAws.Request.JSON.response_t

AddUploadBuffer

This operation configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures.

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.

Source
add_upload_buffer!(client, input)

Specs:

  • add_upload_buffer!(client :: ExAws.StorageGateway.t, input :: add_upload_buffer_input) :: ExAws.Request.JSON.success_t | no_return

Same as add_upload_buffer/2 but raise on error.

Source
add_working_storage(client, input)

Specs:

AddWorkingStorage

This operation configures one or more gateway local disks as working storage for a gateway. This operation is supported only for the gateway-stored volume architecture. This operation is deprecated method in cached-volumes API version (20120630). Use AddUploadBuffer instead.

Note:Working storage is also referred to as upload buffer. You can also use the AddUploadBuffer operation to add upload buffer to a stored-volume gateway.

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.

Source
add_working_storage!(client, input)

Specs:

  • add_working_storage!(client :: ExAws.StorageGateway.t, input :: add_working_storage_input) :: ExAws.Request.JSON.success_t | no_return

Same as add_working_storage/2 but raise on error.

Source
cancel_archival(client, input)

Specs:

  • cancel_archival(client :: ExAws.StorageGateway.t, input :: cancel_archival_input) :: ExAws.Request.JSON.response_t

CancelArchival

Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.

Source
cancel_archival!(client, input)

Specs:

  • cancel_archival!(client :: ExAws.StorageGateway.t, input :: cancel_archival_input) :: ExAws.Request.JSON.success_t | no_return

Same as cancel_archival/2 but raise on error.

Source
cancel_retrieval(client, input)

Specs:

  • cancel_retrieval(client :: ExAws.StorageGateway.t, input :: cancel_retrieval_input) :: ExAws.Request.JSON.response_t

CancelRetrieval

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.

Source
cancel_retrieval!(client, input)

Specs:

  • cancel_retrieval!(client :: ExAws.StorageGateway.t, input :: cancel_retrieval_input) :: ExAws.Request.JSON.success_t | no_return

Same as cancel_retrieval/2 but raise on error.

Source
create_cachedi_scsi_volume(client, input)

Specs:

CreateCachediSCSIVolume

This operation creates a cached volume on a specified cached gateway. This operation is supported only for the gateway-cached volume architecture.

Note:Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway. In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, AWS Storage Gateway creates the volume and returns information about it 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.

Source
create_cachedi_scsi_volume!(client, input)

Specs:

Same as create_cachedi_scsi_volume/2 but raise on error.

Source
create_snapshot(client, input)

Specs:

  • create_snapshot(client :: ExAws.StorageGateway.t, input :: create_snapshot_input) :: ExAws.Request.JSON.response_t

CreateSnapshot

This operation initiates a snapshot of a volume.

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

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

Note:To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the EC2 API reference.

Source
create_snapshot!(client, input)

Specs:

  • create_snapshot!(client :: ExAws.StorageGateway.t, input :: create_snapshot_input) :: ExAws.Request.JSON.success_t | no_return

Same as create_snapshot/2 but raise on error.

Source
create_snapshot_from_volume_recovery_point(client, input)

Specs:

CreateSnapshotFromVolumeRecoveryPoint

This operation initiates a snapshot of a gateway from a volume recovery point. This operation is supported only for the gateway-cached volume architecture (see ).

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 gateway-cached volumes, 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 AWS Storage Gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.

Note: To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference.

Source
create_snapshot_from_volume_recovery_point!(client, input)

Specs:

Same as create_snapshot_from_volume_recovery_point/2 but raise on error.

Source
create_storedi_scsi_volume(client, input)

Specs:

CreateStorediSCSIVolume

This operation creates a volume on a specified gateway. This operation is supported only for the gateway-stored volume architecture.

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, AWS Storage 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.

Source
create_storedi_scsi_volume!(client, input)

Specs:

Same as create_storedi_scsi_volume/2 but raise on error.

Source
create_tapes(client, input)

Specs:

  • create_tapes(client :: ExAws.StorageGateway.t, input :: create_tapes_input) :: ExAws.Request.JSON.response_t

CreateTapes

Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes.

Note:Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache operation to add cache storage to a gateway.

Source
create_tapes!(client, input)

Specs:

  • create_tapes!(client :: ExAws.StorageGateway.t, input :: create_tapes_input) :: ExAws.Request.JSON.success_t | no_return

Same as create_tapes/2 but raise on error.

Source
delete_bandwidth_rate_limit(client, input)

Specs:

DeleteBandwidthRateLimit

This operation 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.

Source
delete_bandwidth_rate_limit!(client, input)

Specs:

Same as delete_bandwidth_rate_limit/2 but raise on error.

Source
delete_chap_credentials(client, input)

Specs:

DeleteChapCredentials

This operation deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.

Source
delete_chap_credentials!(client, input)

Specs:

Same as delete_chap_credentials/2 but raise on error.

Source
delete_gateway(client, input)

Specs:

  • delete_gateway(client :: ExAws.StorageGateway.t, input :: delete_gateway_input) :: ExAws.Request.JSON.response_t

DeleteGateway

This operation 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 AWS Storage Gateway Detail Page.

**

Source
delete_gateway!(client, input)

Specs:

  • delete_gateway!(client :: ExAws.StorageGateway.t, input :: delete_gateway_input) :: ExAws.Request.JSON.success_t | no_return

Same as delete_gateway/2 but raise on error.

Source
delete_snapshot_schedule(client, input)

Specs:

DeleteSnapshotSchedule

This operation deletes a snapshot of a volume.

You can take snapshots of your gateway volumes on a scheduled or ad-hoc basis. This API enables you to delete a snapshot schedule for a volume. For more information, see Working with Snapshots. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN).

Note: To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference.

Source
delete_snapshot_schedule!(client, input)

Specs:

Same as delete_snapshot_schedule/2 but raise on error.

Source
delete_tape(client, input)

Specs:

  • delete_tape(client :: ExAws.StorageGateway.t, input :: delete_tape_input) :: ExAws.Request.JSON.response_t

DeleteTape

Deletes the specified virtual tape.

Source
delete_tape!(client, input)

Specs:

  • delete_tape!(client :: ExAws.StorageGateway.t, input :: delete_tape_input) :: ExAws.Request.JSON.success_t | no_return

Same as delete_tape/2 but raise on error.

Source
delete_tape_archive(client, input)

Specs:

DeleteTapeArchive

Deletes the specified virtual tape from the virtual tape shelf (VTS).

Source
delete_tape_archive!(client, input)

Specs:

  • delete_tape_archive!(client :: ExAws.StorageGateway.t, input :: delete_tape_archive_input) :: ExAws.Request.JSON.success_t | no_return

Same as delete_tape_archive/2 but raise on error.

Source
delete_volume(client, input)

Specs:

  • delete_volume(client :: ExAws.StorageGateway.t, input :: delete_volume_input) :: ExAws.Request.JSON.response_t

DeleteVolume

This operation delete the specified gateway volume that you previously created using the CreateStorediSCSIVolume API. For gateway-stored volumes, 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 gateway 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.

Source
delete_volume!(client, input)

Specs:

  • delete_volume!(client :: ExAws.StorageGateway.t, input :: delete_volume_input) :: ExAws.Request.JSON.success_t | no_return

Same as delete_volume/2 but raise on error.

Source
describe_bandwidth_rate_limit(client, input)

Specs:

DescribeBandwidthRateLimit

This operation 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 only 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.

Source
describe_bandwidth_rate_limit!(client, input)

Specs:

Same as describe_bandwidth_rate_limit/2 but raise on error.

Source
describe_cache(client, input)

Specs:

  • describe_cache(client :: ExAws.StorageGateway.t, input :: describe_cache_input) :: ExAws.Request.JSON.response_t

DescribeCache

This operation returns information about the cache of a gateway. This operation is supported only for the gateway-cached volume architecture.

The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.

Source
describe_cache!(client, input)

Specs:

  • describe_cache!(client :: ExAws.StorageGateway.t, input :: describe_cache_input) :: ExAws.Request.JSON.success_t | no_return

Same as describe_cache/2 but raise on error.

Source
describe_cachedi_scsi_volumes(client, input)

Specs:

DescribeCachediSCSIVolumes

This operation returns a description of the gateway volumes specified in the request. This operation is supported only for the gateway-cached volume architecture.

The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).

Source
describe_cachedi_scsi_volumes!(client, input)

Specs:

Same as describe_cachedi_scsi_volumes/2 but raise on error.

Source
describe_chap_credentials(client, input)

Specs:

DescribeChapCredentials

This operation returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.

Source
describe_chap_credentials!(client, input)

Specs:

Same as describe_chap_credentials/2 but raise on error.

Source
describe_gateway_information(client, input)

Specs:

DescribeGatewayInformation

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

Source
describe_gateway_information!(client, input)

Specs:

Same as describe_gateway_information/2 but raise on error.

Source
describe_maintenance_start_time(client, input)

Specs:

DescribeMaintenanceStartTime

This operation returns your gateway’s weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway’s time zone.

Source
describe_maintenance_start_time!(client, input)

Specs:

Same as describe_maintenance_start_time/2 but raise on error.

Source
describe_snapshot_schedule(client, input)

Specs:

DescribeSnapshotSchedule

This operation describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume.

Source
describe_snapshot_schedule!(client, input)

Specs:

Same as describe_snapshot_schedule/2 but raise on error.

Source
describe_storedi_scsi_volumes(client, input)

Specs:

DescribeStorediSCSIVolumes

This operation 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 Amazon Storage Gateway returns volume information sorted by volume ARNs.

Source
describe_storedi_scsi_volumes!(client, input)

Specs:

Same as describe_storedi_scsi_volumes/2 but raise on error.

Source
describe_tape_archives(client, input)

Specs:

DescribeTapeArchives

Returns a description of specified virtual tapes in the virtual tape shelf (VTS).

If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.

Source
describe_tape_archives!(client, input)

Specs:

  • describe_tape_archives!(client :: ExAws.StorageGateway.t, input :: describe_tape_archives_input) :: ExAws.Request.JSON.success_t | no_return

Same as describe_tape_archives/2 but raise on error.

Source
describe_tape_recovery_points(client, input)

Specs:

DescribeTapeRecoveryPoints

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

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.

Source
describe_tape_recovery_points!(client, input)

Specs:

Same as describe_tape_recovery_points/2 but raise on error.

Source
describe_tapes(client, input)

Specs:

  • describe_tapes(client :: ExAws.StorageGateway.t, input :: describe_tapes_input) :: ExAws.Request.JSON.response_t

DescribeTapes

Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes associated with the specified gateway.

Source
describe_tapes!(client, input)

Specs:

  • describe_tapes!(client :: ExAws.StorageGateway.t, input :: describe_tapes_input) :: ExAws.Request.JSON.success_t | no_return

Same as describe_tapes/2 but raise on error.

Source
describe_upload_buffer(client, input)

Specs:

DescribeUploadBuffer

This operation returns information about the upload buffer of a gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures.

The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.

Source
describe_upload_buffer!(client, input)

Specs:

  • describe_upload_buffer!(client :: ExAws.StorageGateway.t, input :: describe_upload_buffer_input) :: ExAws.Request.JSON.success_t | no_return

Same as describe_upload_buffer/2 but raise on error.

Source
describe_vtl_devices(client, input)

Specs:

DescribeVTLDevices

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

The list of VTL devices must be from one gateway.

Source
describe_vtl_devices!(client, input)

Specs:

  • describe_vtl_devices!(client :: ExAws.StorageGateway.t, input :: describe_vtl_devices_input) :: ExAws.Request.JSON.success_t | no_return

Same as describe_vtl_devices/2 but raise on error.

Source
describe_working_storage(client, input)

Specs:

DescribeWorkingStorage

This operation returns information about the working storage of a gateway. This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version (20120630). Use DescribeUploadBuffer instead.

Note:Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored-volume gateway.

The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.

Source
describe_working_storage!(client, input)

Specs:

Same as describe_working_storage/2 but raise on error.

Source
disable_gateway(client, input)

Specs:

  • disable_gateway(client :: ExAws.StorageGateway.t, input :: disable_gateway_input) :: ExAws.Request.JSON.response_t

DisableGateway

Disables a 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 gateway-VTL that is not reachable or not functioning.

Once a gateway is disabled it cannot be enabled.

Source
disable_gateway!(client, input)

Specs:

  • disable_gateway!(client :: ExAws.StorageGateway.t, input :: disable_gateway_input) :: ExAws.Request.JSON.success_t | no_return

Same as disable_gateway/2 but raise on error.

Source
list_gateways(client, input)

Specs:

  • list_gateways(client :: ExAws.StorageGateway.t, input :: list_gateways_input) :: ExAws.Request.JSON.response_t

ListGateways

This operation lists gateways owned by an AWS account in a 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.

Source
list_gateways!(client, input)

Specs:

  • list_gateways!(client :: ExAws.StorageGateway.t, input :: list_gateways_input) :: ExAws.Request.JSON.success_t | no_return

Same as list_gateways/2 but raise on error.

Source
list_local_disks(client, input)

Specs:

  • list_local_disks(client :: ExAws.StorageGateway.t, input :: list_local_disks_input) :: ExAws.Request.JSON.response_t

ListLocalDisks

This operation 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).

Source
list_local_disks!(client, input)

Specs:

  • list_local_disks!(client :: ExAws.StorageGateway.t, input :: list_local_disks_input) :: ExAws.Request.JSON.success_t | no_return

Same as list_local_disks/2 but raise on error.

Source
list_volume_initiators(client, input)

Specs:

ListVolumeInitiators

This operation lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not.

Source
list_volume_initiators!(client, input)

Specs:

  • list_volume_initiators!(client :: ExAws.StorageGateway.t, input :: list_volume_initiators_input) :: ExAws.Request.JSON.success_t | no_return

Same as list_volume_initiators/2 but raise on error.

Source
list_volume_recovery_points(client, input)

Specs:

ListVolumeRecoveryPoints

This operation lists the recovery points for a specified gateway. This operation is supported only for the gateway-cached volume architecture.

Each gateway-cached 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. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.

Source
list_volume_recovery_points!(client, input)

Specs:

Same as list_volume_recovery_points/2 but raise on error.

Source
list_volumes(client, input)

Specs:

  • list_volumes(client :: ExAws.StorageGateway.t, input :: list_volumes_input) :: ExAws.Request.JSON.response_t

ListVolumes

This operation 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 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.

Source
list_volumes!(client, input)

Specs:

  • list_volumes!(client :: ExAws.StorageGateway.t, input :: list_volumes_input) :: ExAws.Request.JSON.success_t | no_return

Same as list_volumes/2 but raise on error.

Source
reset_cache(client, input)

Specs:

  • reset_cache(client :: ExAws.StorageGateway.t, input :: reset_cache_input) :: ExAws.Request.JSON.response_t

ResetCache

This operation resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a 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.

** 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.

**

Source
reset_cache!(client, input)

Specs:

  • reset_cache!(client :: ExAws.StorageGateway.t, input :: reset_cache_input) :: ExAws.Request.JSON.success_t | no_return

Same as reset_cache/2 but raise on error.

Source
retrieve_tape_archive(client, input)

Specs:

RetrieveTapeArchive

Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a gateway-VTL. 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.

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.

Source
retrieve_tape_archive!(client, input)

Specs:

  • retrieve_tape_archive!(client :: ExAws.StorageGateway.t, input :: retrieve_tape_archive_input) :: ExAws.Request.JSON.success_t | no_return

Same as retrieve_tape_archive/2 but raise on error.

Source
retrieve_tape_recovery_point(client, input)

Specs:

RetrieveTapeRecoveryPoint

Retrieves the recovery point for the specified virtual tape.

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.

Note:The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a gateway-VTL. There is no charge for retrieving recovery points.

Source
retrieve_tape_recovery_point!(client, input)

Specs:

Same as retrieve_tape_recovery_point/2 but raise on error.

Source
shutdown_gateway(client, input)

Specs:

  • shutdown_gateway(client :: ExAws.StorageGateway.t, input :: shutdown_gateway_input) :: ExAws.Request.JSON.response_t

ShutdownGateway

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

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

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

Note:When you make a shutdown request, you will get a 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.

Source
shutdown_gateway!(client, input)

Specs:

  • shutdown_gateway!(client :: ExAws.StorageGateway.t, input :: shutdown_gateway_input) :: ExAws.Request.JSON.success_t | no_return

Same as shutdown_gateway/2 but raise on error.

Source
start_gateway(client, input)

Specs:

  • start_gateway(client :: ExAws.StorageGateway.t, input :: start_gateway_input) :: ExAws.Request.JSON.response_t

StartGateway

This operation 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.

Note:When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any additional API calls. For more information, see ActivateGateway. To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.

Source
start_gateway!(client, input)

Specs:

  • start_gateway!(client :: ExAws.StorageGateway.t, input :: start_gateway_input) :: ExAws.Request.JSON.success_t | no_return

Same as start_gateway/2 but raise on error.

Source
update_bandwidth_rate_limit(client, input)

Specs:

UpdateBandwidthRateLimit

This operation 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.

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.

Source
update_bandwidth_rate_limit!(client, input)

Specs:

Same as update_bandwidth_rate_limit/2 but raise on error.

Source
update_chap_credentials(client, input)

Specs:

UpdateChapCredentials

This operation 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.

** When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.

**

Source
update_chap_credentials!(client, input)

Specs:

Same as update_chap_credentials/2 but raise on error.

Source
update_gateway_information(client, input)

Specs:

UpdateGatewayInformation

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

Source
update_gateway_information!(client, input)

Specs:

Same as update_gateway_information/2 but raise on error.

Source
update_gateway_software_now(client, input)

Specs:

UpdateGatewaySoftwareNow

This operation updates the gateway virtual machine (VM) software. The request immediately triggers the software update.

Note:When you make this request, you get a 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.

Source
update_gateway_software_now!(client, input)

Specs:

Same as update_gateway_software_now/2 but raise on error.

Source
update_maintenance_start_time(client, input)

Specs:

UpdateMaintenanceStartTime

This operation updates a gateway’s weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway’s time zone.

Source
update_maintenance_start_time!(client, input)

Specs:

Same as update_maintenance_start_time/2 but raise on error.

Source
update_snapshot_schedule(client, input)

Specs:

UpdateSnapshotSchedule

This operation updates a snapshot schedule configured for a gateway volume.

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.

Source
update_snapshot_schedule!(client, input)

Specs:

Same as update_snapshot_schedule/2 but raise on error.

Source
update_vtl_device_type(client, input)

Specs:

UpdateVTLDeviceType

This operation updates the type of medium changer in a gateway-VTL. When you activate a gateway-VTL, you select a medium changer type for the gateway-VTL. This operation enables you to select a different type of medium changer after a gateway-VTL is activated.

Source
update_vtl_device_type!(client, input)

Specs:

  • update_vtl_device_type!(client :: ExAws.StorageGateway.t, input :: update_vtl_device_type_input) :: ExAws.Request.JSON.success_t | no_return

Same as update_vtl_device_type/2 but raise on error.

Source