Smaws_Client_StorageGateway.Typestype nonrec long = Smaws_Lib.CoreTypes.Int64.ttype nonrec volumei_scsi_attributes = {chap_enabled : boolean2 option;Indicates whether mutual CHAP is enabled for the iSCSI target.
*)lun_number : positive_int_object option;The logical disk number.
*)network_interface_port : integer option;The port used to communicate with iSCSI targets.
*)network_interface_id : network_interface_id option;The network interface identifier.
*)target_ar_n : target_ar_n option;The Amazon Resource Name (ARN) of the volume target.
*)}Lists iSCSI information about a volume.
type nonrec volume_used_in_bytes = Smaws_Lib.CoreTypes.Int64.ttype nonrec volume_recovery_point_info = {volume_recovery_point_time : string_ option;The time the recovery point was taken.
*)volume_usage_in_bytes : long option;The size of the data stored on the volume in bytes.
This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.
*)volume_size_in_bytes : long option;The size of the volume in bytes.
*)volume_ar_n : volume_ar_n option;The Amazon Resource Name (ARN) of the volume target.
*)}Describes a storage volume recovery point object.
type nonrec volume_recovery_point_infos = volume_recovery_point_info listtype nonrec volume_info = {volume_attachment_status : volume_attachment_status option;One of the VolumeStatus values that indicates the state of the storage volume.
*)volume_size_in_bytes : long option;The size of the volume in bytes.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
*)volume_type : volume_type option;One of the VolumeType enumeration values describing the type of the volume.
*)gateway_id : gateway_id option;The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
*)gateway_ar_n : gateway_ar_n option;volume_id : volume_id option;The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
*)volume_ar_n : volume_ar_n option;The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:
arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
*)}Describes a storage volume object.
type nonrec volume_infos = volume_info listtype nonrec volume_ar_ns = volume_ar_n listtype nonrec devicei_scsi_attributes = {chap_enabled : boolean2 option;Indicates whether mutual CHAP is enabled for the iSCSI target.
*)network_interface_port : integer option;The port used to communicate with iSCSI VTL device targets.
*)network_interface_id : network_interface_id option;The network interface identifier of the VTL device.
*)target_ar_n : target_ar_n option;Specifies the unique Amazon Resource Name (ARN) that encodes the iSCSI qualified name(iqn) of a tape drive or media changer target.
*)}Lists iSCSI information about a VTL device.
type nonrec vtl_device = {devicei_scsi_attributes : devicei_scsi_attributes option;A list of iSCSI information about a VTL device.
*)vtl_device_product_identifier : vtl_device_product_identifier option;Specifies the model number of device that the VTL device emulates.
*)vtl_device_vendor : vtl_device_vendor option;Specifies the vendor of the device that the VTL device object emulates.
*)vtl_device_type : vtl_device_type option;Specifies the type of device that the VTL device emulates.
*)vtl_device_ar_n : vtl_device_ar_n option;Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer).
*)}Represents a device object associated with a tape gateway.
type nonrec vtl_devices = vtl_device listtype nonrec vtl_device_ar_ns = vtl_device_ar_n listtype nonrec user_list = user_list_user listtype nonrec update_vtl_device_type_output = {vtl_device_ar_n : vtl_device_ar_n option;The Amazon Resource Name (ARN) of the medium changer you have selected.
*)}UpdateVTLDeviceTypeOutput
type nonrec update_vtl_device_type_input = {device_type : device_type;The type of medium changer you want to select.
Valid Values: STK-L700 | AWS-Gateway-VTL | IBM-03584L32-0402
vtl_device_ar_n : vtl_device_ar_n;The Amazon Resource Name (ARN) of the medium changer you want to select.
*)}type nonrec error_code = | VolumeNotReady| VolumeNotFound| VolumeInUse| VolumeIdInvalid| VolumeAlreadyExists| TargetNotFound| TargetInvalid| TargetAlreadyExists| TapeCartridgeNotFound| StorageFailure| StagingAreaFull| SnapshotScheduleNotFound| SnapshotNotFound| SnapshotInProgress| SnapshotIdInvalid| SnapshotDeleted| RequestTimeout| RegionInvalid| ParametersNotImplemented| OutdatedGateway| OperationAborted| NotSupported| NotImplemented| NoDisksAvailable| NetworkConfigurationChanged| MaximumVolumeCountExceeded| MaximumTapeCartridgeCountExceeded| MaximumContentLengthExceeded| JoinDomainInProgress| LunInvalid| LunAlreadyAllocated_| LocalStorageLimitExceeded| InvalidSchedule| InvalidParameters| InvalidEndpoint| InvalidGateway| InternalError| InitiatorNotFound| InitiatorInvalid| IAMNotSupported| EndpointNotFound| DuplicateSchedule| DuplicateCertificateInfo| DiskSizeNotGigAligned| DiskSizeLessThanVolumeSize| DiskSizeGreaterThanVolumeMaxSize| DiskDoesNotExist| DiskAlreadyAllocated| ChapCredentialNotFound| CannotExportSnapshot| Blocked| BandwidthThrottleScheduleNotFound| AuthenticationFailure| GatewayProxyNetworkConnectionBusy| GatewayNotFound| GatewayNotConnected| GatewayInternalError| ActivationKeyNotFound| ActivationKeyInvalid| ActivationKeyExpiredtype nonrec storage_gateway_error = {error_details : error_details option;Human-readable text that provides detail about the error that occurred.
*)error_code : error_code option;Additional information about the error.
*)}Provides additional information about an error that was returned by the service. See the errorCode and errorDetails members for more information about the error.
type nonrec invalid_gateway_request_exception = {error : storage_gateway_error option;A StorageGatewayError that provides more detail about the cause of the error.
message : string_ option;A human-readable message describing the error that occurred.
*)}An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
type nonrec internal_server_error = {error : storage_gateway_error option;A StorageGatewayError that provides more information about the cause of the error.
message : string_ option;A human-readable message describing the error that occurred.
*)}An internal server error has occurred during the request. For more information, see the error and message fields.
type nonrec update_snapshot_schedule_output = {volume_ar_n : volume_ar_n option;The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
}A JSON object containing the Amazon Resource Name (ARN) of the updated storage volume.
type nonrec tag = {value : tag_value;Value of the tag key.
*)key : tag_key;Tag key. The key can't start with aws:.
*)}A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
type nonrec tags = tag listtype nonrec update_snapshot_schedule_input = {description : description option;Optional description of the snapshot that overwrites the existing description.
*)recurrence_in_hours : recurrence_in_hours;Frequency of snapshots. Specify the number of hours between snapshots.
*)start_at : hour_of_day;The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.
*)volume_ar_n : volume_ar_n;The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
}A JSON object containing one or more of the following fields:
UpdateSnapshotScheduleInput$DescriptionUpdateSnapshotScheduleInput$RecurrenceInHoursUpdateSnapshotScheduleInput$StartAtUpdateSnapshotScheduleInput$VolumeARNtype nonrec update_smb_security_strategy_input = {smb_security_strategy : smb_security_strategy;Specifies the type of security strategy.
ClientSpecified: If you choose this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Supported only for S3 File Gateway.
MandatorySigning: If you choose this option, File Gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.
MandatoryEncryption: If you choose this option, File Gateway only allows connections from SMBv3 clients that have encryption enabled. This option is recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.
MandatoryEncryptionNoAes128: If you choose this option, File Gateway only allows connections from SMBv3 clients that use 256-bit AES encryption algorithms. 128-bit algorithms are not allowed. This option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server 2012, or later.
gateway_ar_n : gateway_ar_n;}type nonrec smb_local_groups = {gateway_admins : user_list option;A list of Active Directory users and groups that have local Gateway Admin permissions. Acceptable formats include: DOMAIN\User1, user1, DOMAIN\group1, and group1.
Gateway Admins can use the Shared Folders Microsoft Management Console snap-in to force-close files that are open and locked.
*)}A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.
type nonrec update_smb_local_groups_input = {smb_local_groups : smb_local_groups;A list of Active Directory users and groups that you want to grant special permissions for SMB file shares on the gateway.
*)gateway_ar_n : gateway_ar_n;}UpdateSMBFileShareOutput
A value that sets the access control list (ACL) permission for objects in the S3 bucket that an S3 File Gateway puts objects into. The default value is private.
type nonrec cache_attributes = {cache_stale_timeout_in_seconds : cache_stale_timeout_in_seconds option;Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket or Amazon FSx file system. The TTL duration is in seconds.
Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)
*)}The refresh cache information for the file share or FSx file systems.
UpdateSMBFileShareInput
UpdateNFSFileShareOutput
type nonrec permission_id = Smaws_Lib.CoreTypes.Int64.tDescribes Network File System (NFS) file share default values. Files and folders stored as Amazon S3 objects in S3 buckets don't, by default, have Unix file permissions assigned to them. Upon discovery in an S3 bucket by Storage Gateway, the S3 objects that represent files and folders are assigned these default Unix permissions. This operation is only supported for S3 File Gateways.
UpdateNFSFileShareInput
A JSON object containing the Amazon Resource Name (ARN) of the gateway whose maintenance start time is updated.
type nonrec software_update_preferences = {automatic_update_policy : automatic_update_policy option;Indicates the automatic update policy for a gateway.
ALL_VERSIONS - Enables regular gateway maintenance updates.
EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates. The gateway will still receive emergency version updates on rare occasions if necessary to remedy highly critical security or durability issues. You will be notified before an emergency version update is applied. These updates are applied during your gateway's scheduled maintenance window.
}A set of variables indicating the software update preferences for the gateway.
type nonrec update_maintenance_start_time_input = {software_update_preferences : software_update_preferences option;A set of variables indicating the software update preferences for the gateway.
Includes AutomaticUpdatePolicy field with the following inputs:
ALL_VERSIONS - Enables regular gateway maintenance updates.
EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates. The gateway will still receive emergency version updates on rare occasions if necessary to remedy highly critical security or durability issues. You will be notified before an emergency version update is applied. These updates are applied during your gateway's scheduled maintenance window.
day_of_month : day_of_month option;The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month. It is not possible to set the maintenance schedule to start on days 29 through 31.
*)day_of_week : day_of_week option;The day of the week component of the maintenance start time week represented as an ordinal number from 0 to 6, where 0 represents Sunday and 6 represents Saturday.
*)minute_of_hour : minute_of_hour option;The minute component of the maintenance start time represented as mm, where mm is the minute (00 to 59). The minute of the hour is in the time zone of the gateway.
*)hour_of_day : hour_of_day option;The hour component of the maintenance start time represented as hh, where hh is the hour (00 to 23). The hour of the day is in the time zone of the gateway.
*)gateway_ar_n : gateway_ar_n;}A JSON object containing the following fields:
UpdateMaintenanceStartTimeInput$SoftwareUpdatePreferencesUpdateMaintenanceStartTimeInput$DayOfMonthUpdateMaintenanceStartTimeInput$DayOfWeekUpdateMaintenanceStartTimeInput$HourOfDayUpdateMaintenanceStartTimeInput$MinuteOfHourA JSON object containing the Amazon Resource Name (ARN) of the gateway that was updated.
A JSON object containing the Amazon Resource Name (ARN) of the gateway to update.
type nonrec update_gateway_information_output = {gateway_name : string_ option;The name you configured for your gateway.
*)gateway_ar_n : gateway_ar_n option;}A JSON object containing the Amazon Resource Name (ARN) of the gateway that was updated.
type nonrec update_gateway_information_input = {gateway_capacity : gateway_capacity option;Specifies the size of the gateway's metadata cache. This setting impacts gateway performance and hardware recommendations. For more information, see Performance guidance for gateways with multiple file shares in the Amazon S3 File Gateway User Guide.
*)cloud_watch_log_group_ar_n : cloud_watch_log_group_ar_n option;The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want to use to monitor and log events in the gateway.
For more information, see What is Amazon CloudWatch Logs?
*)gateway_timezone : gateway_timezone option;A value that indicates the time zone of the gateway.
*)gateway_name : gateway_name option;gateway_ar_n : gateway_ar_n;}type nonrec update_file_system_association_output = {file_system_association_ar_n : file_system_association_ar_n option;The ARN of the updated file system association.
*)}type nonrec update_file_system_association_input = {cache_attributes : cache_attributes option;audit_destination_ar_n : audit_destination_ar_n option;The Amazon Resource Name (ARN) of the storage used for the audit logs.
*)password : domain_user_password option;The password of the user credential.
*)user_name : domain_user_name option;The user name of the user credential that has permission to access the root share D$ of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.
*)file_system_association_ar_n : file_system_association_ar_n;The Amazon Resource Name (ARN) of the file system association that you want to update.
*)}type nonrec update_chap_credentials_output = {initiator_name : iqn_name option;The iSCSI initiator that connects to the target. This is the same initiator name specified in the request.
*)target_ar_n : target_ar_n option;The Amazon Resource Name (ARN) of the target. This is the same target specified in the request.
*)}A JSON object containing the following fields:
type nonrec update_chap_credentials_input = {secret_to_authenticate_target : chap_secret option;The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
Byte constraints: Minimum bytes of 12. Maximum bytes of 16.
The secret key must be between 12 and 16 bytes when encoded in UTF-8.
*)initiator_name : iqn_name;The iSCSI initiator that connects to the target.
*)secret_to_authenticate_initiator : chap_secret;The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
The secret key must be between 12 and 16 bytes when encoded in UTF-8.
*)target_ar_n : target_ar_n;The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified VolumeARN.
}A JSON object containing one or more of the following fields:
UpdateChapCredentialsInput$InitiatorNameUpdateChapCredentialsInput$SecretToAuthenticateInitiatorUpdateChapCredentialsInput$SecretToAuthenticateTargetUpdateChapCredentialsInput$TargetARNtype nonrec days_of_week = day_of_week listtype nonrec bandwidth_upload_rate_limit = Smaws_Lib.CoreTypes.Int64.ttype nonrec bandwidth_download_rate_limit = Smaws_Lib.CoreTypes.Int64.ttype nonrec bandwidth_rate_limit_interval = {average_download_rate_limit_in_bits_per_sec : bandwidth_download_rate_limit
option;The average download rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the download rate limit is not set.
S3 File Gateway does not support this feature.
*)average_upload_rate_limit_in_bits_per_sec : bandwidth_upload_rate_limit option;The average upload rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the upload rate limit is not set.
For Tape Gateway and Volume Gateway, the minimum value is 51200.
This field is required for S3 File Gateway, and the minimum value is 104857600.
days_of_week : days_of_week;The days of the week component of the bandwidth rate limit interval, represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents Saturday.
*)end_minute_of_hour : minute_of_hour;The minute of the hour to end the bandwidth rate limit interval.
The bandwidth rate limit interval ends at the end of the minute. To end an interval at the end of an hour, use the value 59.
end_hour_of_day : hour_of_day;The hour of the day to end the bandwidth rate limit interval.
*)start_minute_of_hour : minute_of_hour;The minute of the hour to start the bandwidth rate limit interval. The interval begins at the start of that minute. To begin an interval exactly at the start of the hour, use the value 0.
start_hour_of_day : hour_of_day;The hour of the day to start the bandwidth rate limit interval.
*)}Describes a bandwidth rate limit interval for a gateway. 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.
FSx File Gateway does not support this feature.
type nonrec bandwidth_rate_limit_intervals = bandwidth_rate_limit_interval listtype nonrec update_bandwidth_rate_limit_schedule_input = {bandwidth_rate_limit_intervals : bandwidth_rate_limit_intervals;An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.
*)gateway_ar_n : gateway_ar_n;}A JSON object containing the Amazon Resource Name (ARN) of the gateway whose throttle information was updated.
type nonrec update_bandwidth_rate_limit_input = {average_download_rate_limit_in_bits_per_sec : bandwidth_download_rate_limit
option;The average download bandwidth rate limit in bits per second.
*)average_upload_rate_limit_in_bits_per_sec : bandwidth_upload_rate_limit option;The average upload bandwidth rate limit in bits per second.
*)gateway_ar_n : gateway_ar_n;}A JSON object containing one or more of the following fields:
UpdateBandwidthRateLimitInput$AverageDownloadRateLimitInBitsPerSecUpdateBandwidthRateLimitInput$AverageUploadRateLimitInBitsPerSectype nonrec tape_size = Smaws_Lib.CoreTypes.Int64.ttype nonrec automatic_tape_creation_rule = {worm : boolean2 option;Set to true to indicate that tapes are to be archived as write-once-read-many (WORM). Set to false when WORM is not enabled for tapes.
minimum_num_tapes : minimum_num_tapes;The minimum number of available virtual tapes that the gateway maintains at all times. If the number of tapes on the gateway goes below this value, the gateway creates as many new tapes as are needed to have MinimumNumTapes on the gateway. For more information about automatic tape creation, see Creating Tapes Automatically.
tape_size_in_bytes : tape_size;The size, in bytes, of the virtual tape capacity.
*)pool_id : pool_id;The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the Amazon 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 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
*)tape_barcode_prefix : tape_barcode_prefix;A prefix that you append to the barcode of the virtual tape that you are creating. This prefix makes the barcode unique.
The prefix must be 1-4 characters in length and must be one of the uppercase letters from A to Z.
*)}An automatic tape creation policy consists of automatic tape creation rules where each rule defines when and how to create new tapes. For more information about automatic tape creation, see Creating Tapes Automatically.
type nonrec automatic_tape_creation_rules = automatic_tape_creation_rule listtype nonrec update_automatic_tape_creation_policy_input = {gateway_ar_n : gateway_ar_n;automatic_tape_creation_rules : automatic_tape_creation_rules;An automatic tape creation policy consists of a list of automatic tape creation rules. The rules determine when and how to automatically create new tapes.
*)}type nonrec tape_usage = Smaws_Lib.CoreTypes.Int64.ttype nonrec tape = {pool_entry_date : time option;The date that the tape enters a custom tape pool.
*)retention_start_date : time option;The date that the tape is first archived with tape retention lock enabled.
*)worm : boolean2 option;If the tape is archived as write-once-read-many (WORM), this value is true.
pool_id : pool_id option;The ID of the pool that contains tapes that will be archived. The tapes in this pool are 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 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
*)kms_key : kms_key option;tape_used_in_bytes : tape_usage option;The size, in bytes, of data stored on the virtual tape.
This value is not available for tapes created prior to May 13, 2015.
*)progress : double_object option;For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.
Range: 0 (not started) to 100 (complete).
*)vtl_device : vtl_device_ar_n option;The virtual tape library (VTL) device that the virtual tape is associated with.
*)tape_status : tape_status option;The current state of the virtual tape.
*)tape_size_in_bytes : tape_size option;The size, in bytes, of the virtual tape capacity.
*)tape_created_date : time option;The date the virtual tape was created.
*)tape_barcode : tape_barcode option;The barcode that identifies a specific virtual tape.
*)tape_ar_n : tape_ar_n option;The Amazon Resource Name (ARN) of the virtual tape.
*)}Describes a virtual tape object.
type nonrec tapes = tape listtype nonrec tape_recovery_point_info = {tape_status : tape_recovery_point_status option;The status of the virtual tapes.
*)tape_size_in_bytes : tape_size option;The size, in bytes, of the virtual tapes to recover.
*)tape_recovery_point_time : time option;The time when the point-in-time view of the virtual tape was replicated for later recovery.
The default timestamp format of the tape recovery point time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
*)tape_ar_n : tape_ar_n option;The Amazon Resource Name (ARN) of the virtual tape.
*)}Describes a recovery point.
type nonrec tape_recovery_point_infos = tape_recovery_point_info listtype nonrec tape_info = {pool_entry_date : time option;The date that the tape entered the custom tape pool with tape retention lock enabled.
*)retention_start_date : time option;The date that the tape became subject to tape retention lock.
*)pool_id : pool_id option;The ID of the pool that you want to add your tape to for archiving. The tape in this 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 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
*)gateway_ar_n : gateway_ar_n option;The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
tape_status : tape_status option;The status of the tape.
*)tape_size_in_bytes : tape_size option;The size, in bytes, of a virtual tape.
*)tape_barcode : tape_barcode option;The barcode that identifies a specific virtual tape.
*)tape_ar_n : tape_ar_n option;The Amazon Resource Name (ARN) of a virtual tape.
*)}Describes a virtual tape.
type nonrec tape_infos = tape_info listtype nonrec tape_archive = {pool_entry_date : time option;The time that the tape entered the custom tape pool.
The default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
*)retention_start_date : time option;If the archived tape is subject to tape retention lock, the date that the archived tape started being retained.
*)worm : boolean2 option;Set to true if the archived tape is stored as write-once-read-many (WORM).
pool_id : pool_id option;The ID of the pool that was used to archive the tape. The tapes in this pool are archived in the S3 storage class that is associated with the pool.
*)kms_key : kms_key option;tape_used_in_bytes : tape_usage option;The size, in bytes, of data stored on the virtual tape.
This value is not available for tapes created prior to May 13, 2015.
*)tape_status : tape_archive_status option;The current state of the archived virtual tape.
*)retrieved_to : gateway_ar_n option;The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being retrieved to.
The virtual tape is retrieved from the virtual tape shelf (VTS).
*)completion_time : time option;The time that the archiving of the virtual tape was completed.
The default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
*)tape_size_in_bytes : tape_size option;The size, in bytes, of the archived virtual tape.
*)tape_created_date : time option;The date the virtual tape was created.
*)tape_barcode : tape_barcode option;The barcode that identifies the archived virtual tape.
*)tape_ar_n : tape_ar_n option;The Amazon Resource Name (ARN) of an archived virtual tape.
*)}Represents a virtual tape that is archived in the virtual tape shelf (VTS).
type nonrec tape_archives = tape_archive listtype nonrec tape_ar_ns = tape_ar_n listtype nonrec tag_keys = tag_key listtype nonrec supported_gateway_capacities = gateway_capacity listtype nonrec storedi_scsi_volume = {target_name : target_name option;The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.
*)kms_key : kms_key option;volume_used_in_bytes : volume_used_in_bytes option;The size of the data stored on the volume in bytes. This value is calculated based on the number of blocks that are touched, instead of the actual amount of data written. This value can be useful for sequential write patterns but less accurate for random write patterns. VolumeUsedInBytes is different from the compressed size of the volume, which is the value that is used to calculate your bill.
This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.
*)created_date : created_date option;The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.
*)volumei_scsi_attributes : volumei_scsi_attributes option;An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
preserved_existing_data : boolean2 option;Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.
Valid Values: true | false
source_snapshot_id : snapshot_id option;If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.
*)volume_disk_id : disk_id option;The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.
volume_progress : double_object option;Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.
*)volume_size_in_bytes : long option;The size of the volume in bytes.
*)volume_attachment_status : volume_attachment_status option;A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway. For more information, see Moving your volumes to a different gateway.
*)volume_status : volume_status option;One of the VolumeStatus values that indicates the state of the storage volume.
*)volume_type : volume_type option;One of the VolumeType enumeration values describing the type of the volume.
*)volume_id : volume_id option;The unique identifier of the volume, e.g., vol-AE4B946D.
*)volume_ar_n : volume_ar_n option;The Amazon Resource Name (ARN) of the storage volume.
*)}Describes an iSCSI stored volume.
type nonrec storedi_scsi_volumes = storedi_scsi_volume listA JSON object containing the Amazon Resource Name (ARN) of the gateway that was restarted.
A JSON object containing the Amazon Resource Name (ARN) of the gateway to start.
type nonrec start_cache_report_output = {cache_report_ar_n : cache_report_ar_n option;The Amazon Resource Name (ARN) of the cache report generated by the StartCacheReport request.
}type nonrec cache_report_filter_values = cache_report_filter_value listtype nonrec cache_report_filter = {values : cache_report_filter_values;The parameter value for a filter that determines which files are included or excluded from a cache report.
Valid UploadFailureReason Values:
InaccessibleStorageClass | InvalidObjectState | ObjectMissing | S3AccessDenied
Valid UploadState Values:
FailingUpload
name : cache_report_filter_name;The parameter name for a filter that determines which files are included or excluded from a cache report.
Valid Names:
UploadFailureReason | UploadState
*)}A list of filter parameters and associated values that determine which files are included or excluded from a cache report created by a StartCacheReport request. Multiple instances of the same filter parameter are combined with an OR operation, while different parameters are combined with an AND operation.
type nonrec cache_report_filter_list = cache_report_filter listtype nonrec start_cache_report_input = {client_token : client_token;A unique identifier that you use to ensure idempotent report generation if you need to retry an unsuccessful StartCacheReport request. If you retry a request, use the same ClientToken you specified in the initial request.
exclusion_filters : cache_report_filter_list option;The list of filters and parameters that determine which files are excluded from the report. You must specify at least one value for InclusionFilters or ExclusionFilters in a StartCacheReport request.
inclusion_filters : cache_report_filter_list option;The list of filters and parameters that determine which files are included in the report. You must specify at least one value for InclusionFilters or ExclusionFilters in a StartCacheReport request.
vpc_endpoint_dns_name : dns_host_name option;The DNS name of the VPC endpoint associated with the Amazon S3 where you want to save the cache report. Optional.
*)bucket_region : region_id;The Amazon Web Services Region of the Amazon S3 bucket where you want to save the cache report.
*)location_ar_n : location_ar_n;The ARN of the Amazon S3 bucket where you want to save the cache report.
We do not recommend saving the cache report to the same Amazon S3 bucket for which you are generating the report.
This field does not accept access point ARNs.
*)role : role;The ARN of the IAM role used when saving the cache report to Amazon S3.
*)}A JSON object containing the Amazon Resource Name (ARN) of the gateway that was shut down.
A JSON object containing the Amazon Resource Name (ARN) of the gateway to shut down.
type nonrec set_smb_guest_password_input = {password : smb_guest_password;The password that you want to set for your SMB server.
*)gateway_ar_n : gateway_ar_n;The Amazon Resource Name (ARN) of the S3 File Gateway the SMB file share is associated with.
*)}SetSMBGuestPasswordInput
type nonrec set_local_console_password_input = {local_console_password : local_console_password;The password you want to set for your VM local console.
*)gateway_ar_n : gateway_ar_n;}SetLocalConsolePasswordInput
type nonrec retrieve_tape_recovery_point_output = {tape_ar_n : tape_ar_n option;The Amazon Resource Name (ARN) of the virtual tape for which the recovery point was retrieved.
*)}RetrieveTapeRecoveryPointOutput
type nonrec retrieve_tape_recovery_point_input = {gateway_ar_n : gateway_ar_n;tape_ar_n : tape_ar_n;The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the recovery point.
*)}RetrieveTapeRecoveryPointInput
type nonrec retrieve_tape_archive_output = {tape_ar_n : tape_ar_n option;The Amazon Resource Name (ARN) of the retrieved virtual tape.
*)}RetrieveTapeArchiveOutput
type nonrec retrieve_tape_archive_input = {gateway_ar_n : gateway_ar_n;The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
You retrieve archived virtual tapes to only one gateway and the gateway must be a tape gateway.
*)tape_ar_n : tape_ar_n;The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS).
*)}RetrieveTapeArchiveInput
RefreshCacheOutput
type nonrec folder_list = folder listtype nonrec refresh_cache_input = {recursive : boolean_ option;A value that specifies whether to recursively refresh folders in the cache. The refresh includes folders that were in the cache the last time the gateway listed the folder's contents. If this value set to true, each folder that is listed in FolderList is recursively updated. Otherwise, subfolders listed in FolderList are not refreshed. Only objects that are in folders listed directly under FolderList are found and used for the update. The default is true.
Valid Values: true | false
folder_list : folder_list option;A comma-separated list of the paths of folders to refresh in the cache. The default is ["/"]. The default refreshes objects and folders at the root of the Amazon S3 bucket. If Recursive is set to true, the entire S3 bucket that the file share has access to is refreshed.
Do not include / when specifying folder names. For example, you would specify samplefolder rather than samplefolder/.
}RefreshCacheInput
type nonrec list_volumes_output = {volume_infos : volume_infos option;An array of VolumeInfo objects, where each object describes an iSCSI volume. If no volumes are defined for the gateway, then VolumeInfos is an empty array "[]".
marker : marker option;Use the marker in your next request to continue pagination of iSCSI volumes. If there are no more volumes to list, this field does not appear in the response body.
*)gateway_ar_n : gateway_ar_n option;}A JSON object containing the following fields:
ListVolumesOutput$MarkerListVolumesOutput$VolumeInfostype nonrec list_volumes_input = {limit : positive_int_object option;Specifies that the list of volumes returned be limited to the specified number of items.
*)marker : marker option;A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.
*)gateway_ar_n : gateway_ar_n option;}A JSON object that contains one or more of the following fields:
ListVolumesInput$LimitListVolumesInput$Markertype nonrec list_volume_recovery_points_output = {volume_recovery_point_infos : volume_recovery_point_infos option;An array of VolumeRecoveryPointInfo objects.
gateway_ar_n : gateway_ar_n option;}type nonrec initiators = initiator listtype nonrec list_volume_initiators_output = {initiators : initiators option;The host names and port numbers of all iSCSI initiators that are connected to the gateway.
*)}ListVolumeInitiatorsOutput
type nonrec list_volume_initiators_input = {volume_ar_n : volume_ar_n;The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes for the gateway.
}ListVolumeInitiatorsInput
type nonrec list_tapes_output = {marker : marker option;A string that indicates the position at which to begin returning the next list of tapes. Use the marker in your next request to continue pagination of tapes. If there are no more tapes to list, this element does not appear in the response body.
*)tape_infos : tape_infos option;}A JSON object containing the following fields:
ListTapesOutput$MarkerListTapesOutput$VolumeInfostype nonrec list_tapes_input = {limit : positive_int_object option;An optional number limit for the tapes in the list returned by this call.
*)marker : marker option;A string that indicates the position at which to begin the returned list of tapes.
*)tape_ar_ns : tape_ar_ns option;}A JSON object that contains one or more of the following fields:
ListTapesInput$LimitListTapesInput$MarkerListTapesInput$TapeARNstype nonrec pool_info = {pool_status : pool_status option;Status of the custom tape pool. Pool can be ACTIVE or DELETED.
retention_lock_time_in_days : retention_lock_time_in_days option;Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days).
*)retention_lock_type : retention_lock_type option;Tape retention lock type, which can be configured in two modes. When configured in governance mode, Amazon Web Services accounts with specific IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot be removed by any user, including the root Amazon Web Services account.
*)storage_class : tape_storage_class option;The storage class that is associated with the custom pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
*)pool_name : pool_name option;The name of the custom tape pool. PoolName can use all ASCII characters, except '/' and '\'.
pool_ar_n : pool_ar_n option;The Amazon Resource Name (ARN) of the custom tape pool. Use the ListTapePools operation to return a list of custom tape pools for your account and Amazon Web Services Region.
}Describes a custom tape pool.
type nonrec pool_infos = pool_info listtype nonrec list_tape_pools_output = {marker : marker option;A string that indicates the position at which to begin the returned list of tape pools. Use the marker in your next request to continue pagination of tape pools. If there are no more tape pools to list, this element does not appear in the response body.
*)pool_infos : pool_infos option;An array of PoolInfo objects, where each object describes a single custom tape pool. If there are no custom tape pools, the PoolInfos is an empty array.
}type nonrec pool_ar_ns = pool_ar_n listtype nonrec list_tape_pools_input = {limit : positive_int_object option;An optional number limit for the tape pools in the list returned by this call.
*)marker : marker option;A string that indicates the position at which to begin the returned list of tape pools.
*)pool_ar_ns : pool_ar_ns option;The Amazon Resource Name (ARN) of each of the custom tape pools you want to list. If you don't specify a custom tape pool ARN, the response lists all custom tape pools.
*)}type nonrec disk_attribute_list = disk_attribute listtype nonrec disk = {disk_attribute_list : disk_attribute_list option;disk_allocation_resource : string_ option;The iSCSI qualified name (IQN) that is defined for a disk. This field is not included in the response if the local disk is not defined as an iSCSI target. The format of this field is targetIqn::LUNNumber::region-volumeId.
*)disk_allocation_type : disk_allocation_type option;disk_size_in_bytes : long option;The local disk size in bytes.
*)disk_status : string_ option;A value that represents the status of a local disk.
*)disk_node : string_ option;The device node of a local disk as assigned by the virtualization environment.
*)disk_path : string_ option;The path of a local disk in the gateway virtual machine (VM).
*)disk_id : disk_id option;The unique device ID or other distinguishing data that identifies a local disk.
*)}Represents a gateway's local disk.
type nonrec disks = disk listtype nonrec list_local_disks_output = {disks : disks option;A JSON object containing the following fields:
ListLocalDisksOutput$Disksgateway_ar_n : gateway_ar_n option;}A JSON object containing the Amazon Resource Name (ARN) of the gateway.
type nonrec gateway_info = {software_version : software_version option;The version number of the software running on the gateway appliance.
*)deprecation_date : deprecation_date option;Date after which this gateway will not receive software updates for new features and bug fixes.
*)host_environment_id : host_environment_id option;A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.
*)host_environment : host_environment option;The type of hardware or software platform on which the gateway is running.
Tape Gateway is no longer available on Snow Family devices.
*)ec2_instance_region : ec2_instance_region option;The Amazon Web Services Region where the Amazon EC2 instance is located.
*)ec2_instance_id : ec2_instance_id option;The ID of the Amazon EC2 instance that was used to launch the gateway.
*)gateway_name : string_ option;The name of the gateway.
*)gateway_operational_state : gateway_operational_state option;The state of the gateway.
Valid Values: DISABLED | ACTIVE
gateway_type : gateway_type option;The type of the gateway.
Amazon FSx File Gateway is no longer available to new customers. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit this blog post.
*)gateway_ar_n : gateway_ar_n option;The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
gateway_id : gateway_id option;The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.
*)}Describes a gateway object.
type nonrec gateways = gateway_info listtype nonrec list_gateways_input = {limit : positive_int_object option;Specifies that the list of gateways returned be limited to the specified number of items.
*)marker : marker option;An opaque string that indicates the position at which to begin the returned list of gateways.
*)}A JSON object containing zero or more of the following fields:
ListGatewaysInput$LimitListGatewaysInput$Markertype nonrec file_system_association_summary = {gateway_ar_n : gateway_ar_n option;file_system_association_status : file_system_association_status option;The status of the file share. Valid Values: AVAILABLE | CREATING | DELETING | FORCE_DELETING | UPDATING | ERROR
file_system_association_ar_n : file_system_association_ar_n option;The Amazon Resource Name (ARN) of the file system association.
*)file_system_association_id : file_system_association_id option;The ID of the file system association.
*)}Gets the summary returned by ListFileSystemAssociation, which is a summary of a created file system association.
type nonrec file_system_association_summary_list =
file_system_association_summary listtype nonrec list_file_system_associations_output = {file_system_association_summary_list : file_system_association_summary_list
option;An array of information about the Amazon FSx gateway's file system associations.
*)next_marker : marker option;If a value is present, there are more file system associations to return. In a subsequent request, use NextMarker as the value for Marker to retrieve the next set of file system associations.
marker : marker option;If the request includes Marker, the response returns that value in this field.
}type nonrec list_file_system_associations_input = {marker : marker option;Opaque pagination token returned from a previous ListFileSystemAssociations operation. If present, Marker specifies where to continue the list from after a previous call to ListFileSystemAssociations. Optional.
limit : positive_int_object option;The maximum number of file system associations to return in the response. If present, Limit must be an integer with a value greater than zero. Optional.
gateway_ar_n : gateway_ar_n option;}The type of the file share.
Describes a file share. Only supported S3 File Gateway.
ListFileShareOutput
ListFileShareInput
type nonrec cache_report_info = {report_name : cache_report_name option;The file name of the completed cache report object stored in Amazon S3.
*)exclusion_filters : cache_report_filter_list option;The list of filters and parameters that determine which files are excluded from the report.
*)inclusion_filters : cache_report_filter_list option;The list of filters and parameters that determine which files are included in the report.
*)start_time : time option;The time at which the gateway started generating the cache report.
*)location_ar_n : location_ar_n option;The ARN of the Amazon S3 bucket location where the cache report is saved.
*)role : role option;end_time : time option;The time at which the gateway stopped generating the cache report.
*)report_completion_percent : report_completion_percent option;The percentage of the report generation process that has been completed at time of inquiry.
*)cache_report_status : cache_report_status option;The status of the specified cache report.
*)cache_report_ar_n : cache_report_ar_n option;The Amazon Resource Name (ARN) of the cache report you want to describe.
*)}Contains all informational fields associated with a cache report. Includes name, ARN, tags, status, progress, filters, start time, and end time.
type nonrec cache_report_list = cache_report_info listtype nonrec list_cache_reports_output = {marker : marker option;If the request includes Marker, the response returns that value in this field.
cache_report_list : cache_report_list option;A list of existing cache reports for all file shares associated with your Amazon Web Services account. This list includes all information provided by the DescribeCacheReport action, such as report status, completion progress, start time, end time, filters, and tags.
}type nonrec list_cache_reports_input = {marker : marker option;Opaque pagination token returned from a previous ListCacheReports operation. If present, Marker specifies where to continue the list from after a previous call to ListCacheReports. Optional.
}type nonrec automatic_tape_creation_policy_info = {gateway_ar_n : gateway_ar_n option;automatic_tape_creation_rules : automatic_tape_creation_rules option;An automatic tape creation policy consists of a list of automatic tape creation rules. This returns the rules that determine when and how to automatically create new tapes.
*)}Information about the gateway's automatic tape creation policies, including the automatic tape creation rules and the gateway that is using the policies.
type nonrec automatic_tape_creation_policy_infos =
automatic_tape_creation_policy_info listtype nonrec list_automatic_tape_creation_policies_output = {automatic_tape_creation_policy_infos : automatic_tape_creation_policy_infos
option;Gets a listing of information about the gateway's automatic tape creation policies, including the automatic tape creation rules and the gateway that is using the policies.
*)}type nonrec join_domain_output = {active_directory_status : active_directory_status option;Indicates the status of the gateway as a member of the Active Directory domain.
This field is only used as part of a JoinDomain request. It is not affected by Active Directory connectivity changes that occur after the JoinDomain request succeeds.
ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.DETACHED: Indicates that gateway is not joined to a domain.JOINED: Indicates that the gateway has successfully joined a domain.JOINING: Indicates that a JoinDomain operation is in progress.INSUFFICIENT_PERMISSIONS: Indicates that the JoinDomain operation failed because the specified user lacks the necessary permissions to join the domain.NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.gateway_ar_n : gateway_ar_n option;The unique Amazon Resource Name (ARN) of the gateway that joined the domain.
*)}JoinDomainOutput
type nonrec hosts = host listtype nonrec join_domain_input = {password : domain_user_password;Sets the password of the user who has permission to add the gateway to the Active Directory domain.
*)user_name : domain_user_name;Sets the user name of user who has permission to add the gateway to the Active Directory domain. The domain user account should be enabled to join computers to the domain. For example, you can use the domain administrator account or an account with delegated permissions to join computers to the domain.
*)timeout_in_seconds : timeout_in_seconds option;Specifies the time in seconds, in which the JoinDomain operation must complete. The default is 20 seconds.
domain_controllers : hosts option;List of IP addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, mydc.mydomain.com:389.
S3 File Gateway supports IPv6 addresses in addition to IPv4 and other existing formats.
FSx File Gateway does not support IPv6.
*)organizational_unit : organizational_unit option;The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.
*)domain_name : domain_name;The name of the domain that you want the gateway to join.
*)gateway_ar_n : gateway_ar_n;The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
}JoinDomainInput
type nonrec evict_files_failing_upload_output = {notification_id : string_ option;The randomly generated ID of the CloudWatch notification associated with the cache clean operation. This ID is in UUID format.
*)}type nonrec evict_files_failing_upload_input = {force_remove : boolean2 option;Specifies whether cache entries with full or partial file data currently stored on the gateway will be forcibly removed by the cache clean operation.
Valid arguments:
False - The cache clean operation skips cache entries failing upload if they are associated with data currently stored on the gateway. This preserves the cached data.True - The cache clean operation removes cache entries failing upload even if they are associated with data currently stored on the gateway. This deletes the cached data.
If ForceRemove is set to True, the cache clean operation will delete file data from the gateway which might otherwise be recoverable.
}type nonrec disassociate_file_system_output = {file_system_association_ar_n : file_system_association_ar_n option;The Amazon Resource Name (ARN) of the deleted file system association.
*)}type nonrec disassociate_file_system_input = {force_delete : boolean2 option;If this value is set to true, the operation disassociates an Amazon FSx file system immediately. It ends all data uploads to the file system, and the file system association enters the FORCE_DELETING status. If this value is set to false, the Amazon FSx file system does not disassociate until all data is uploaded.
file_system_association_ar_n : file_system_association_ar_n;The Amazon Resource Name (ARN) of the file system association to be deleted.
*)}type nonrec disable_gateway_output = {gateway_ar_n : gateway_ar_n option;The unique Amazon Resource Name (ARN) of the disabled gateway.
*)}DisableGatewayOutput
DisableGatewayInput
type nonrec detach_volume_output = {volume_ar_n : volume_ar_n option;The Amazon Resource Name (ARN) of the volume that was detached.
*)}AttachVolumeOutput
type nonrec detach_volume_input = {force_detach : boolean_ option;Set to true to forcibly remove the iSCSI connection of the target volume and detach the volume. The default is false. If this value is set to false, you must manually disconnect the iSCSI connection from the target volume.
Valid Values: true | false
volume_ar_n : volume_ar_n;The Amazon Resource Name (ARN) of the volume to detach from the gateway.
*)}AttachVolumeInput
type nonrec disk_ids = disk_id listtype nonrec describe_working_storage_output = {working_storage_allocated_in_bytes : long option;The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0.
*)working_storage_used_in_bytes : long option;The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0.
*)disk_ids : disk_ids option;An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.
*)gateway_ar_n : gateway_ar_n option;}A JSON object containing the following fields:
A JSON object containing the Amazon Resource Name (ARN) of the gateway.
type nonrec describe_vtl_devices_output = {marker : marker option;An opaque string that indicates the position at which the VTL devices that were fetched for description ended. Use the marker in your next request to fetch the next set of VTL devices in the list. If there are no more VTL devices to describe, this field does not appear in the response.
*)vtl_devices : vtl_devices option;An array of VTL device objects composed of the Amazon Resource Name (ARN) of the VTL devices.
*)gateway_ar_n : gateway_ar_n option;}DescribeVTLDevicesOutput
type nonrec describe_vtl_devices_input = {limit : positive_int_object option;Specifies that the number of VTL devices described be limited to the specified number.
*)marker : marker option;An opaque string that indicates the position at which to begin describing the VTL devices.
*)vtl_device_ar_ns : vtl_device_ar_ns option;An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.
All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.
*)gateway_ar_n : gateway_ar_n;}DescribeVTLDevicesInput
type nonrec describe_upload_buffer_output = {upload_buffer_allocated_in_bytes : long option;The total number of bytes allocated in the gateway's as upload buffer.
*)upload_buffer_used_in_bytes : long option;The total number of bytes being used in the gateway's upload buffer.
*)disk_ids : disk_ids option;An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.
*)gateway_ar_n : gateway_ar_n option;}type nonrec describe_tapes_output = {marker : marker option;An opaque string that can be used as part of a subsequent DescribeTapes call to retrieve the next page of results.
If a response does not contain a marker, then there are no more results to be retrieved.
*)tapes : tapes option;An array of virtual tape descriptions.
*)}DescribeTapesOutput
type nonrec describe_tapes_input = {limit : positive_int_object option;Specifies that the number of virtual tapes described be limited to the specified number.
Amazon Web Services may impose its own limit, if this field is not set.
*)marker : marker option;A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve.
If not specified, the first page of results is retrieved.
*)tape_ar_ns : tape_ar_ns option;Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.
*)gateway_ar_n : gateway_ar_n;}DescribeTapesInput
type nonrec describe_tape_recovery_points_output = {marker : marker option;An opaque string that indicates the position at which the virtual tape recovery points that were listed for description ended.
Use this marker in your next request to list the next set of virtual tape recovery points in the list. If there are no more recovery points to describe, this field does not appear in the response.
*)tape_recovery_point_infos : tape_recovery_point_infos option;An array of TapeRecoveryPointInfos that are available for the specified gateway.
*)gateway_ar_n : gateway_ar_n option;}DescribeTapeRecoveryPointsOutput
type nonrec describe_tape_recovery_points_input = {limit : positive_int_object option;Specifies that the number of virtual tape recovery points that are described be limited to the specified number.
*)marker : marker option;An opaque string that indicates the position at which to begin describing the virtual tape recovery points.
*)gateway_ar_n : gateway_ar_n;}DescribeTapeRecoveryPointsInput
type nonrec describe_tape_archives_output = {marker : marker option;An opaque string that indicates the position at which the virtual tapes that were fetched for description ended. Use this marker in your next request to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to describe, this field does not appear in the response.
*)tape_archives : tape_archives option;An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name (ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description, and tape barcode.
*)}DescribeTapeArchivesOutput
type nonrec describe_tape_archives_input = {limit : positive_int_object option;Specifies that the number of virtual tapes described be limited to the specified number.
*)marker : marker option;An opaque string that indicates the position at which to begin describing virtual tapes.
*)tape_ar_ns : tape_ar_ns option;Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.
*)}DescribeTapeArchivesInput
type nonrec describe_storedi_scsi_volumes_output = {storedi_scsi_volumes : storedi_scsi_volumes option;Describes a single unit of output from DescribeStorediSCSIVolumes. The following fields are returned:
ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target.LunNumber: The logical disk number.NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map the stored volume as an iSCSI target.NetworkInterfacePort: The port used to communicate with iSCSI targets.PreservedExistingData: Indicates when the stored volume was created, existing data on the underlying local disk was preserved.SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-1122aabb. Otherwise, this field is not included.StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata about one stored volume.TargetARN: The Amazon Resource Name (ARN) of the volume target.VolumeARN: The Amazon Resource Name (ARN) of the stored volume.VolumeDiskId: The disk ID of the local disk that was specified in the CreateStorediSCSIVolume operation.VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB.VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.VolumeProgress: Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.VolumeSizeInBytes: The size of the volume in bytes.VolumeStatus: One of the VolumeStatus values that indicates the state of the volume.VolumeType: One of the enumeration values describing the type of the volume. Currently, only STORED volumes are supported.}type nonrec describe_storedi_scsi_volumes_input = {volume_ar_ns : volume_ar_ns;An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must be from the same gateway. Use ListVolumes to get volume ARNs for a gateway.
}A JSON object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.
type nonrec describe_snapshot_schedule_output = {timezone : gateway_timezone option;A value that indicates the time zone of the gateway.
*)description : description option;The snapshot description.
*)recurrence_in_hours : recurrence_in_hours option;The number of hours between snapshots.
*)start_at : hour_of_day option;The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.
*)volume_ar_n : volume_ar_n option;The Amazon Resource Name (ARN) of the volume that was specified in the request.
*)}type nonrec describe_snapshot_schedule_input = {volume_ar_n : volume_ar_n;The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
}A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the volume.
type nonrec describe_smb_settings_output = {smb_local_groups : smb_local_groups option;A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.
*)smb_security_strategy : smb_security_strategy option;The type of security strategy that was specified for file gateway.
ClientSpecified: If you choose this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Supported only for S3 File Gateway.MandatorySigning: If you choose this option, File Gateway only allows connections from SMBv2 or SMBv3 clients that have signing turned on. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008, or later.MandatoryEncryption: If you choose this option, File Gateway only allows connections from SMBv3 clients that have encryption turned on. Both 256-bit and 128-bit algorithms are allowed. This option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server 2012, or later.MandatoryEncryptionNoAes128: If you choose this option, File Gateway only allows connections from SMBv3 clients that use 256-bit AES encryption algorithms. 128-bit algorithms are not allowed. This option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server 2012, or later.smb_guest_password_set : boolean_ option;This value is true if a password for the guest user smbguest is set, otherwise false. Only supported for S3 File Gateways.
Valid Values: true | false
active_directory_status : active_directory_status option;Indicates the status of a gateway that is a member of the Active Directory domain.
This field is only used as part of a JoinDomain request. It is not affected by Active Directory connectivity changes that occur after the JoinDomain request succeeds.
ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.DETACHED: Indicates that gateway is not joined to a domain.JOINED: Indicates that the gateway has successfully joined a domain.JOINING: Indicates that a JoinDomain operation is in progress.NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.domain_name : domain_name option;The name of the domain that the gateway is joined to.
*)gateway_ar_n : gateway_ar_n option;}The Windows file permissions and ownership information assigned, by default, to native S3 objects when S3 File Gateway discovers them in S3 buckets. This operation is only supported for S3 File Gateways.
DescribeSMBFileSharesOutput
DescribeSMBFileSharesInput
The Unix file permissions and ownership information assigned, by default, to native S3 objects when an S3 File Gateway discovers them in S3 buckets. This operation is only supported in S3 File Gateways.
DescribeNFSFileSharesOutput
DescribeNFSFileSharesInput
type nonrec describe_maintenance_start_time_output = {software_update_preferences : software_update_preferences option;A set of variables indicating the software update preferences for the gateway.
Includes AutomaticUpdatePolicy parameter with the following inputs:
ALL_VERSIONS - Enables regular gateway maintenance updates.
EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates. The gateway will still receive emergency version updates on rare occasions if necessary to remedy highly critical security or durability issues. You will be notified before an emergency version update is applied. These updates are applied during your gateway's scheduled maintenance window.
timezone : gateway_timezone option;A value that indicates the time zone that is set for the gateway. The start time and day of week specified should be in the time zone of the gateway.
*)day_of_month : day_of_month option;The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month. It is not possible to set the maintenance schedule to start on days 29 through 31.
*)day_of_week : day_of_week option;An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday and 6 represents Saturday. The day of week is in the time zone of the gateway.
*)minute_of_hour : minute_of_hour option;The minute component of the maintenance start time represented as mm, where mm is the minute (0 to 59). The minute of the hour is in the time zone of the gateway.
*)hour_of_day : hour_of_day option;The hour component of the maintenance start time represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.
*)gateway_ar_n : gateway_ar_n option;}A JSON object containing the following fields:
DescribeMaintenanceStartTimeOutput$SoftwareUpdatePreferencesDescribeMaintenanceStartTimeOutput$DayOfMonthDescribeMaintenanceStartTimeOutput$DayOfWeekDescribeMaintenanceStartTimeOutput$HourOfDayDescribeMaintenanceStartTimeOutput$MinuteOfHourDescribeMaintenanceStartTimeOutput$TimezoneA JSON object containing the Amazon Resource Name (ARN) of the gateway.
type nonrec network_interface = {ipv6_address : string_ option;The Internet Protocol version 6 (IPv6) address of the interface.
This element returns IPv6 addresses for all gateway types except FSx File Gateway.
*)mac_address : string_ option;The Media Access Control (MAC) address of the interface.
This is currently unsupported and will not be returned in output.
*)ipv4_address : string_ option;The Internet Protocol version 4 (IPv4) address of the interface.
*)}Describes a gateway's network interface.
type nonrec gateway_network_interfaces = network_interface listtype nonrec describe_gateway_information_output = {software_version : software_version option;The version number of the software running on the gateway appliance.
*)host_environment_id : host_environment_id option;A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.
*)supported_gateway_capacities : supported_gateway_capacities option;A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.
*)gateway_capacity : gateway_capacity option;Specifies the size of the gateway's metadata cache.
*)deprecation_date : deprecation_date option;Date after which this gateway will not receive software updates for new features and bug fixes.
*)software_updates_end_date : software_updates_end_date option;Date after which this gateway will not receive software updates for new features.
*)endpoint_type : endpoint_type option;The type of endpoint for your gateway.
Valid Values: STANDARD | FIPS
host_environment : host_environment option;The type of hardware or software platform on which the gateway is running.
Tape Gateway is no longer available on Snow Family devices.
*)cloud_watch_log_group_ar_n : cloud_watch_log_group_ar_n option;The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway. This field only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM
*)vpc_endpoint : string_ option;The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.
*)ec2_instance_region : ec2_instance_region option;The Amazon Web Services Region where the Amazon EC2 instance is located.
*)ec2_instance_id : ec2_instance_id option;The ID of the Amazon EC2 instance that was used to launch the gateway.
*)last_software_update : last_software_update option;The date on which the last software update was applied to the gateway. If the gateway has never been updated, this field does not return a value in the response. This only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM
*)next_update_availability_date : next_update_availability_date option;The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.
*)gateway_type : gateway_type option;The type of the gateway.
Amazon FSx File Gateway is no longer available to new customers. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit this blog post.
*)gateway_network_interfaces : gateway_network_interfaces option;A NetworkInterface array that contains descriptions of the gateway network interfaces.
gateway_state : gateway_state option;A value that indicates the operating state of the gateway.
*)gateway_timezone : gateway_timezone option;A value that indicates the time zone configured for the gateway.
*)gateway_name : string_ option;The name you configured for your gateway.
*)gateway_id : gateway_id option;The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.
*)gateway_ar_n : gateway_ar_n option;}A JSON object containing the following fields:
A JSON object containing the ID of the gateway.
type nonrec ip_address_list = ipv4_address listtype nonrec endpoint_network_configuration = {ip_addresses : ip_address_list option;A list of gateway IP addresses on which the associated Amazon FSx file system is available.
If multiple file systems are associated with this gateway, this field is required.
*)}Specifies network configuration information for the gateway associated with the Amazon FSx file system.
type nonrec file_system_association_status_detail = {error_code : file_system_association_sync_error_code option;The error code for a given file system association status.
*)}Detailed information on file system association status.
type nonrec file_system_association_status_details =
file_system_association_status_detail listtype nonrec file_system_association_info = {file_system_association_status_details : file_system_association_status_details
option;An array containing the FileSystemAssociationStatusDetail data type, which provides detailed information on file system association status.
*)endpoint_network_configuration : endpoint_network_configuration option;Specifies network configuration information for the gateway associated with the Amazon FSx file system.
If multiple file systems are associated with this gateway, this parameter's IpAddresses field is required.
cache_attributes : cache_attributes option;gateway_ar_n : gateway_ar_n option;audit_destination_ar_n : audit_destination_ar_n option;The Amazon Resource Name (ARN) of the storage used for the audit logs.
*)file_system_association_status : file_system_association_status option;The status of the file system association. Valid Values: AVAILABLE | CREATING | DELETING | FORCE_DELETING | UPDATING | ERROR
location_ar_n : file_system_location_ar_n option;The ARN of the backend Amazon FSx file system used for storing file data. For information, see FileSystem in the Amazon FSx API Reference.
*)file_system_association_ar_n : file_system_association_ar_n option;The Amazon Resource Name (ARN) of the file system association.
*)}Describes the object returned by DescribeFileSystemAssociations that describes a created file system association.
type nonrec file_system_association_info_list =
file_system_association_info listtype nonrec describe_file_system_associations_output = {file_system_association_info_list : file_system_association_info_list option;An array containing the FileSystemAssociationInfo data type of each file system association to be described.
}type nonrec file_system_association_arn_list =
file_system_association_ar_n listtype nonrec describe_file_system_associations_input = {file_system_association_arn_list : file_system_association_arn_list;An array containing the Amazon Resource Name (ARN) of each file system association to be described.
*)}type nonrec chap_info = {secret_to_authenticate_target : chap_secret option;The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g., Windows client).
*)initiator_name : iqn_name option;The iSCSI initiator that connects to the target.
*)secret_to_authenticate_initiator : chap_secret option;The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
*)target_ar_n : target_ar_n option;The Amazon Resource Name (ARN) of the volume.
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
*)}Describes Challenge-Handshake Authentication Protocol (CHAP) information that supports authentication between your gateway and iSCSI initiators.
type nonrec chap_credentials = chap_info listtype nonrec describe_chap_credentials_output = {chap_credentials : chap_credentials option;An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:
}A JSON object containing the following fields:
type nonrec describe_chap_credentials_input = {target_ar_n : target_ar_n;The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
}A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.
type nonrec describe_cache_report_output = {cache_report_info : cache_report_info option;Contains all informational fields associated with a cache report. Includes name, ARN, tags, status, progress, filters, start time, and end time.
*)}type nonrec describe_cache_report_input = {cache_report_ar_n : cache_report_ar_n;The Amazon Resource Name (ARN) of the cache report you want to describe.
*)}type nonrec cachedi_scsi_volume = {target_name : target_name option;The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.
*)kms_key : kms_key option;volume_used_in_bytes : volume_used_in_bytes option;The size of the data stored on the volume in bytes. This value is calculated based on the number of blocks that are touched, instead of the actual amount of data written. This value can be useful for sequential write patterns but less accurate for random write patterns. VolumeUsedInBytes is different from the compressed size of the volume, which is the value that is used to calculate your bill.
This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.
If you use a delete tool that overwrites the data on your volume with random data, your usage will not be reduced. This is because the random data is not compressible. If you want to reduce the amount of billed storage on your volume, we recommend overwriting your files with zeros to compress the data to a negligible amount of actual storage.
*)created_date : created_date option;The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.
*)volumei_scsi_attributes : volumei_scsi_attributes option;An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
source_snapshot_id : snapshot_id option;If the cached volume was created from a snapshot, this field contains the snapshot ID used, e.g., snap-78e22663. Otherwise, this field is not included.
*)volume_progress : double_object option;Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the cached volume is not restoring or bootstrapping.
*)volume_size_in_bytes : long option;The size, in bytes, of the volume capacity.
*)volume_attachment_status : volume_attachment_status option;A value that indicates whether a storage volume is attached to or detached from a gateway. For more information, see Moving your volumes to a different gateway.
*)volume_status : volume_status option;One of the VolumeStatus values that indicates the state of the storage volume.
*)volume_type : volume_type option;One of the VolumeType enumeration values that describes the type of the volume.
*)volume_id : volume_id option;The unique identifier of the volume, e.g., vol-AE4B946D.
*)volume_ar_n : volume_ar_n option;The Amazon Resource Name (ARN) of the storage volume.
*)}Describes an iSCSI cached volume.
type nonrec cachedi_scsi_volumes = cachedi_scsi_volume listtype nonrec describe_cachedi_scsi_volumes_output = {cachedi_scsi_volumes : cachedi_scsi_volumes option;An array of objects where each object contains metadata about one cached volume.
*)}A JSON object containing the following fields:
type nonrec describe_cachedi_scsi_volumes_input = {volume_ar_ns : volume_ar_ns;An array of strings where each string represents the Amazon Resource Name (ARN) of a cached volume. All of the specified cached volumes must be from the same gateway. Use ListVolumes to get volume ARNs for a gateway.
}type nonrec describe_cache_output = {cache_miss_percentage : double option;Percent of application read operations from the file shares that are not served from cache. The sample is taken at the end of the reporting period.
*)cache_hit_percentage : double option;Percent of application read operations from the file shares that are served from cache. The sample is taken at the end of the reporting period.
*)cache_dirty_percentage : double option;The file share's contribution to the overall percentage of the gateway's cache that has not been persisted to Amazon Web Services. The sample is taken at the end of the reporting period.
*)cache_used_percentage : double option;Percent use of the gateway's cache storage. This metric applies only to the gateway-cached volume setup. The sample is taken at the end of the reporting period.
*)cache_allocated_in_bytes : long option;The amount of cache in bytes allocated to a gateway.
*)disk_ids : disk_ids option;An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
gateway_ar_n : gateway_ar_n option;}type nonrec describe_bandwidth_rate_limit_schedule_output = {bandwidth_rate_limit_intervals : bandwidth_rate_limit_intervals option;An array that contains the bandwidth rate limit intervals for a tape or volume gateway.
*)gateway_ar_n : gateway_ar_n option;}type nonrec describe_bandwidth_rate_limit_output = {average_download_rate_limit_in_bits_per_sec : bandwidth_download_rate_limit
option;The average download bandwidth rate limit in bits per second. This field does not appear in the response if the download rate limit is not set.
*)average_upload_rate_limit_in_bits_per_sec : bandwidth_upload_rate_limit option;The average upload bandwidth rate limit in bits per second. This field does not appear in the response if the upload rate limit is not set.
*)gateway_ar_n : gateway_ar_n option;}A JSON object containing the following fields:
A JSON object containing the Amazon Resource Name (ARN) of the gateway.
type nonrec describe_availability_monitor_test_output = {start_time : time option;The time the high availability monitoring test was started. If a test hasn't been performed, the value of this field is null.
*)status : availability_monitor_test_status option;The status of the high availability monitoring test. If a test hasn't been performed, the value of this field is null.
*)gateway_ar_n : gateway_ar_n option;}type nonrec delete_volume_output = {volume_ar_n : volume_ar_n option;The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the request.
*)}A JSON object containing the Amazon Resource Name (ARN) of the storage volume that was deleted.
type nonrec delete_volume_input = {volume_ar_n : volume_ar_n;The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
}A JSON object containing the DeleteVolumeInput$VolumeARN to delete.
type nonrec delete_tape_pool_output = {pool_ar_n : pool_ar_n option;The Amazon Resource Name (ARN) of the custom tape pool being deleted.
*)}type nonrec delete_tape_pool_input = {pool_ar_n : pool_ar_n;The Amazon Resource Name (ARN) of the custom tape pool to delete.
*)}type nonrec delete_tape_archive_output = {tape_ar_n : tape_ar_n option;The Amazon Resource Name (ARN) of the virtual tape that was deleted from the virtual tape shelf (VTS).
*)}DeleteTapeArchiveOutput
type nonrec delete_tape_archive_input = {bypass_governance_retention : boolean2 option;Set to TRUE to delete an archived tape that belongs to a custom pool with tape retention lock. Only archived tapes with tape retention lock set to governance can be deleted. Archived tapes with tape retention lock set to compliance can't be deleted.
tape_ar_n : tape_ar_n;The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS).
*)}DeleteTapeArchiveInput
type nonrec delete_tape_output = {tape_ar_n : tape_ar_n option;The Amazon Resource Name (ARN) of the deleted virtual tape.
*)}DeleteTapeOutput
type nonrec delete_tape_input = {bypass_governance_retention : boolean2 option;Set to TRUE to delete an archived tape that belongs to a custom pool with tape retention lock. Only archived tapes with tape retention lock set to governance can be deleted. Archived tapes with tape retention lock set to compliance can't be deleted.
tape_ar_n : tape_ar_n;The Amazon Resource Name (ARN) of the virtual tape to delete.
*)gateway_ar_n : gateway_ar_n;The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
}DeleteTapeInput
type nonrec delete_snapshot_schedule_output = {volume_ar_n : volume_ar_n option;The volume which snapshot schedule was deleted.
*)}type nonrec delete_snapshot_schedule_input = {volume_ar_n : volume_ar_n;The volume which snapshot schedule to delete.
*)}A JSON object containing the ID of the deleted gateway.
A JSON object containing the ID of the gateway to delete.
DeleteFileShareOutput
DeleteFileShareInput
type nonrec delete_chap_credentials_output = {initiator_name : iqn_name option;The iSCSI initiator that connects to the target.
*)target_ar_n : target_ar_n option;The Amazon Resource Name (ARN) of the target.
*)}A JSON object containing the following fields:
type nonrec delete_chap_credentials_input = {initiator_name : iqn_name;The iSCSI initiator that connects to the target.
*)target_ar_n : target_ar_n;The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
}A JSON object containing one or more of the following fields:
DeleteChapCredentialsInput$InitiatorNameDeleteChapCredentialsInput$TargetARNtype nonrec delete_cache_report_output = {cache_report_ar_n : cache_report_ar_n option;The Amazon Resource Name (ARN) of the cache report you want to delete.
*)}type nonrec delete_cache_report_input = {cache_report_ar_n : cache_report_ar_n;The Amazon Resource Name (ARN) of the cache report you want to delete.
*)}A JSON object containing the Amazon Resource Name (ARN) of the gateway whose bandwidth rate information was deleted.
type nonrec delete_bandwidth_rate_limit_input = {bandwidth_type : bandwidth_type;One of the BandwidthType values that indicates the gateway bandwidth rate limit to delete.
Valid Values: UPLOAD | DOWNLOAD | ALL
gateway_ar_n : gateway_ar_n;}A JSON object containing the following fields:
DeleteBandwidthRateLimitInput$BandwidthTypetype nonrec create_tape_with_barcode_output = {tape_ar_n : tape_ar_n option;A unique Amazon Resource Name (ARN) that represents the virtual tape that was created.
*)}CreateTapeOutput
type nonrec create_tape_with_barcode_input = {worm : boolean2 option;Set to TRUE if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.
pool_id : pool_id option;The ID of the pool that you want to add your tape to for archiving. The tape in this 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 storage class (S3 Glacier or S3 Deep Archive) that corresponds to the pool.
*)kms_key : kms_key option;The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.
kms_encrypted : boolean_ option;Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
tape_barcode : tape_barcode;The barcode that you want to assign to the tape.
Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.
*)tape_size_in_bytes : tape_size;The size, in bytes, of the virtual tape that you want to create.
The size must be aligned by gigabyte (1024*1024*1024 bytes).
*)gateway_ar_n : gateway_ar_n;The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
}CreateTapeWithBarcodeInput
type nonrec create_tapes_output = {tape_ar_ns : tape_ar_ns option;A list of unique Amazon Resource Names (ARNs) that represents the virtual tapes that were created.
*)}CreateTapeOutput
type nonrec create_tapes_input = {worm : boolean2 option;Set to TRUE if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.
pool_id : pool_id option;The ID of the pool that you want to add your tape to for archiving. The tape in this 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 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
*)kms_key : kms_key option;The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.
kms_encrypted : boolean_ option;Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
tape_barcode_prefix : tape_barcode_prefix;A prefix that you append to the barcode of the virtual tape you are creating. This prefix makes the barcode unique.
The prefix must be 1-4 characters in length and must be one of the uppercase letters from A to Z.
*)num_tapes_to_create : num_tapes_to_create;The number of virtual tapes that you want to create.
*)client_token : client_token;A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.
Using the same ClientToken prevents creating the tape multiple times.
tape_size_in_bytes : tape_size;The size, in bytes, of the virtual tapes that you want to create.
The size must be aligned by gigabyte (1024*1024*1024 bytes).
*)gateway_ar_n : gateway_ar_n;The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
}CreateTapesInput
type nonrec create_tape_pool_output = {pool_ar_n : pool_ar_n option;The unique Amazon Resource Name (ARN) that represents the custom tape pool. Use the ListTapePools operation to return a list of tape pools for your account and Amazon Web Services Region.
}type nonrec create_tape_pool_input = {retention_lock_time_in_days : retention_lock_time_in_days option;Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days).
*)retention_lock_type : retention_lock_type option;Tape retention lock can be configured in two modes. When configured in governance mode, Amazon Web Services accounts with specific IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot be removed by any user, including the root Amazon Web Services account.
*)storage_class : tape_storage_class;The storage class that is associated with the new custom pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
*)pool_name : pool_name;The name of the new custom tape pool.
*)}type nonrec create_storedi_scsi_volume_output = {target_ar_n : target_ar_n option;The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target.
*)volume_size_in_bytes : long option;The size of the volume in bytes.
*)volume_ar_n : volume_ar_n option;The Amazon Resource Name (ARN) of the configured volume.
*)}A JSON object containing the following fields:
type nonrec create_storedi_scsi_volume_input = {kms_key : kms_key option;The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.
kms_encrypted : boolean_ option;Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
network_interface_id : network_interface_id;The network interface of the gateway on which to expose the iSCSI target. Accepts IPv4 and IPv6 addresses. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.
Valid Values: A valid IP address.
*)target_name : target_name;The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.
*)preserve_existing_data : boolean2;Set to true if you want to preserve the data on the local disk. Otherwise, set to false to create an empty volume.
Valid Values: true | false
snapshot_id : snapshot_id option;The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.
*)disk_id : disk_id;The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.
*)gateway_ar_n : gateway_ar_n;}A JSON object containing one or more of the following fields:
CreateStorediSCSIVolumeInput$DiskIdCreateStorediSCSIVolumeInput$NetworkInterfaceIdCreateStorediSCSIVolumeInput$PreserveExistingDataCreateStorediSCSIVolumeInput$SnapshotIdCreateStorediSCSIVolumeInput$TargetNameAn internal server error has occurred because the service is unavailable. For more information, see the error and message fields.
type nonrec create_snapshot_from_volume_recovery_point_output = {volume_recovery_point_time : string_ option;The time the volume was created from the recovery point.
*)volume_ar_n : volume_ar_n option;The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
snapshot_id : snapshot_id option;The ID of the snapshot.
*)}type nonrec create_snapshot_from_volume_recovery_point_input = {snapshot_description : snapshot_description;Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the Storage Gateway snapshot Details pane, Description field.
*)volume_ar_n : volume_ar_n;The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
}type nonrec create_snapshot_output = {snapshot_id : snapshot_id option;The snapshot ID that is used to refer to the snapshot in future operations such as describing snapshots (Amazon Elastic Compute Cloud API DescribeSnapshots) or creating a volume from a snapshot (CreateStorediSCSIVolume).
volume_ar_n : volume_ar_n option;The Amazon Resource Name (ARN) of the volume of which the snapshot was taken.
*)}A JSON object containing the following fields:
type nonrec create_snapshot_input = {snapshot_description : snapshot_description;Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the Storage Gateway snapshot Details pane, Description field.
*)volume_ar_n : volume_ar_n;The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
}A JSON object containing one or more of the following fields:
CreateSnapshotInput$SnapshotDescriptionCreateSnapshotInput$VolumeARNCreateSMBFileShareOutput
CreateSMBFileShareInput
CreateNFSFileShareOutput
CreateNFSFileShareInput
type nonrec create_cachedi_scsi_volume_output = {target_ar_n : target_ar_n option;The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target.
*)volume_ar_n : volume_ar_n option;The Amazon Resource Name (ARN) of the configured volume.
*)}type nonrec create_cachedi_scsi_volume_input = {kms_key : kms_key option;The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.
kms_encrypted : boolean_ option;Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
client_token : client_token;A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.
network_interface_id : network_interface_id;The network interface of the gateway on which to expose the iSCSI target. Accepts IPv4 and IPv6 addresses. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.
Valid Values: A valid IP address.
*)source_volume_ar_n : volume_ar_n option;The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.
target_name : target_name;The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.
*)snapshot_id : snapshot_id option;The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new cached volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.
*)volume_size_in_bytes : long;The size of the volume in bytes.
*)gateway_ar_n : gateway_ar_n;}type nonrec cancel_retrieval_output = {tape_ar_n : tape_ar_n option;The Amazon Resource Name (ARN) of the virtual tape for which retrieval was canceled.
*)}CancelRetrievalOutput
type nonrec cancel_retrieval_input = {tape_ar_n : tape_ar_n;The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.
*)gateway_ar_n : gateway_ar_n;}CancelRetrievalInput
type nonrec cancel_cache_report_output = {cache_report_ar_n : cache_report_ar_n option;The Amazon Resource Name (ARN) of the cache report you want to cancel.
*)}type nonrec cancel_cache_report_input = {cache_report_ar_n : cache_report_ar_n;The Amazon Resource Name (ARN) of the cache report you want to cancel.
*)}type nonrec cancel_archival_output = {tape_ar_n : tape_ar_n option;The Amazon Resource Name (ARN) of the virtual tape for which archiving was canceled.
*)}CancelArchivalOutput
type nonrec cancel_archival_input = {tape_ar_n : tape_ar_n;The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving for.
*)gateway_ar_n : gateway_ar_n;}CancelArchivalInput
type nonrec attach_volume_output = {target_ar_n : target_ar_n option;The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name for the initiator that was used to connect to the target.
*)volume_ar_n : volume_ar_n option;The Amazon Resource Name (ARN) of the volume that was attached to the gateway.
*)}AttachVolumeOutput
type nonrec attach_volume_input = {disk_id : disk_id option;The unique device ID or other distinguishing data that identifies the local disk used to create the volume. This value is only required when you are attaching a stored volume.
*)network_interface_id : network_interface_id;The network interface of the gateway on which to expose the iSCSI target. Accepts IPv4 and IPv6 addresses. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.
Valid Values: A valid IP address.
*)volume_ar_n : volume_ar_n;The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.
*)target_name : target_name option;The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.
*)gateway_ar_n : gateway_ar_n;The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to.
*)}AttachVolumeInput
type nonrec associate_file_system_output = {file_system_association_ar_n : file_system_association_ar_n option;The ARN of the newly created file system association.
*)}type nonrec associate_file_system_input = {endpoint_network_configuration : endpoint_network_configuration option;Specifies the network configuration information for the gateway associated with the Amazon FSx file system.
If multiple file systems are associated with this gateway, this parameter's IpAddresses field is required.
cache_attributes : cache_attributes option;audit_destination_ar_n : audit_destination_ar_n option;The Amazon Resource Name (ARN) of the storage used for the audit logs.
*)location_ar_n : file_system_location_ar_n;The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.
*)gateway_ar_n : gateway_ar_n;client_token : client_token;A unique string value that you supply that is used by the FSx File Gateway to ensure idempotent file system association creation.
*)password : domain_user_password;The password of the user credential.
*)user_name : domain_user_name;The user name of the user credential that has permission to access the root share D$ of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.
*)}type nonrec assign_tape_pool_output = {tape_ar_n : tape_ar_n option;The unique Amazon Resource Names (ARN) of the virtual tape that was added to the tape pool.
*)}type nonrec assign_tape_pool_input = {bypass_governance_retention : boolean2 option;Set permissions to bypass governance retention. If the lock type of the archived tape is Governance, the tape's archived age is not older than RetentionLockInDays, and the user does not already have BypassGovernanceRetention, setting this to TRUE enables the user to bypass the retention lock. This parameter is set to true by default for calls from the console.
Valid values: TRUE | FALSE
pool_id : pool_id;The ID of the pool that you want to add your tape to for archiving. The tape in this 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 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
*)tape_ar_n : tape_ar_n;The unique Amazon Resource Name (ARN) of the virtual tape that you want to add to the tape pool.
*)}A JSON object containing the Amazon Resource Name (ARN) of the gateway for which working storage was configured.
type nonrec add_working_storage_input = {disk_ids : disk_ids;An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
gateway_ar_n : gateway_ar_n;}A JSON object containing one or more of the following fields:
AddWorkingStorageInput$DiskIdstype nonrec add_upload_buffer_input = {disk_ids : disk_ids;An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
gateway_ar_n : gateway_ar_n;}type nonrec add_cache_input = {disk_ids : disk_ids;An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
gateway_ar_n : gateway_ar_n;}Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It is a string made of information such as your account, gateway name, and Amazon Web Services Region. This ARN is used to reference the gateway in other API operations as well as resource-based authorization.
For gateways activated prior to September 02, 2015, the gateway ARN contains the gateway name rather than the gateway ID. Changing the name of the gateway has no effect on the gateway ARN.
type nonrec activate_gateway_input = {medium_changer_type : medium_changer_type option;The value that indicates the type of medium changer to use for tape gateway. This field is optional.
Valid Values: STK-L700 | AWS-Gateway-VTL | IBM-03584L32-0402
tape_drive_type : tape_drive_type option;The value that indicates the type of tape drive to use for tape gateway. This field is optional.
Valid Values: IBM-ULT3580-TD5
gateway_type : gateway_type option;A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is CACHED.
Amazon FSx File Gateway is no longer available to new customers. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit this blog post.
Valid Values: STORED | CACHED | VTL | FILE_S3 | FILE_FSX_SMB
gateway_region : region_id;A value that indicates the Amazon Web Services Region where you want to store your data. The gateway Amazon Web Services Region specified must be the same Amazon Web Services Region as the Amazon Web Services Region in your Host header in the request. For more information about available Amazon Web Services Regions and endpoints for Storage Gateway, see Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.
Valid Values: See Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.
*)gateway_timezone : gateway_timezone;A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT", "GMT-hr:mm", or "GMT+hr:mm". For example, GMT indicates Greenwich Mean Time without any offset. GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
*)gateway_name : gateway_name;The name you configured for your gateway.
*)activation_key : activation_key;Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.
For more information, see Getting activation key in the Storage Gateway User Guide.
*)}A JSON object containing one or more of the following fields:
ActivateGatewayInput$ActivationKeyActivateGatewayInput$GatewayNameActivateGatewayInput$GatewayRegionActivateGatewayInput$GatewayTimezoneActivateGatewayInput$GatewayTypeActivateGatewayInput$MediumChangerTypeActivateGatewayInput$TapeDriveType