Current section
Files
Jump to
Current section
Files
src/aws_storage_gateway.erl
%% WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
%% See https://github.com/aws-beam/aws-codegen for more details.
%% @doc Storage Gateway Service
%%
%% Storage Gateway is the service that connects an on-premises software
%% appliance with cloud-based storage to provide seamless and secure
%% integration between an organization's on-premises IT environment and
%% the Amazon Web Services storage infrastructure.
%%
%% The service enables you to securely upload data to the Amazon Web Services
%% Cloud for cost effective backup and rapid disaster recovery.
%%
%% Use the following links to get started using the Storage Gateway Service
%% API Reference:
%%
%% <ul> <li> Storage Gateway required request headers:
%% https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewayHTTPRequestsHeaders:
%% Describes the required headers that you must send with every POST request
%% to Storage Gateway.
%%
%% </li> <li> Signing requests:
%% https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewaySigningRequests:
%% Storage Gateway requires that you authenticate every request you send;
%% this topic describes how sign such a request.
%%
%% </li> <li> Error responses:
%% https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#APIErrorResponses:
%% Provides reference information about Storage Gateway errors.
%%
%% </li> <li> Operations in Storage Gateway:
%% https://docs.aws.amazon.com/storagegateway/latest/APIReference/API_Operations.html:
%% Contains detailed descriptions of all Storage Gateway operations, their
%% request parameters, response elements, possible errors, and examples of
%% requests and responses.
%%
%% </li> <li> Storage Gateway endpoints and quotas:
%% https://docs.aws.amazon.com/general/latest/gr/sg.html: Provides a list of
%% each Amazon Web Services Region and the endpoints available for use with
%% Storage Gateway.
%%
%% </li> </ul> Storage Gateway resource IDs are in uppercase. When you use
%% these resource IDs with the Amazon EC2 API, EC2 expects resource IDs in
%% lowercase. You must change your resource ID to lowercase to use it with
%% the EC2 API. For example, in Storage Gateway the ID for a volume might be
%% `vol-AA22BB012345DAF670'. When you use this ID with the EC2 API, you
%% must change it to `vol-aa22bb012345daf670'. Otherwise, the EC2 API
%% might not behave as expected.
%%
%% IDs for Storage Gateway volumes and Amazon EBS snapshots created from
%% gateway volumes are changing to a longer format. Starting in December
%% 2016, all new volumes and snapshots will be created with a 17-character
%% string. Starting in April 2016, you will be able to use these longer IDs
%% so you can test your systems with the new format. For more information,
%% see Longer EC2 and EBS resource IDs:
%% http://aws.amazon.com/ec2/faqs/#longer-ids.
%%
%% For example, a volume Amazon Resource Name (ARN) with the longer volume ID
%% format looks like the following:
%%
%% `arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG'.
%%
%% A snapshot ID with the longer ID format looks like the following:
%% `snap-78e226633445566ee'.
%%
%% For more information, see Announcement: Heads-up – Longer Storage Gateway
%% volume and snapshot IDs coming in 2016:
%% http://forums.aws.amazon.com/ann.jspa?annID=3557.
-module(aws_storage_gateway).
-export([activate_gateway/2,
activate_gateway/3,
add_cache/2,
add_cache/3,
add_tags_to_resource/2,
add_tags_to_resource/3,
add_upload_buffer/2,
add_upload_buffer/3,
add_working_storage/2,
add_working_storage/3,
assign_tape_pool/2,
assign_tape_pool/3,
associate_file_system/2,
associate_file_system/3,
attach_volume/2,
attach_volume/3,
cancel_archival/2,
cancel_archival/3,
cancel_retrieval/2,
cancel_retrieval/3,
create_cached_iscsi_volume/2,
create_cached_iscsi_volume/3,
create_nfs_file_share/2,
create_nfs_file_share/3,
create_smb_file_share/2,
create_smb_file_share/3,
create_snapshot/2,
create_snapshot/3,
create_snapshot_from_volume_recovery_point/2,
create_snapshot_from_volume_recovery_point/3,
create_stored_iscsi_volume/2,
create_stored_iscsi_volume/3,
create_tape_pool/2,
create_tape_pool/3,
create_tape_with_barcode/2,
create_tape_with_barcode/3,
create_tapes/2,
create_tapes/3,
delete_automatic_tape_creation_policy/2,
delete_automatic_tape_creation_policy/3,
delete_bandwidth_rate_limit/2,
delete_bandwidth_rate_limit/3,
delete_chap_credentials/2,
delete_chap_credentials/3,
delete_file_share/2,
delete_file_share/3,
delete_gateway/2,
delete_gateway/3,
delete_snapshot_schedule/2,
delete_snapshot_schedule/3,
delete_tape/2,
delete_tape/3,
delete_tape_archive/2,
delete_tape_archive/3,
delete_tape_pool/2,
delete_tape_pool/3,
delete_volume/2,
delete_volume/3,
describe_availability_monitor_test/2,
describe_availability_monitor_test/3,
describe_bandwidth_rate_limit/2,
describe_bandwidth_rate_limit/3,
describe_bandwidth_rate_limit_schedule/2,
describe_bandwidth_rate_limit_schedule/3,
describe_cache/2,
describe_cache/3,
describe_cached_iscsi_volumes/2,
describe_cached_iscsi_volumes/3,
describe_chap_credentials/2,
describe_chap_credentials/3,
describe_file_system_associations/2,
describe_file_system_associations/3,
describe_gateway_information/2,
describe_gateway_information/3,
describe_maintenance_start_time/2,
describe_maintenance_start_time/3,
describe_nfs_file_shares/2,
describe_nfs_file_shares/3,
describe_smb_file_shares/2,
describe_smb_file_shares/3,
describe_smb_settings/2,
describe_smb_settings/3,
describe_snapshot_schedule/2,
describe_snapshot_schedule/3,
describe_stored_iscsi_volumes/2,
describe_stored_iscsi_volumes/3,
describe_tape_archives/2,
describe_tape_archives/3,
describe_tape_recovery_points/2,
describe_tape_recovery_points/3,
describe_tapes/2,
describe_tapes/3,
describe_upload_buffer/2,
describe_upload_buffer/3,
describe_vtl_devices/2,
describe_vtl_devices/3,
describe_working_storage/2,
describe_working_storage/3,
detach_volume/2,
detach_volume/3,
disable_gateway/2,
disable_gateway/3,
disassociate_file_system/2,
disassociate_file_system/3,
join_domain/2,
join_domain/3,
list_automatic_tape_creation_policies/2,
list_automatic_tape_creation_policies/3,
list_file_shares/2,
list_file_shares/3,
list_file_system_associations/2,
list_file_system_associations/3,
list_gateways/2,
list_gateways/3,
list_local_disks/2,
list_local_disks/3,
list_tags_for_resource/2,
list_tags_for_resource/3,
list_tape_pools/2,
list_tape_pools/3,
list_tapes/2,
list_tapes/3,
list_volume_initiators/2,
list_volume_initiators/3,
list_volume_recovery_points/2,
list_volume_recovery_points/3,
list_volumes/2,
list_volumes/3,
notify_when_uploaded/2,
notify_when_uploaded/3,
refresh_cache/2,
refresh_cache/3,
remove_tags_from_resource/2,
remove_tags_from_resource/3,
reset_cache/2,
reset_cache/3,
retrieve_tape_archive/2,
retrieve_tape_archive/3,
retrieve_tape_recovery_point/2,
retrieve_tape_recovery_point/3,
set_local_console_password/2,
set_local_console_password/3,
set_smb_guest_password/2,
set_smb_guest_password/3,
shutdown_gateway/2,
shutdown_gateway/3,
start_availability_monitor_test/2,
start_availability_monitor_test/3,
start_gateway/2,
start_gateway/3,
update_automatic_tape_creation_policy/2,
update_automatic_tape_creation_policy/3,
update_bandwidth_rate_limit/2,
update_bandwidth_rate_limit/3,
update_bandwidth_rate_limit_schedule/2,
update_bandwidth_rate_limit_schedule/3,
update_chap_credentials/2,
update_chap_credentials/3,
update_file_system_association/2,
update_file_system_association/3,
update_gateway_information/2,
update_gateway_information/3,
update_gateway_software_now/2,
update_gateway_software_now/3,
update_maintenance_start_time/2,
update_maintenance_start_time/3,
update_nfs_file_share/2,
update_nfs_file_share/3,
update_smb_file_share/2,
update_smb_file_share/3,
update_smb_file_share_visibility/2,
update_smb_file_share_visibility/3,
update_smb_local_groups/2,
update_smb_local_groups/3,
update_smb_security_strategy/2,
update_smb_security_strategy/3,
update_snapshot_schedule/2,
update_snapshot_schedule/3,
update_vtl_device_type/2,
update_vtl_device_type/3]).
-include_lib("hackney/include/hackney_lib.hrl").
%%====================================================================
%% API
%%====================================================================
%% @doc 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'.
%%
%% You must turn on the gateway VM before you can activate your gateway.
activate_gateway(Client, Input)
when is_map(Client), is_map(Input) ->
activate_gateway(Client, Input, []).
activate_gateway(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"ActivateGateway">>, Input, Options).
%% @doc 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):
%% https://docs.aws.amazon.com/storagegateway/latest/userguide/StorageGatewayConcepts.html.
%%
%% 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.
add_cache(Client, Input)
when is_map(Client), is_map(Input) ->
add_cache(Client, Input, []).
add_cache(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"AddCache">>, Input, Options).
%% @doc 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:
%%
%% <ul> <li> Storage gateways of all types
%%
%% </li> <li> Storage volumes
%%
%% </li> <li> Virtual tapes
%%
%% </li> <li> NFS and SMB file shares
%%
%% </li> <li> File System associations
%%
%% </li> </ul> 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.
add_tags_to_resource(Client, Input)
when is_map(Client), is_map(Input) ->
add_tags_to_resource(Client, Input, []).
add_tags_to_resource(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"AddTagsToResource">>, Input, Options).
%% @doc 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.
add_upload_buffer(Client, Input)
when is_map(Client), is_map(Input) ->
add_upload_buffer(Client, Input, []).
add_upload_buffer(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"AddUploadBuffer">>, Input, Options).
%% @doc 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.
%%
%% 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.
add_working_storage(Client, Input)
when is_map(Client), is_map(Input) ->
add_working_storage(Client, Input, []).
add_working_storage(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"AddWorkingStorage">>, Input, Options).
%% @doc 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.
assign_tape_pool(Client, Input)
when is_map(Client), is_map(Input) ->
assign_tape_pool(Client, Input, []).
assign_tape_pool(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"AssignTapePool">>, Input, Options).
%% @doc 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.
associate_file_system(Client, Input)
when is_map(Client), is_map(Input) ->
associate_file_system(Client, Input, []).
associate_file_system(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"AssociateFileSystem">>, Input, Options).
%% @doc 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.
attach_volume(Client, Input)
when is_map(Client), is_map(Input) ->
attach_volume(Client, Input, []).
attach_volume(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"AttachVolume">>, Input, Options).
%% @doc 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.
cancel_archival(Client, Input)
when is_map(Client), is_map(Input) ->
cancel_archival(Client, Input, []).
cancel_archival(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"CancelArchival">>, Input, Options).
%% @doc 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.
cancel_retrieval(Client, Input)
when is_map(Client), is_map(Input) ->
cancel_retrieval(Client, Input, []).
cancel_retrieval(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"CancelRetrieval">>, Input, Options).
%% @doc Creates a cached volume on a specified cached volume gateway.
%%
%% This operation is only supported in the cached volume gateway type.
%%
%% Cache storage must be allocated to the gateway before you can create a
%% cached volume. Use the `AddCache' operation to add cache storage to a
%% gateway.
%%
%% In the request, you must specify the gateway, size of the volume in bytes,
%% the iSCSI target name, an IP address on which to expose the target, and a
%% unique client token. In response, the gateway creates the volume and
%% returns information about it. This information includes the volume Amazon
%% Resource Name (ARN), its size, and the iSCSI target ARN that initiators
%% can use to connect to the volume target.
%%
%% 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.
create_cached_iscsi_volume(Client, Input)
when is_map(Client), is_map(Input) ->
create_cached_iscsi_volume(Client, Input, []).
create_cached_iscsi_volume(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"CreateCachediSCSIVolume">>, Input, Options).
%% @doc 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:
%% https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html
%% in the Identity and Access Management User Guide.
%%
%% S3 File Gateways do not support creating hard or symbolic links on a file
%% share.
create_nfs_file_share(Client, Input)
when is_map(Client), is_map(Input) ->
create_nfs_file_share(Client, Input, []).
create_nfs_file_share(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"CreateNFSFileShare">>, Input, Options).
%% @doc 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:
%% https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html
%% in the Identity and Access Management User Guide.
%%
%% File gateways don't support creating hard or symbolic links on a file
%% share.
create_smb_file_share(Client, Input)
when is_map(Client), is_map(Input) ->
create_smb_file_share(Client, Input, []).
create_smb_file_share(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"CreateSMBFileShare">>, Input, Options).
%% @doc 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:
%% https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#SchedulingSnapshot.
%%
%% 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.
%%
%% To list or delete a snapshot, you must use the Amazon EC2 API. For more
%% information, see DescribeSnapshots:
%% https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html
%% or DeleteSnapshot:
%% https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteSnapshot.html
%% in the Amazon Elastic Compute Cloud API Reference.
%%
%% Volume and snapshot IDs are changing to a longer length ID format. For
%% more information, see the important note on the Welcome:
%% https://docs.aws.amazon.com/storagegateway/latest/APIReference/Welcome.html
%% page.
create_snapshot(Client, Input)
when is_map(Client), is_map(Input) ->
create_snapshot(Client, Input, []).
create_snapshot(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"CreateSnapshot">>, Input, Options).
%% @doc 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.
%%
%% To list or delete a snapshot, you must use the Amazon EC2 API. For more
%% information, see DescribeSnapshots:
%% https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html
%% or DeleteSnapshot:
%% https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteSnapshot.html
%% in the Amazon Elastic Compute Cloud API Reference.
create_snapshot_from_volume_recovery_point(Client, Input)
when is_map(Client), is_map(Input) ->
create_snapshot_from_volume_recovery_point(Client, Input, []).
create_snapshot_from_volume_recovery_point(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"CreateSnapshotFromVolumeRecoveryPoint">>, Input, Options).
%% @doc 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.
create_stored_iscsi_volume(Client, Input)
when is_map(Client), is_map(Input) ->
create_stored_iscsi_volume(Client, Input, []).
create_stored_iscsi_volume(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"CreateStorediSCSIVolume">>, Input, Options).
%% @doc 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.
create_tape_pool(Client, Input)
when is_map(Client), is_map(Input) ->
create_tape_pool(Client, Input, []).
create_tape_pool(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"CreateTapePool">>, Input, Options).
%% @doc 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.
%%
%% Cache storage must be allocated to the gateway before you can create a
%% virtual tape. Use the `AddCache' operation to add cache storage to a
%% gateway.
create_tape_with_barcode(Client, Input)
when is_map(Client), is_map(Input) ->
create_tape_with_barcode(Client, Input, []).
create_tape_with_barcode(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"CreateTapeWithBarcode">>, Input, Options).
%% @doc 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.
%%
%% 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.
create_tapes(Client, Input)
when is_map(Client), is_map(Input) ->
create_tapes(Client, Input, []).
create_tapes(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"CreateTapes">>, Input, Options).
%% @doc 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.
delete_automatic_tape_creation_policy(Client, Input)
when is_map(Client), is_map(Input) ->
delete_automatic_tape_creation_policy(Client, Input, []).
delete_automatic_tape_creation_policy(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DeleteAutomaticTapeCreationPolicy">>, Input, Options).
%% @doc 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.
delete_bandwidth_rate_limit(Client, Input)
when is_map(Client), is_map(Input) ->
delete_bandwidth_rate_limit(Client, Input, []).
delete_bandwidth_rate_limit(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DeleteBandwidthRateLimit">>, Input, Options).
%% @doc 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.
delete_chap_credentials(Client, Input)
when is_map(Client), is_map(Input) ->
delete_chap_credentials(Client, Input, []).
delete_chap_credentials(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DeleteChapCredentials">>, Input, Options).
%% @doc Deletes a file share from an S3 File Gateway.
%%
%% This operation is only supported for S3 File Gateways.
delete_file_share(Client, Input)
when is_map(Client), is_map(Input) ->
delete_file_share(Client, Input, []).
delete_file_share(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DeleteFileShare">>, Input, Options).
%% @doc 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: http://aws.amazon.com/storagegateway.
delete_gateway(Client, Input)
when is_map(Client), is_map(Input) ->
delete_gateway(Client, Input, []).
delete_gateway(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DeleteGateway">>, Input, Options).
%% @doc 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:
%% https://docs.aws.amazon.com/storagegateway/latest/userguide/backing-up-volumes.html.
%% 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.
%%
%% To list or delete a snapshot, you must use the Amazon EC2 API. For more
%% information, go to DescribeSnapshots:
%% https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html
%% in the Amazon Elastic Compute Cloud API Reference.
delete_snapshot_schedule(Client, Input)
when is_map(Client), is_map(Input) ->
delete_snapshot_schedule(Client, Input, []).
delete_snapshot_schedule(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DeleteSnapshotSchedule">>, Input, Options).
%% @doc Deletes the specified virtual tape.
%%
%% This operation is only supported in the tape gateway type.
delete_tape(Client, Input)
when is_map(Client), is_map(Input) ->
delete_tape(Client, Input, []).
delete_tape(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DeleteTape">>, Input, Options).
%% @doc Deletes the specified virtual tape from the virtual tape shelf (VTS).
%%
%% This operation is only supported in the tape gateway type.
delete_tape_archive(Client, Input)
when is_map(Client), is_map(Input) ->
delete_tape_archive(Client, Input, []).
delete_tape_archive(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DeleteTapeArchive">>, Input, Options).
%% @doc 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.
delete_tape_pool(Client, Input)
when is_map(Client), is_map(Input) ->
delete_tape_pool(Client, Input, []).
delete_tape_pool(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DeleteTapePool">>, Input, Options).
%% @doc 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:
%% https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html
%% 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.
delete_volume(Client, Input)
when is_map(Client), is_map(Input) ->
delete_volume(Client, Input, []).
delete_volume(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DeleteVolume">>, Input, Options).
%% @doc 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.
describe_availability_monitor_test(Client, Input)
when is_map(Client), is_map(Input) ->
describe_availability_monitor_test(Client, Input, []).
describe_availability_monitor_test(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DescribeAvailabilityMonitorTest">>, Input, Options).
%% @doc 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.
describe_bandwidth_rate_limit(Client, Input)
when is_map(Client), is_map(Input) ->
describe_bandwidth_rate_limit(Client, Input, []).
describe_bandwidth_rate_limit(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DescribeBandwidthRateLimit">>, Input, Options).
%% @doc 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.
describe_bandwidth_rate_limit_schedule(Client, Input)
when is_map(Client), is_map(Input) ->
describe_bandwidth_rate_limit_schedule(Client, Input, []).
describe_bandwidth_rate_limit_schedule(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DescribeBandwidthRateLimitSchedule">>, Input, Options).
%% @doc 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.
describe_cache(Client, Input)
when is_map(Client), is_map(Input) ->
describe_cache(Client, Input, []).
describe_cache(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DescribeCache">>, Input, Options).
%% @doc 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).
describe_cached_iscsi_volumes(Client, Input)
when is_map(Client), is_map(Input) ->
describe_cached_iscsi_volumes(Client, Input, []).
describe_cached_iscsi_volumes(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DescribeCachediSCSIVolumes">>, Input, Options).
%% @doc 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.
describe_chap_credentials(Client, Input)
when is_map(Client), is_map(Input) ->
describe_chap_credentials(Client, Input, []).
describe_chap_credentials(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DescribeChapCredentials">>, Input, Options).
%% @doc Gets the file system association information.
%%
%% This operation is only supported for FSx File Gateways.
describe_file_system_associations(Client, Input)
when is_map(Client), is_map(Input) ->
describe_file_system_associations(Client, Input, []).
describe_file_system_associations(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DescribeFileSystemAssociations">>, Input, Options).
%% @doc 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.
describe_gateway_information(Client, Input)
when is_map(Client), is_map(Input) ->
describe_gateway_information(Client, Input, []).
describe_gateway_information(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DescribeGatewayInformation">>, Input, Options).
%% @doc 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.
describe_maintenance_start_time(Client, Input)
when is_map(Client), is_map(Input) ->
describe_maintenance_start_time(Client, Input, []).
describe_maintenance_start_time(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DescribeMaintenanceStartTime">>, Input, Options).
%% @doc 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.
describe_nfs_file_shares(Client, Input)
when is_map(Client), is_map(Input) ->
describe_nfs_file_shares(Client, Input, []).
describe_nfs_file_shares(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DescribeNFSFileShares">>, Input, Options).
%% @doc 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.
describe_smb_file_shares(Client, Input)
when is_map(Client), is_map(Input) ->
describe_smb_file_shares(Client, Input, []).
describe_smb_file_shares(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DescribeSMBFileShares">>, Input, Options).
%% @doc Gets a description of a Server Message Block (SMB) file share
%% settings from a file gateway.
%%
%% This operation is only supported for file gateways.
describe_smb_settings(Client, Input)
when is_map(Client), is_map(Input) ->
describe_smb_settings(Client, Input, []).
describe_smb_settings(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DescribeSMBSettings">>, Input, Options).
%% @doc 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.
describe_snapshot_schedule(Client, Input)
when is_map(Client), is_map(Input) ->
describe_snapshot_schedule(Client, Input, []).
describe_snapshot_schedule(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DescribeSnapshotSchedule">>, Input, Options).
%% @doc 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.
describe_stored_iscsi_volumes(Client, Input)
when is_map(Client), is_map(Input) ->
describe_stored_iscsi_volumes(Client, Input, []).
describe_stored_iscsi_volumes(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DescribeStorediSCSIVolumes">>, Input, Options).
%% @doc 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.
describe_tape_archives(Client, Input)
when is_map(Client), is_map(Input) ->
describe_tape_archives(Client, Input, []).
describe_tape_archives(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DescribeTapeArchives">>, Input, Options).
%% @doc 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.
describe_tape_recovery_points(Client, Input)
when is_map(Client), is_map(Input) ->
describe_tape_recovery_points(Client, Input, []).
describe_tape_recovery_points(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DescribeTapeRecoveryPoints">>, Input, Options).
%% @doc 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.
describe_tapes(Client, Input)
when is_map(Client), is_map(Input) ->
describe_tapes(Client, Input, []).
describe_tapes(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DescribeTapes">>, Input, Options).
%% @doc 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.
describe_upload_buffer(Client, Input)
when is_map(Client), is_map(Input) ->
describe_upload_buffer(Client, Input, []).
describe_upload_buffer(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DescribeUploadBuffer">>, Input, Options).
%% @doc 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.
describe_vtl_devices(Client, Input)
when is_map(Client), is_map(Input) ->
describe_vtl_devices(Client, Input, []).
describe_vtl_devices(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DescribeVTLDevices">>, Input, Options).
%% @doc 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.
%%
%% 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.
describe_working_storage(Client, Input)
when is_map(Client), is_map(Input) ->
describe_working_storage(Client, Input, []).
describe_working_storage(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DescribeWorkingStorage">>, Input, Options).
%% @doc 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.
detach_volume(Client, Input)
when is_map(Client), is_map(Input) ->
detach_volume(Client, Input, []).
detach_volume(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DetachVolume">>, Input, Options).
%% @doc 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.
disable_gateway(Client, Input)
when is_map(Client), is_map(Input) ->
disable_gateway(Client, Input, []).
disable_gateway(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DisableGateway">>, Input, Options).
%% @doc 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.
disassociate_file_system(Client, Input)
when is_map(Client), is_map(Input) ->
disassociate_file_system(Client, Input, []).
disassociate_file_system(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DisassociateFileSystem">>, Input, Options).
%% @doc Adds a file gateway to an Active Directory domain.
%%
%% This operation is only supported for file gateways that support the SMB
%% file protocol.
%%
%% Joining a domain creates an Active Directory computer account in the
%% default organizational unit, using the gateway's Gateway ID as the
%% account name (for example, SGW-1234ADE). If your Active Directory
%% environment requires that you pre-stage accounts to facilitate the join
%% domain process, you will need to create this account ahead of time.
%%
%% 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.
join_domain(Client, Input)
when is_map(Client), is_map(Input) ->
join_domain(Client, Input, []).
join_domain(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"JoinDomain">>, Input, Options).
%% @doc 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.
list_automatic_tape_creation_policies(Client, Input)
when is_map(Client), is_map(Input) ->
list_automatic_tape_creation_policies(Client, Input, []).
list_automatic_tape_creation_policies(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"ListAutomaticTapeCreationPolicies">>, Input, Options).
%% @doc 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.
list_file_shares(Client, Input)
when is_map(Client), is_map(Input) ->
list_file_shares(Client, Input, []).
list_file_shares(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"ListFileShares">>, Input, Options).
%% @doc 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.
list_file_system_associations(Client, Input)
when is_map(Client), is_map(Input) ->
list_file_system_associations(Client, Input, []).
list_file_system_associations(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"ListFileSystemAssociations">>, Input, Options).
%% @doc 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.
list_gateways(Client, Input)
when is_map(Client), is_map(Input) ->
list_gateways(Client, Input, []).
list_gateways(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"ListGateways">>, Input, Options).
%% @doc 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).
list_local_disks(Client, Input)
when is_map(Client), is_map(Input) ->
list_local_disks(Client, Input, []).
list_local_disks(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"ListLocalDisks">>, Input, Options).
%% @doc Lists the tags that have been added to the specified resource.
%%
%% This operation is supported in storage gateways of all types.
list_tags_for_resource(Client, Input)
when is_map(Client), is_map(Input) ->
list_tags_for_resource(Client, Input, []).
list_tags_for_resource(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"ListTagsForResource">>, Input, Options).
%% @doc 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.
list_tape_pools(Client, Input)
when is_map(Client), is_map(Input) ->
list_tape_pools(Client, Input, []).
list_tape_pools(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"ListTapePools">>, Input, Options).
%% @doc 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.
list_tapes(Client, Input)
when is_map(Client), is_map(Input) ->
list_tapes(Client, Input, []).
list_tapes(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"ListTapes">>, Input, Options).
%% @doc 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.
list_volume_initiators(Client, Input)
when is_map(Client), is_map(Input) ->
list_volume_initiators(Client, Input, []).
list_volume_initiators(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"ListVolumeInitiators">>, Input, Options).
%% @doc 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.
list_volume_recovery_points(Client, Input)
when is_map(Client), is_map(Input) ->
list_volume_recovery_points(Client, Input, []).
list_volume_recovery_points(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"ListVolumeRecoveryPoints">>, Input, Options).
%% @doc 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.
list_volumes(Client, Input)
when is_map(Client), is_map(Input) ->
list_volumes(Client, Input, []).
list_volumes(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"ListVolumes">>, Input, Options).
%% @doc 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:
%% https://docs.aws.amazon.com/filegateway/latest/files3/monitoring-file-gateway.html#get-notification
%% in the Amazon S3 File Gateway User Guide.
notify_when_uploaded(Client, Input)
when is_map(Client), is_map(Input) ->
notify_when_uploaded(Client, Input, []).
notify_when_uploaded(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"NotifyWhenUploaded">>, Input, Options).
%% @doc 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:
%% https://docs.aws.amazon.com/filegateway/latest/files3/monitoring-file-gateway.html#get-notification
%% 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:
%% https://docs.aws.amazon.com/filegateway/latest/files3/monitoring-file-gateway.html#get-notification
%% 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.
%%
%% The S3 bucket name does not need to be included when entering the list of
%% folders in the FolderList parameter.
%%
%% For more information, see Getting notified about file operations:
%% https://docs.aws.amazon.com/filegateway/latest/files3/monitoring-file-gateway.html#get-notification
%% in the Amazon S3 File Gateway User Guide.
refresh_cache(Client, Input)
when is_map(Client), is_map(Input) ->
refresh_cache(Client, Input, []).
refresh_cache(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"RefreshCache">>, Input, Options).
%% @doc Removes one or more tags from the specified resource.
%%
%% This operation is supported in storage gateways of all types.
remove_tags_from_resource(Client, Input)
when is_map(Client), is_map(Input) ->
remove_tags_from_resource(Client, Input, []).
remove_tags_from_resource(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"RemoveTagsFromResource">>, Input, Options).
%% @doc 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.
reset_cache(Client, Input)
when is_map(Client), is_map(Input) ->
reset_cache(Client, Input, []).
reset_cache(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"ResetCache">>, Input, Options).
%% @doc 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.
retrieve_tape_archive(Client, Input)
when is_map(Client), is_map(Input) ->
retrieve_tape_archive(Client, Input, []).
retrieve_tape_archive(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"RetrieveTapeArchive">>, Input, Options).
%% @doc 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.
%%
%% 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 tape gateway.
%% There is no charge for retrieving recovery points.
retrieve_tape_recovery_point(Client, Input)
when is_map(Client), is_map(Input) ->
retrieve_tape_recovery_point(Client, Input, []).
retrieve_tape_recovery_point(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"RetrieveTapeRecoveryPoint">>, Input, Options).
%% @doc 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.
set_local_console_password(Client, Input)
when is_map(Client), is_map(Input) ->
set_local_console_password(Client, Input, []).
set_local_console_password(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"SetLocalConsolePassword">>, Input, Options).
%% @doc 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
set_smb_guest_password(Client, Input)
when is_map(Client), is_map(Input) ->
set_smb_guest_password(Client, Input, []).
set_smb_guest_password(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"SetSMBGuestPassword">>, Input, Options).
%% @doc 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.
%%
%% This API action cannot be used to shut down S3 File Gateway or FSx File
%% Gateway.
%%
%% The operation shuts down the gateway service component running in the
%% gateway's virtual machine (VM) and not the host VM.
%%
%% If you want to shut down the VM, it is recommended that you first shut
%% down the gateway component in the VM to avoid unpredictable conditions.
%%
%% After the gateway is shutdown, you cannot call any other API except
%% `StartGateway', `DescribeGatewayInformation', and
%% `ListGateways'. For more information, see `ActivateGateway'. Your
%% applications cannot read from or write to the gateway's storage
%% volumes, and there are no snapshots taken.
%%
%% 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.
shutdown_gateway(Client, Input)
when is_map(Client), is_map(Input) ->
shutdown_gateway(Client, Input, []).
shutdown_gateway(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"ShutdownGateway">>, Input, Options).
%% @doc 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.
%%
%% Starting this test will cause your gateway to go offline for a brief
%% period.
start_availability_monitor_test(Client, Input)
when is_map(Client), is_map(Input) ->
start_availability_monitor_test(Client, Input, []).
start_availability_monitor_test(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"StartAvailabilityMonitorTest">>, Input, Options).
%% @doc 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.
%%
%% 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.
start_gateway(Client, Input)
when is_map(Client), is_map(Input) ->
start_gateway(Client, Input, []).
start_gateway(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"StartGateway">>, Input, Options).
%% @doc 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.
%%
%% A gateway can have only one automatic tape creation policy.
update_automatic_tape_creation_policy(Client, Input)
when is_map(Client), is_map(Input) ->
update_automatic_tape_creation_policy(Client, Input, []).
update_automatic_tape_creation_policy(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"UpdateAutomaticTapeCreationPolicy">>, Input, Options).
%% @doc 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.
update_bandwidth_rate_limit(Client, Input)
when is_map(Client), is_map(Input) ->
update_bandwidth_rate_limit(Client, Input, []).
update_bandwidth_rate_limit(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"UpdateBandwidthRateLimit">>, Input, Options).
%% @doc 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.
update_bandwidth_rate_limit_schedule(Client, Input)
when is_map(Client), is_map(Input) ->
update_bandwidth_rate_limit_schedule(Client, Input, []).
update_bandwidth_rate_limit_schedule(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"UpdateBandwidthRateLimitSchedule">>, Input, Options).
%% @doc 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.
update_chap_credentials(Client, Input)
when is_map(Client), is_map(Input) ->
update_chap_credentials(Client, Input, []).
update_chap_credentials(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"UpdateChapCredentials">>, Input, Options).
%% @doc Updates a file system association.
%%
%% This operation is only supported in the FSx File Gateways.
update_file_system_association(Client, Input)
when is_map(Client), is_map(Input) ->
update_file_system_association(Client, Input, []).
update_file_system_association(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"UpdateFileSystemAssociation">>, Input, Options).
%% @doc 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.
%%
%% For gateways activated after September 2, 2015, the gateway's ARN
%% contains the gateway ID rather than the gateway name. However, changing
%% the name of the gateway has no effect on the gateway's ARN.
update_gateway_information(Client, Input)
when is_map(Client), is_map(Input) ->
update_gateway_information(Client, Input, []).
update_gateway_information(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"UpdateGatewayInformation">>, Input, Options).
%% @doc Updates the gateway virtual machine (VM) software.
%%
%% The request immediately triggers the software update.
%%
%% 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:
%% https://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorWindowsClient.html#CustomizeWindowsiSCSISettings
%% and Customizing your Linux iSCSI settings:
%% https://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorRedHatClient.html#CustomizeLinuxiSCSISettings,
%% respectively.
update_gateway_software_now(Client, Input)
when is_map(Client), is_map(Input) ->
update_gateway_software_now(Client, Input, []).
update_gateway_software_now(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"UpdateGatewaySoftwareNow">>, Input, Options).
%% @doc 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.
update_maintenance_start_time(Client, Input)
when is_map(Client), is_map(Input) ->
update_maintenance_start_time(Client, Input, []).
update_maintenance_start_time(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"UpdateMaintenanceStartTime">>, Input, Options).
%% @doc Updates a Network File System (NFS) file share.
%%
%% This operation is only supported in S3 File Gateways.
%%
%% To leave a file share field unchanged, set the corresponding input field
%% to null.
%%
%% Updates the following file share settings:
%%
%% <ul> <li> Default storage class for your S3 bucket
%%
%% </li> <li> Metadata defaults for your S3 bucket
%%
%% </li> <li> Allowed NFS clients for your file share
%%
%% </li> <li> Squash settings
%%
%% </li> <li> Write status of your file share
%%
%% </li> </ul>
update_nfs_file_share(Client, Input)
when is_map(Client), is_map(Input) ->
update_nfs_file_share(Client, Input, []).
update_nfs_file_share(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"UpdateNFSFileShare">>, Input, Options).
%% @doc Updates a Server Message Block (SMB) file share.
%%
%% This operation is only supported for S3 File Gateways.
%%
%% To leave a file share field unchanged, set the corresponding input field
%% to null.
%%
%% 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:
%% https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html
%% in the Identity and Access Management User Guide.
%%
%% File gateways don't support creating hard or symbolic links on a file
%% share.
update_smb_file_share(Client, Input)
when is_map(Client), is_map(Input) ->
update_smb_file_share(Client, Input, []).
update_smb_file_share(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"UpdateSMBFileShare">>, Input, Options).
%% @doc 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.
update_smb_file_share_visibility(Client, Input)
when is_map(Client), is_map(Input) ->
update_smb_file_share_visibility(Client, Input, []).
update_smb_file_share_visibility(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"UpdateSMBFileShareVisibility">>, Input, Options).
%% @doc Updates the list of Active Directory users and groups that have
%% special permissions for SMB file shares on the gateway.
update_smb_local_groups(Client, Input)
when is_map(Client), is_map(Input) ->
update_smb_local_groups(Client, Input, []).
update_smb_local_groups(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"UpdateSMBLocalGroups">>, Input, Options).
%% @doc Updates the SMB security strategy on a file gateway.
%%
%% This action is only supported in file gateways.
%%
%% This API is called Security level in the User Guide.
%%
%% A higher security level can affect performance of the gateway.
update_smb_security_strategy(Client, Input)
when is_map(Client), is_map(Input) ->
update_smb_security_strategy(Client, Input, []).
update_smb_security_strategy(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"UpdateSMBSecurityStrategy">>, Input, Options).
%% @doc 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.
update_snapshot_schedule(Client, Input)
when is_map(Client), is_map(Input) ->
update_snapshot_schedule(Client, Input, []).
update_snapshot_schedule(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"UpdateSnapshotSchedule">>, Input, Options).
%% @doc 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.
update_vtl_device_type(Client, Input)
when is_map(Client), is_map(Input) ->
update_vtl_device_type(Client, Input, []).
update_vtl_device_type(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"UpdateVTLDeviceType">>, Input, Options).
%%====================================================================
%% Internal functions
%%====================================================================
-spec request(aws_client:aws_client(), binary(), map(), list()) ->
{ok, Result, {integer(), list(), hackney:client()}} |
{error, Error, {integer(), list(), hackney:client()}} |
{error, term()} when
Result :: map() | undefined,
Error :: map().
request(Client, Action, Input, Options) ->
RequestFun = fun() -> do_request(Client, Action, Input, Options) end,
aws_request:request(RequestFun, Options).
do_request(Client, Action, Input0, Options) ->
Client1 = Client#{service => <<"storagegateway">>},
Host = build_host(<<"storagegateway">>, Client1),
URL = build_url(Host, Client1),
Headers = [
{<<"Host">>, Host},
{<<"Content-Type">>, <<"application/x-amz-json-1.1">>},
{<<"X-Amz-Target">>, <<"StorageGateway_20130630.", Action/binary>>}
],
Input = Input0,
Payload = jsx:encode(Input),
SignedHeaders = aws_request:sign_request(Client1, <<"POST">>, URL, Headers, Payload),
Response = hackney:request(post, URL, SignedHeaders, Payload, Options),
handle_response(Response).
handle_response({ok, 200, ResponseHeaders, Client}) ->
case hackney:body(Client) of
{ok, <<>>} ->
{ok, undefined, {200, ResponseHeaders, Client}};
{ok, Body} ->
Result = jsx:decode(Body),
{ok, Result, {200, ResponseHeaders, Client}}
end;
handle_response({ok, StatusCode, ResponseHeaders, Client}) ->
{ok, Body} = hackney:body(Client),
Error = jsx:decode(Body),
{error, Error, {StatusCode, ResponseHeaders, Client}};
handle_response({error, Reason}) ->
{error, Reason}.
build_host(_EndpointPrefix, #{region := <<"local">>, endpoint := Endpoint}) ->
Endpoint;
build_host(_EndpointPrefix, #{region := <<"local">>}) ->
<<"localhost">>;
build_host(EndpointPrefix, #{region := Region, endpoint := Endpoint}) ->
aws_util:binary_join([EndpointPrefix, Region, Endpoint], <<".">>).
build_url(Host, Client) ->
Proto = aws_client:proto(Client),
Port = aws_client:port(Client),
aws_util:binary_join([Proto, <<"://">>, Host, <<":">>, Port, <<"/">>], <<"">>).