Values (p.awso.0.9.0.doc.awso.storagegateway.Awso

Sourceval service : Awso.Service.t

Sourceval apiVersion : string

Sourceval endpointPrefix : string

Sourceval serviceFullName : string

Sourceval signatureVersion : string

Sourceval protocol : string

Sourceval globalEndpoint : string

Sourceval targetPrefix : string

Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t

Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t

Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t

Source

val structure_to_value_aux : 
  ('a * 'b option) list ->
  f:(('a * 'b) list -> 'c) ->
  [> `Structure of 'c ]

Source

val structure_to_value : 
  ('a * 'b option) list ->
  [> `Structure of ('a * 'b) list ]

Source

val structure_to_wrapped_value : 
  wrapper:'a ->
  response:'a ->
  ('b * 'c option) list ->
  [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]

Sourcemodule CacheReportFilterValue : sig ... end

Sourcemodule CacheReportFilterName : sig ... end

Sourcemodule CacheReportFilterValues : sig ... end

Sourcemodule TagKey : sig ... end

Sourcemodule TagValue : sig ... end

Sourcemodule MinimumNumTapes : sig ... end

Sourcemodule PoolId : sig ... end

Sourcemodule TapeBarcodePrefix : sig ... end

Sourcemodule TapeSize : sig ... end

Sourcemodule IPV4Address : sig ... end

Sourcemodule FileSystemAssociationSyncErrorCode : sig ... end

Sourcemodule String_ : sig ... end

Sourcemodule DayOfWeek : sig ... end

Sourcemodule DiskAttribute : sig ... end

Sourcemodule CacheReportFilter : sig ... end

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.

Sourcemodule Tag : sig ... end

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: + - = . _ : /.

Sourcemodule AutomaticTapeCreationRule : sig ... end

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.

Sourcemodule NetworkInterfaceId : sig ... end

Sourcemodule TargetARN : sig ... end

Sourcemodule Integer : sig ... end

Sourcemodule PositiveIntObject : sig ... end

Sourcemodule CacheStaleTimeoutInSeconds : sig ... end

Sourcemodule UserListUser : sig ... end

Sourcemodule Ipv4OrIpv6AddressCIDR : sig ... end

Sourcemodule PermissionId : sig ... end

Sourcemodule PermissionMode : sig ... end

Sourcemodule IpAddressList : sig ... end

Sourcemodule FileSystemAssociationStatusDetail : sig ... end

Detailed information on file system association status.

Sourcemodule ErrorCode : sig ... end

Sourcemodule ErrorDetails : sig ... end

Sourcemodule BandwidthDownloadRateLimit : sig ... end

Sourcemodule BandwidthUploadRateLimit : sig ... end

Sourcemodule DaysOfWeek : sig ... end

Sourcemodule HourOfDay : sig ... end

Sourcemodule MinuteOfHour : sig ... end

Sourcemodule GatewayARN : sig ... end

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.

Sourcemodule GatewayId : sig ... end

Sourcemodule VolumeARN : sig ... end

Sourcemodule VolumeAttachmentStatus : sig ... end

Sourcemodule VolumeId : sig ... end

Sourcemodule VolumeType : sig ... end

Sourcemodule Long : sig ... end

Sourcemodule TapeARN : sig ... end

Sourcemodule TapeBarcode : sig ... end

Sourcemodule TapeStatus : sig ... end

Sourcemodule Time : sig ... end

Sourcemodule PoolARN : sig ... end

Sourcemodule PoolName : sig ... end

Sourcemodule PoolStatus : sig ... end

Sourcemodule RetentionLockTimeInDays : sig ... end

Sourcemodule RetentionLockType : sig ... end

Sourcemodule TapeStorageClass : sig ... end

Sourcemodule DiskAllocationType : sig ... end

One of the DiskAllocationType enumeration values that identifies how a local disk is used. Valid Values: UPLOAD_BUFFER | CACHE_STORAGE

Sourcemodule DiskAttributeList : sig ... end

Sourcemodule DiskId : sig ... end

Sourcemodule DeprecationDate : sig ... end

Sourcemodule Ec2InstanceId : sig ... end

Sourcemodule Ec2InstanceRegion : sig ... end

Sourcemodule GatewayOperationalState : sig ... end

Sourcemodule GatewayType : sig ... end

Sourcemodule HostEnvironment : sig ... end

Sourcemodule HostEnvironmentId : sig ... end

Sourcemodule SoftwareVersion : sig ... end

Sourcemodule FileSystemAssociationARN : sig ... end

Sourcemodule FileSystemAssociationId : sig ... end

Sourcemodule FileSystemAssociationStatus : sig ... end

Sourcemodule FileShareARN : sig ... end

The Amazon Resource Name (ARN) of the file share.

Sourcemodule FileShareId : sig ... end

The ID of the file share.

Sourcemodule FileShareStatus : sig ... end

The status of the file share. Valid Values: CREATING | UPDATING | AVAILABLE | DELETING

Sourcemodule FileShareType : sig ... end

Sourcemodule CacheReportARN : sig ... end

Sourcemodule CacheReportFilterList : sig ... end

Sourcemodule CacheReportName : sig ... end

Sourcemodule CacheReportStatus : sig ... end

Sourcemodule LocationARN : sig ... end

A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/). You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples. Bucket ARN: arn:aws:s3:::amzn-s3-demo-bucket/prefix/ Access point ARN: arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/ If you specify an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide. Access point alias: test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias

Sourcemodule ReportCompletionPercent : sig ... end

Sourcemodule Role : sig ... end

The ARN of the IAM role that an S3 File Gateway assumes when it accesses the underlying storage.

Sourcemodule Tags : sig ... end

Sourcemodule AutomaticTapeCreationRules : sig ... end

Sourcemodule DeviceiSCSIAttributes : sig ... end

Lists iSCSI information about a VTL device.

Sourcemodule VTLDeviceARN : sig ... end

Sourcemodule VTLDeviceProductIdentifier : sig ... end

Sourcemodule VTLDeviceType : sig ... end

Sourcemodule VTLDeviceVendor : sig ... end

Sourcemodule DoubleObject : sig ... end

Sourcemodule KMSKey : sig ... end

Optional. 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 must be set if KMSEncrypted is true, or if EncryptionType is SseKms or DsseKms.

Sourcemodule TapeUsage : sig ... end

Sourcemodule TapeRecoveryPointStatus : sig ... end

Sourcemodule TapeArchiveStatus : sig ... end

Sourcemodule CreatedDate : sig ... end

Sourcemodule SnapshotId : sig ... end

Sourcemodule TargetName : sig ... end

Sourcemodule VolumeStatus : sig ... end

Sourcemodule VolumeUsedInBytes : sig ... end

Sourcemodule VolumeiSCSIAttributes : sig ... end

Lists iSCSI information about a volume.

Sourcemodule AuditDestinationARN : sig ... end

Sourcemodule Authentication : sig ... end

The authentication method of the file share. The default is ActiveDirectory. Valid Values: ActiveDirectory | GuestAccess

Sourcemodule Boolean : sig ... end

Sourcemodule CacheAttributes : sig ... end

The refresh cache information for the file share or FSx file systems.

Sourcemodule CaseSensitivity : sig ... end

Sourcemodule DNSHostName : sig ... end

Sourcemodule EncryptionType : sig ... end

Sourcemodule FileShareName : sig ... end

Sourcemodule NotificationPolicy : sig ... end

Sourcemodule ObjectACL : sig ... end

Sourcemodule Path : sig ... end

The file share path used by the NFS client to identify the mount point.

Sourcemodule RegionId : sig ... end

Sourcemodule StorageClass : sig ... end

Sourcemodule UserList : sig ... end

Sourcemodule FileShareClientList : sig ... end

Sourcemodule NFSFileShareDefaults : sig ... end

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

Sourcemodule Squash : sig ... end

The user mapped to anonymous user. Valid options are the following: RootSquash: Only root is mapped to anonymous user. NoSquash: No one is mapped to anonymous user. AllSquash: Everyone is mapped to anonymous user.

Sourcemodule EndpointNetworkConfiguration : sig ... end

Specifies network configuration information for the gateway associated with the Amazon FSx file system.

Sourcemodule FileSystemAssociationStatusDetails : sig ... end

Sourcemodule FileSystemLocationARN : sig ... end

Sourcemodule ChapSecret : sig ... end

Sourcemodule IqnName : sig ... end

Sourcemodule StorageGatewayError : sig ... end

Provides additional information about an error that was returned by the service. See the errorCode and errorDetails members for more information about the error.

Sourcemodule AutomaticUpdatePolicy : sig ... end

Sourcemodule BandwidthRateLimitInterval : sig ... end

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.

Sourcemodule Folder : sig ... end

Sourcemodule VolumeInfo : sig ... end

Describes a storage volume object.

Sourcemodule VolumeRecoveryPointInfo : sig ... end

Describes a storage volume recovery point object.

Sourcemodule Initiator : sig ... end

Sourcemodule TapeInfo : sig ... end

Describes a virtual tape.

Sourcemodule PoolInfo : sig ... end

Describes a custom tape pool.

Sourcemodule Disk : sig ... end

Represents a gateway's local disk.

Sourcemodule GatewayInfo : sig ... end

Describes a gateway object.

Sourcemodule FileSystemAssociationSummary : sig ... end

Gets the summary returned by ListFileSystemAssociation, which is a summary of a created file system association.

Sourcemodule FileShareInfo : sig ... end

Describes a file share. Only supported S3 File Gateway.

Sourcemodule CacheReportInfo : sig ... end

Contains all informational fields associated with a cache report. Includes name, ARN, tags, status, progress, filters, start time, and end time.

Sourcemodule AutomaticTapeCreationPolicyInfo : sig ... end

Information about the gateway's automatic tape creation policies, including the automatic tape creation rules and the gateway that is using the policies.

Sourcemodule Host : sig ... end

Sourcemodule VTLDevice : sig ... end

Represents a device object associated with a tape gateway.

Sourcemodule Tape : sig ... end

Describes a virtual tape object.

Sourcemodule TapeRecoveryPointInfo : sig ... end

Describes a recovery point.

Sourcemodule TapeArchive : sig ... end

Represents a virtual tape that is archived in the virtual tape shelf (VTS).

Sourcemodule StorediSCSIVolume : sig ... end

Describes an iSCSI stored volume.

Sourcemodule SMBFileShareInfo : sig ... end

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.

Sourcemodule NFSFileShareInfo : sig ... end

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.

Sourcemodule NetworkInterface : sig ... end

Describes a gateway's network interface.

Sourcemodule GatewayCapacity : sig ... end

Sourcemodule FileSystemAssociationInfo : sig ... end

Describes the object returned by DescribeFileSystemAssociations that describes a created file system association.

Sourcemodule ChapInfo : sig ... end

Describes Challenge-Handshake Authentication Protocol (CHAP) information that supports authentication between your gateway and iSCSI initiators.

Sourcemodule CachediSCSIVolume : sig ... end

Describes an iSCSI cached volume.

Sourcemodule InternalServerError : sig ... end

An internal server error has occurred during the request. For more information, see the error and message fields.

Sourcemodule InvalidGatewayRequestException : sig ... end

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

Sourcemodule DeviceType : sig ... end

Sourcemodule Description : sig ... end

Sourcemodule RecurrenceInHours : sig ... end

Sourcemodule SMBSecurityStrategy : sig ... end

Sourcemodule SMBLocalGroups : sig ... end

A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.

Sourcemodule DayOfMonth : sig ... end

Sourcemodule SoftwareUpdatePreferences : sig ... end

A set of variables indicating the software update preferences for the gateway.

Sourcemodule CloudWatchLogGroupARN : sig ... end

Sourcemodule GatewayName : sig ... end

The name you configured for your gateway.

Sourcemodule GatewayTimezone : sig ... end

Sourcemodule DomainUserName : sig ... end

Sourcemodule DomainUserPassword : sig ... end

Sourcemodule BandwidthRateLimitIntervals : sig ... end

Sourcemodule ClientToken : sig ... end

Sourcemodule SMBGuestPassword : sig ... end

Sourcemodule LocalConsolePassword : sig ... end

Sourcemodule ResourceARN : sig ... end

Sourcemodule TagKeys : sig ... end

Sourcemodule NotificationId : sig ... end

The randomly generated ID of the notification that was sent. This ID is in UUID format.

Sourcemodule FolderList : sig ... end

Sourcemodule Marker : sig ... end

Sourcemodule VolumeInfos : sig ... end

Sourcemodule VolumeRecoveryPointInfos : sig ... end

Sourcemodule Initiators : sig ... end

Sourcemodule TapeInfos : sig ... end

Sourcemodule TapeARNs : sig ... end

Sourcemodule PoolInfos : sig ... end

Sourcemodule PoolARNs : sig ... end

Sourcemodule Disks : sig ... end

Sourcemodule Gateways : sig ... end

Sourcemodule FileSystemAssociationSummaryList : sig ... end

Sourcemodule FileShareInfoList : sig ... end

Sourcemodule CacheReportList : sig ... end

Sourcemodule AutomaticTapeCreationPolicyInfos : sig ... end

Sourcemodule ActiveDirectoryStatus : sig ... end

Sourcemodule DomainName : sig ... end

Sourcemodule Hosts : sig ... end

Sourcemodule OrganizationalUnit : sig ... end

Sourcemodule TimeoutInSeconds : sig ... end

Sourcemodule DiskIds : sig ... end

Sourcemodule VTLDevices : sig ... end

Sourcemodule VTLDeviceARNs : sig ... end

Sourcemodule Tapes : sig ... end

Sourcemodule TapeRecoveryPointInfos : sig ... end

Sourcemodule TapeArchives : sig ... end

Sourcemodule StorediSCSIVolumes : sig ... end

Sourcemodule VolumeARNs : sig ... end

Sourcemodule SMBFileShareInfoList : sig ... end

Sourcemodule FileShareARNList : sig ... end

Sourcemodule NFSFileShareInfoList : sig ... end

Sourcemodule EndpointType : sig ... end

Sourcemodule GatewayNetworkInterfaces : sig ... end

Sourcemodule GatewayState : sig ... end

Sourcemodule LastSoftwareUpdate : sig ... end

Sourcemodule NextUpdateAvailabilityDate : sig ... end

Sourcemodule SoftwareUpdatesEndDate : sig ... end

Sourcemodule SupportedGatewayCapacities : sig ... end

Sourcemodule FileSystemAssociationInfoList : sig ... end

Sourcemodule FileSystemAssociationARNList : sig ... end

Sourcemodule ChapCredentials : sig ... end

Sourcemodule CachediSCSIVolumes : sig ... end

Sourcemodule Double : sig ... end

Sourcemodule AvailabilityMonitorTestStatus : sig ... end

Sourcemodule BandwidthType : sig ... end

Sourcemodule NumTapesToCreate : sig ... end

Sourcemodule ServiceUnavailableError : sig ... end

An internal server error has occurred because the service is unavailable. For more information, see the error and message fields.

Sourcemodule SnapshotDescription : sig ... end

Sourcemodule ActivationKey : sig ... end

Sourcemodule MediumChangerType : sig ... end

Sourcemodule TapeDriveType : sig ... end

Sourcemodule UpdateVTLDeviceTypeOutput : sig ... end

UpdateVTLDeviceTypeOutput

Sourcemodule UpdateVTLDeviceTypeInput : sig ... end

Updates the type of medium changer in a tape gateway. When you activate a tape gateway, you select a medium changer type for the tape gateway. This operation enables you to select a different type of medium changer after a tape gateway is activated. This operation is only supported in the tape gateway type.

Sourcemodule UpdateSnapshotScheduleOutput : sig ... end

A JSON object containing the Amazon Resource Name (ARN) of the updated storage volume.

Sourcemodule UpdateSnapshotScheduleInput : sig ... end

A JSON object containing one or more of the following fields: UpdateSnapshotScheduleInput$Description UpdateSnapshotScheduleInput$RecurrenceInHours UpdateSnapshotScheduleInput$StartAt UpdateSnapshotScheduleInput$VolumeARN

Sourcemodule UpdateSMBSecurityStrategyOutput : sig ... end

Updates the SMB security strategy level for an Amazon S3 file gateway. This action is only supported for Amazon S3 file gateways. For information about configuring this setting using the Amazon Web Services console, see Setting a security level for your gateway in the Amazon S3 File Gateway User Guide. A higher security strategy level can affect performance of the gateway.

Sourcemodule UpdateSMBSecurityStrategyInput : sig ... end

Updates the SMB security strategy level for an Amazon S3 file gateway. This action is only supported for Amazon S3 file gateways. For information about configuring this setting using the Amazon Web Services console, see Setting a security level for your gateway in the Amazon S3 File Gateway User Guide. A higher security strategy level can affect performance of the gateway.

Sourcemodule UpdateSMBLocalGroupsOutput : sig ... end

Updates the list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.

Sourcemodule UpdateSMBLocalGroupsInput : sig ... end

Updates the list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.

Sourcemodule UpdateSMBFileShareVisibilityOutput : sig ... end

Controls whether the shares on an S3 File Gateway are visible in a net view or browse list. The operation is only supported for S3 File Gateways.

Sourcemodule UpdateSMBFileShareVisibilityInput : sig ... end

Controls whether the shares on an S3 File Gateway are visible in a net view or browse list. The operation is only supported for S3 File Gateways.

Sourcemodule UpdateSMBFileShareOutput : sig ... end

UpdateSMBFileShareOutput

Sourcemodule UpdateSMBFileShareInput : sig ... end

UpdateSMBFileShareInput

Sourcemodule UpdateNFSFileShareOutput : sig ... end

UpdateNFSFileShareOutput

Sourcemodule UpdateNFSFileShareInput : sig ... end

UpdateNFSFileShareInput

Sourcemodule UpdateMaintenanceStartTimeOutput : sig ... end

A JSON object containing the Amazon Resource Name (ARN) of the gateway whose maintenance start time is updated.

Sourcemodule UpdateMaintenanceStartTimeInput : sig ... end

A JSON object containing the following fields: UpdateMaintenanceStartTimeInput$SoftwareUpdatePreferences UpdateMaintenanceStartTimeInput$DayOfMonth UpdateMaintenanceStartTimeInput$DayOfWeek UpdateMaintenanceStartTimeInput$HourOfDay UpdateMaintenanceStartTimeInput$MinuteOfHour

Sourcemodule UpdateGatewaySoftwareNowOutput : sig ... end

A JSON object containing the Amazon Resource Name (ARN) of the gateway that was updated.

Sourcemodule UpdateGatewaySoftwareNowInput : sig ... end

A JSON object containing the Amazon Resource Name (ARN) of the gateway to update.

Sourcemodule UpdateGatewayInformationOutput : sig ... end

A JSON object containing the Amazon Resource Name (ARN) of the gateway that was updated.

Sourcemodule UpdateGatewayInformationInput : sig ... end

Updates a gateway's metadata, which includes the gateway's name, time zone, and metadata cache size. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request. For gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN.

Sourcemodule UpdateFileSystemAssociationOutput : sig ... end

Updates a file system association. This operation is only supported in the FSx File Gateways.

Sourcemodule UpdateFileSystemAssociationInput : sig ... end

Updates a file system association. This operation is only supported in the FSx File Gateways.

Sourcemodule UpdateChapCredentialsOutput : sig ... end

A JSON object containing the following fields:

Sourcemodule UpdateChapCredentialsInput : sig ... end

A JSON object containing one or more of the following fields: UpdateChapCredentialsInput$InitiatorName UpdateChapCredentialsInput$SecretToAuthenticateInitiator UpdateChapCredentialsInput$SecretToAuthenticateTarget UpdateChapCredentialsInput$TargetARN

Sourcemodule UpdateBandwidthRateLimitScheduleOutput : sig ... end

Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This operation is supported for volume, tape, and S3 file gateways. S3 file gateways support bandwidth rate limits for upload only. FSx file gateways do not support bandwidth rate limits.

Sourcemodule UpdateBandwidthRateLimitScheduleInput : sig ... end

Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This operation is supported for volume, tape, and S3 file gateways. S3 file gateways support bandwidth rate limits for upload only. FSx file gateways do not support bandwidth rate limits.

Sourcemodule UpdateBandwidthRateLimitOutput : sig ... end

A JSON object containing the Amazon Resource Name (ARN) of the gateway whose throttle information was updated.

Sourcemodule UpdateBandwidthRateLimitInput : sig ... end

A JSON object containing one or more of the following fields: UpdateBandwidthRateLimitInput$AverageDownloadRateLimitInBitsPerSec UpdateBandwidthRateLimitInput$AverageUploadRateLimitInBitsPerSec

Sourcemodule UpdateAutomaticTapeCreationPolicyOutput : sig ... end

Updates the automatic tape creation policy of a gateway. Use this to update the policy with a new set of automatic tape creation rules. This is only supported for tape gateways. By default, there is no automatic tape creation policy. A gateway can have only one automatic tape creation policy.

Sourcemodule UpdateAutomaticTapeCreationPolicyInput : sig ... end

Updates the automatic tape creation policy of a gateway. Use this to update the policy with a new set of automatic tape creation rules. This is only supported for tape gateways. By default, there is no automatic tape creation policy. A gateway can have only one automatic tape creation policy.

Sourcemodule StartGatewayOutput : sig ... end

A JSON object containing the Amazon Resource Name (ARN) of the gateway that was restarted.

Sourcemodule StartGatewayInput : sig ... end

A JSON object containing the Amazon Resource Name (ARN) of the gateway to start.

Sourcemodule StartCacheReportOutput : sig ... end

Starts generating a report of the file metadata currently cached by an S3 File Gateway for a specific file share. You can use this report to identify and resolve issues if you have files failing upload from your gateway to Amazon S3. The report is a CSV file containing a list of files which match the set of filter parameters you specify in the request. The Files Failing Upload flag is reset every 24 hours and during gateway reboot. If this report captures the files after the reset, but before they become flagged again, they will not be reported as Files Failing Upload. The following requirements must be met to successfully generate a cache report: You must have s3:PutObject and s3:AbortMultipartUpload permissions for the Amazon S3 bucket where you want to store the cache report. No other cache reports can currently be in-progress for the specified file share. There must be fewer than 10 existing cache reports for the specified file share. The gateway must be online and connected to Amazon Web Services. The root disk must have at least 20GB of free space when report generation starts. You must specify at least one value for InclusionFilters or ExclusionFilters in the request.

Sourcemodule StartCacheReportInput : sig ... end

Starts generating a report of the file metadata currently cached by an S3 File Gateway for a specific file share. You can use this report to identify and resolve issues if you have files failing upload from your gateway to Amazon S3. The report is a CSV file containing a list of files which match the set of filter parameters you specify in the request. The Files Failing Upload flag is reset every 24 hours and during gateway reboot. If this report captures the files after the reset, but before they become flagged again, they will not be reported as Files Failing Upload. The following requirements must be met to successfully generate a cache report: You must have s3:PutObject and s3:AbortMultipartUpload permissions for the Amazon S3 bucket where you want to store the cache report. No other cache reports can currently be in-progress for the specified file share. There must be fewer than 10 existing cache reports for the specified file share. The gateway must be online and connected to Amazon Web Services. The root disk must have at least 20GB of free space when report generation starts. You must specify at least one value for InclusionFilters or ExclusionFilters in the request.

Sourcemodule StartAvailabilityMonitorTestOutput : sig ... end

Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment. This request only initiates the test and that a successful response only indicates that the test was started. It doesn't indicate that the test passed. For the status of the test, invoke the DescribeAvailabilityMonitorTest API. Starting this test will cause your gateway to go offline for a brief period.

Sourcemodule StartAvailabilityMonitorTestInput : sig ... end

Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment. This request only initiates the test and that a successful response only indicates that the test was started. It doesn't indicate that the test passed. For the status of the test, invoke the DescribeAvailabilityMonitorTest API. Starting this test will cause your gateway to go offline for a brief period.

Sourcemodule ShutdownGatewayOutput : sig ... end

A JSON object containing the Amazon Resource Name (ARN) of the gateway that was shut down.

Sourcemodule ShutdownGatewayInput : sig ... end

A JSON object containing the Amazon Resource Name (ARN) of the gateway to shut down.

Sourcemodule SetSMBGuestPasswordOutput : sig ... end

Sets the password for the guest user smbguest. The smbguest user is the user when the authentication method for the file share is set to GuestAccess. This operation only supported for S3 File Gateways

Sourcemodule SetSMBGuestPasswordInput : sig ... end

SetSMBGuestPasswordInput

Sourcemodule SetLocalConsolePasswordOutput : sig ... end

Sets the password for your VM local console. When you log in to the local console for the first time, you log in to the VM with the default credentials. We recommend that you set a new password. You don't need to know the default password to set a new password.

Sourcemodule SetLocalConsolePasswordInput : sig ... end

SetLocalConsolePasswordInput

Sourcemodule RetrieveTapeRecoveryPointOutput : sig ... end

RetrieveTapeRecoveryPointOutput

Sourcemodule RetrieveTapeRecoveryPointInput : sig ... end

RetrieveTapeRecoveryPointInput

Sourcemodule RetrieveTapeArchiveOutput : sig ... end

RetrieveTapeArchiveOutput

Sourcemodule RetrieveTapeArchiveInput : sig ... end

RetrieveTapeArchiveInput

Sourcemodule ResetCacheOutput : sig ... end

Resets all cache disks that have encountered an error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters an error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point, you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types. If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.

Sourcemodule ResetCacheInput : sig ... end

Resets all cache disks that have encountered an error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters an error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point, you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types. If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.

Sourcemodule RemoveTagsFromResourceOutput : sig ... end

RemoveTagsFromResourceOutput

Sourcemodule RemoveTagsFromResourceInput : sig ... end

RemoveTagsFromResourceInput

Sourcemodule RefreshCacheOutput : sig ... end

RefreshCacheOutput

Sourcemodule RefreshCacheInput : sig ... end

RefreshCacheInput

Sourcemodule NotifyWhenUploadedOutput : sig ... end

Sends you notification through Amazon EventBridge when all files written to your file share have been uploaded to Amazon S3. Storage Gateway can send a notification through Amazon EventBridge when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through EventBridge. You can configure EventBridge to send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways. For more information, see Getting file upload notification in the Amazon S3 File Gateway User Guide.

Sourcemodule NotifyWhenUploadedInput : sig ... end

Sends you notification through Amazon EventBridge when all files written to your file share have been uploaded to Amazon S3. Storage Gateway can send a notification through Amazon EventBridge when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through EventBridge. You can configure EventBridge to send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways. For more information, see Getting file upload notification in the Amazon S3 File Gateway User Guide.

Sourcemodule ListVolumesOutput : sig ... end

A JSON object containing the following fields: ListVolumesOutput$Marker ListVolumesOutput$VolumeInfos

Sourcemodule ListVolumesInput : sig ... end

A JSON object that contains one or more of the following fields: ListVolumesInput$Limit ListVolumesInput$Marker

Sourcemodule ListVolumeRecoveryPointsOutput : sig ... end

Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type. Each cache volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot or clone a new cached volume from a source volume. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.

Sourcemodule ListVolumeRecoveryPointsInput : sig ... end

Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type. Each cache volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot or clone a new cached volume from a source volume. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.

Sourcemodule ListVolumeInitiatorsOutput : sig ... end

ListVolumeInitiatorsOutput

Sourcemodule ListVolumeInitiatorsInput : sig ... end

ListVolumeInitiatorsInput

Sourcemodule ListTapesOutput : sig ... end

A JSON object containing the following fields: ListTapesOutput$Marker ListTapesOutput$VolumeInfos

Sourcemodule ListTapesInput : sig ... end

A JSON object that contains one or more of the following fields: ListTapesInput$Limit ListTapesInput$Marker ListTapesInput$TapeARNs

Sourcemodule ListTapePoolsOutput : sig ... end

Lists custom tape pools. You specify custom tape pools to list by specifying one or more custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN, the operation lists all custom tape pools. This operation supports pagination. You can optionally specify the Limit parameter in the body to limit the number of tape pools in the response. If the number of tape pools returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tape pools.

Sourcemodule ListTapePoolsInput : sig ... end

Lists custom tape pools. You specify custom tape pools to list by specifying one or more custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN, the operation lists all custom tape pools. This operation supports pagination. You can optionally specify the Limit parameter in the body to limit the number of tape pools in the response. If the number of tape pools returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tape pools.

Sourcemodule ListTagsForResourceOutput : sig ... end

ListTagsForResourceOutput

Sourcemodule ListTagsForResourceInput : sig ... end

ListTagsForResourceInput

Sourcemodule ListLocalDisksOutput : sig ... end

Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request. The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a DiskStatus field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted).

Sourcemodule ListLocalDisksInput : sig ... end

A JSON object containing the Amazon Resource Name (ARN) of the gateway.

Sourcemodule ListGatewaysOutput : sig ... end

Lists gateways owned by an Amazon Web Services account in an Amazon Web Services Region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN). By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response. If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.

Sourcemodule ListGatewaysInput : sig ... end

A JSON object containing zero or more of the following fields: ListGatewaysInput$Limit ListGatewaysInput$Marker

Sourcemodule ListFileSystemAssociationsOutput : sig ... end

Gets a list of FileSystemAssociationSummary objects. Each object contains a summary of a file system association. This operation is only supported for FSx File Gateways.

Sourcemodule ListFileSystemAssociationsInput : sig ... end

Gets a list of FileSystemAssociationSummary objects. Each object contains a summary of a file system association. This operation is only supported for FSx File Gateways.

Sourcemodule ListFileSharesOutput : sig ... end

ListFileShareOutput

Sourcemodule ListFileSharesInput : sig ... end

ListFileShareInput

Sourcemodule ListCacheReportsOutput : sig ... end

Returns 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 name, status, completion progress, start time, end time, filters, and tags.

Sourcemodule ListCacheReportsInput : sig ... end

Returns 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 name, status, completion progress, start time, end time, filters, and tags.

Sourcemodule ListAutomaticTapeCreationPoliciesOutput : sig ... end

Lists the automatic tape creation policies for a gateway. If there are no automatic tape creation policies for the gateway, it returns an empty list. This operation is only supported for tape gateways.

Sourcemodule ListAutomaticTapeCreationPoliciesInput : sig ... end

Lists the automatic tape creation policies for a gateway. If there are no automatic tape creation policies for the gateway, it returns an empty list. This operation is only supported for tape gateways.

Sourcemodule JoinDomainOutput : sig ... end

JoinDomainOutput

Sourcemodule JoinDomainInput : sig ... end

JoinDomainInput

Sourcemodule EvictFilesFailingUploadOutput : sig ... end

Starts a process that cleans the specified file share's cache of file entries that are failing upload to Amazon S3. This API operation reports success if the request is received with valid arguments, and there are no other cache clean operations currently in-progress for the specified file share. After a successful request, the cache clean operation occurs asynchronously and reports progress using CloudWatch logs and notifications. If ForceRemove is set to True, the cache clean operation will delete file data from the gateway which might otherwise be recoverable. We recommend using this operation only after all other methods to clear files failing upload have been exhausted, and if your business need outweighs the potential data loss.

Sourcemodule EvictFilesFailingUploadInput : sig ... end

Starts a process that cleans the specified file share's cache of file entries that are failing upload to Amazon S3. This API operation reports success if the request is received with valid arguments, and there are no other cache clean operations currently in-progress for the specified file share. After a successful request, the cache clean operation occurs asynchronously and reports progress using CloudWatch logs and notifications. If ForceRemove is set to True, the cache clean operation will delete file data from the gateway which might otherwise be recoverable. We recommend using this operation only after all other methods to clear files failing upload have been exhausted, and if your business need outweighs the potential data loss.

Sourcemodule DisassociateFileSystemOutput : sig ... end

Disassociates an Amazon FSx file system from the specified gateway. After the disassociation process finishes, the gateway can no longer access the Amazon FSx file system. This operation is only supported in the FSx File Gateway type.

Sourcemodule DisassociateFileSystemInput : sig ... end

Disassociates an Amazon FSx file system from the specified gateway. After the disassociation process finishes, the gateway can no longer access the Amazon FSx file system. This operation is only supported in the FSx File Gateway type.

Sourcemodule DisableGatewayOutput : sig ... end

DisableGatewayOutput

Sourcemodule DisableGatewayInput : sig ... end

DisableGatewayInput

Sourcemodule DetachVolumeOutput : sig ... end

AttachVolumeOutput

Sourcemodule DetachVolumeInput : sig ... end

AttachVolumeInput

Sourcemodule DescribeWorkingStorageOutput : sig ... end

A JSON object containing the following fields:

Sourcemodule DescribeWorkingStorageInput : sig ... end

A JSON object containing the Amazon Resource Name (ARN) of the gateway.

Sourcemodule DescribeVTLDevicesOutput : sig ... end

DescribeVTLDevicesOutput

Sourcemodule DescribeVTLDevicesInput : sig ... end

DescribeVTLDevicesInput

Sourcemodule DescribeUploadBufferOutput : sig ... end

Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume, and tape gateway types. The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.

Sourcemodule DescribeUploadBufferInput : sig ... end

Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume, and tape gateway types. The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.

Sourcemodule DescribeTapesOutput : sig ... end

DescribeTapesOutput

Sourcemodule DescribeTapesInput : sig ... end

DescribeTapesInput

Sourcemodule DescribeTapeRecoveryPointsOutput : sig ... end

DescribeTapeRecoveryPointsOutput

Sourcemodule DescribeTapeRecoveryPointsInput : sig ... end

DescribeTapeRecoveryPointsInput

Sourcemodule DescribeTapeArchivesOutput : sig ... end

DescribeTapeArchivesOutput

Sourcemodule DescribeTapeArchivesInput : sig ... end

DescribeTapeArchivesInput

Sourcemodule DescribeStorediSCSIVolumesOutput : sig ... end

Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.

Sourcemodule DescribeStorediSCSIVolumesInput : sig ... end

A JSON object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.

Sourcemodule DescribeSnapshotScheduleOutput : sig ... end

Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. This operation is only supported in the cached volume and stored volume types.

Sourcemodule DescribeSnapshotScheduleInput : sig ... end

A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the volume.

Sourcemodule DescribeSMBSettingsOutput : sig ... end

Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.

Sourcemodule DescribeSMBSettingsInput : sig ... end

Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.

Sourcemodule DescribeSMBFileSharesOutput : sig ... end

DescribeSMBFileSharesOutput

Sourcemodule DescribeSMBFileSharesInput : sig ... end

DescribeSMBFileSharesInput

Sourcemodule DescribeNFSFileSharesOutput : sig ... end

DescribeNFSFileSharesOutput

Sourcemodule DescribeNFSFileSharesInput : sig ... end

DescribeNFSFileSharesInput

Sourcemodule DescribeMaintenanceStartTimeOutput : sig ... end

A JSON object containing the following fields: DescribeMaintenanceStartTimeOutput$SoftwareUpdatePreferences DescribeMaintenanceStartTimeOutput$DayOfMonth DescribeMaintenanceStartTimeOutput$DayOfWeek DescribeMaintenanceStartTimeOutput$HourOfDay DescribeMaintenanceStartTimeOutput$MinuteOfHour DescribeMaintenanceStartTimeOutput$Timezone

Sourcemodule DescribeMaintenanceStartTimeInput : sig ... end

A JSON object containing the Amazon Resource Name (ARN) of the gateway.

Sourcemodule DescribeGatewayInformationOutput : sig ... end

A JSON object containing the following fields:

Sourcemodule DescribeGatewayInformationInput : sig ... end

A JSON object containing the ID of the gateway.

Sourcemodule DescribeFileSystemAssociationsOutput : sig ... end

Gets the file system association information. This operation is only supported for FSx File Gateways.

Sourcemodule DescribeFileSystemAssociationsInput : sig ... end

Gets the file system association information. This operation is only supported for FSx File Gateways.

Sourcemodule DescribeChapCredentialsOutput : sig ... end

A JSON object containing the following fields:

Sourcemodule DescribeChapCredentialsInput : sig ... end

A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.

Sourcemodule DescribeCachediSCSIVolumesOutput : sig ... end

A JSON object containing the following fields:

Sourcemodule DescribeCachediSCSIVolumesInput : sig ... end

Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types. The list of gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).

Sourcemodule DescribeCacheReportOutput : sig ... end

Returns information about the specified cache report, including completion status and generation progress.

Sourcemodule DescribeCacheReportInput : sig ... end

Returns information about the specified cache report, including completion status and generation progress.

Sourcemodule DescribeCacheOutput : sig ... end

Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape, and file gateway types. The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.

Sourcemodule DescribeCacheInput : sig ... end

Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape, and file gateway types. The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.

Sourcemodule DescribeBandwidthRateLimitScheduleOutput : sig ... end

Returns information about the bandwidth rate limit schedule of a gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. This operation is supported only for volume, tape and S3 file gateways. FSx file gateways do not support bandwidth rate limits. This operation returns information about a gateway's bandwidth rate limit schedule. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both. A bandwidth rate limit interval consists of one or more days of the week, a start hour and minute, an ending hour and minute, and bandwidth rate limits for uploading and downloading If no bandwidth rate limit schedule intervals are set for the gateway, this operation returns an empty response. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

Sourcemodule DescribeBandwidthRateLimitScheduleInput : sig ... end

Returns information about the bandwidth rate limit schedule of a gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. This operation is supported only for volume, tape and S3 file gateways. FSx file gateways do not support bandwidth rate limits. This operation returns information about a gateway's bandwidth rate limit schedule. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both. A bandwidth rate limit interval consists of one or more days of the week, a start hour and minute, an ending hour and minute, and bandwidth rate limits for uploading and downloading If no bandwidth rate limit schedule intervals are set for the gateway, this operation returns an empty response. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

Sourcemodule DescribeBandwidthRateLimitOutput : sig ... end

A JSON object containing the following fields:

Sourcemodule DescribeBandwidthRateLimitInput : sig ... end

A JSON object containing the Amazon Resource Name (ARN) of the gateway.

Sourcemodule DescribeAvailabilityMonitorTestOutput : sig ... end

Returns information about the most recent high availability monitoring test that was performed on the host in a cluster. If a test isn't performed, the status and start time in the response would be null.

Sourcemodule DescribeAvailabilityMonitorTestInput : sig ... end

Returns information about the most recent high availability monitoring test that was performed on the host in a cluster. If a test isn't performed, the status and start time in the response would be null.

Sourcemodule DeleteVolumeOutput : sig ... end

A JSON object containing the Amazon Resource Name (ARN) of the storage volume that was deleted.

Sourcemodule DeleteVolumeInput : sig ... end

A JSON object containing the DeleteVolumeInput$VolumeARN to delete.

Sourcemodule DeleteTapePoolOutput : sig ... end

Delete a custom tape pool. A custom tape pool can only be deleted if there are no tapes in the pool and if there are no automatic tape creation policies that reference the custom tape pool.

Sourcemodule DeleteTapePoolInput : sig ... end

Delete a custom tape pool. A custom tape pool can only be deleted if there are no tapes in the pool and if there are no automatic tape creation policies that reference the custom tape pool.

Sourcemodule DeleteTapeOutput : sig ... end

DeleteTapeOutput

Sourcemodule DeleteTapeInput : sig ... end

DeleteTapeInput

Sourcemodule DeleteTapeArchiveOutput : sig ... end

DeleteTapeArchiveOutput

Sourcemodule DeleteTapeArchiveInput : sig ... end

DeleteTapeArchiveInput

Sourcemodule DeleteSnapshotScheduleOutput : sig ... end

Deletes a snapshot of a volume. You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Backing up your volumes. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported for cached volume gateway types. To list or delete a snapshot, you must use the Amazon EC2 API. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

Sourcemodule DeleteSnapshotScheduleInput : sig ... end

Deletes a snapshot of a volume. You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Backing up your volumes. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported for cached volume gateway types. To list or delete a snapshot, you must use the Amazon EC2 API. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

Sourcemodule DeleteGatewayOutput : sig ... end

A JSON object containing the ID of the deleted gateway.

Sourcemodule DeleteGatewayInput : sig ... end

A JSON object containing the ID of the gateway to delete.

Sourcemodule DeleteFileShareOutput : sig ... end

DeleteFileShareOutput

Sourcemodule DeleteFileShareInput : sig ... end

DeleteFileShareInput

Sourcemodule DeleteChapCredentialsOutput : sig ... end

A JSON object containing the following fields:

Sourcemodule DeleteChapCredentialsInput : sig ... end

A JSON object containing one or more of the following fields: DeleteChapCredentialsInput$InitiatorName DeleteChapCredentialsInput$TargetARN

Sourcemodule DeleteCacheReportOutput : sig ... end

Deletes the specified cache report and any associated tags from the Storage Gateway database. You can only delete completed reports. If the status of the report you attempt to delete still IN-PROGRESS, the delete operation returns an error. You can use CancelCacheReport to cancel an IN-PROGRESS report. DeleteCacheReport does not delete the report object from your Amazon S3 bucket.

Sourcemodule DeleteCacheReportInput : sig ... end

Deletes the specified cache report and any associated tags from the Storage Gateway database. You can only delete completed reports. If the status of the report you attempt to delete still IN-PROGRESS, the delete operation returns an error. You can use CancelCacheReport to cancel an IN-PROGRESS report. DeleteCacheReport does not delete the report object from your Amazon S3 bucket.

Sourcemodule DeleteBandwidthRateLimitOutput : sig ... end

A JSON object containing the Amazon Resource Name (ARN) of the gateway whose bandwidth rate information was deleted.

Sourcemodule DeleteBandwidthRateLimitInput : sig ... end

A JSON object containing the following fields: DeleteBandwidthRateLimitInput$BandwidthType

Sourcemodule DeleteAutomaticTapeCreationPolicyOutput : sig ... end

Deletes the automatic tape creation policy of a gateway. If you delete this policy, new virtual tapes must be created manually. Use the Amazon Resource Name (ARN) of the gateway in your request to remove the policy.

Sourcemodule DeleteAutomaticTapeCreationPolicyInput : sig ... end

Deletes the automatic tape creation policy of a gateway. If you delete this policy, new virtual tapes must be created manually. Use the Amazon Resource Name (ARN) of the gateway in your request to remove the policy.

Sourcemodule CreateTapesOutput : sig ... end

CreateTapeOutput

Sourcemodule CreateTapesInput : sig ... end

CreateTapesInput

Sourcemodule CreateTapeWithBarcodeOutput : sig ... end

CreateTapeOutput

Sourcemodule CreateTapeWithBarcodeInput : sig ... end

CreateTapeWithBarcodeInput

Sourcemodule CreateTapePoolOutput : sig ... end

Creates a new custom tape pool. You can use custom tape pool to enable tape retention lock on tapes that are archived in the custom pool.

Sourcemodule CreateTapePoolInput : sig ... end

Creates a new custom tape pool. You can use custom tape pool to enable tape retention lock on tapes that are archived in the custom pool.

Sourcemodule CreateStorediSCSIVolumeOutput : sig ... end

A JSON object containing the following fields:

Sourcemodule CreateStorediSCSIVolumeInput : sig ... end

A JSON object containing one or more of the following fields: CreateStorediSCSIVolumeInput$DiskId CreateStorediSCSIVolumeInput$NetworkInterfaceId CreateStorediSCSIVolumeInput$PreserveExistingData CreateStorediSCSIVolumeInput$SnapshotId CreateStorediSCSIVolumeInput$TargetName

Sourcemodule CreateSnapshotOutput : sig ... end

A JSON object containing the following fields:

Sourcemodule CreateSnapshotInput : sig ... end

A JSON object containing one or more of the following fields: CreateSnapshotInput$SnapshotDescription CreateSnapshotInput$VolumeARN

Sourcemodule CreateSnapshotFromVolumeRecoveryPointOutput : sig ... end

Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for cached volume gateway, use ListVolumeRecoveryPoints. In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and its description appear in the Storage Gateway console. In response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the Amazon Elastic Compute Cloud API Reference.

Sourcemodule CreateSnapshotFromVolumeRecoveryPointInput : sig ... end

Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for cached volume gateway, use ListVolumeRecoveryPoints. In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and its description appear in the Storage Gateway console. In response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the Amazon Elastic Compute Cloud API Reference.

Sourcemodule CreateSMBFileShareOutput : sig ... end

CreateSMBFileShareOutput

Sourcemodule CreateSMBFileShareInput : sig ... end

CreateSMBFileShareInput

Sourcemodule CreateNFSFileShareOutput : sig ... end

CreateNFSFileShareOutput

Sourcemodule CreateNFSFileShareInput : sig ... end

CreateNFSFileShareInput

Sourcemodule CreateCachediSCSIVolumeOutput : sig ... end

Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type. Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway. In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes.

Sourcemodule CreateCachediSCSIVolumeInput : sig ... end

Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type. Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway. In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes.

Sourcemodule CancelRetrievalOutput : sig ... end

CancelRetrievalOutput

Sourcemodule CancelRetrievalInput : sig ... end

CancelRetrievalInput

Sourcemodule CancelCacheReportOutput : sig ... end

Cancels generation of a specified cache report. You can use this operation to manually cancel an IN-PROGRESS report for any reason. This action changes the report status from IN-PROGRESS to CANCELLED. You can only cancel in-progress reports. If the the report you attempt to cancel is in FAILED, ERROR, or COMPLETED state, the cancel operation returns an error.

Sourcemodule CancelCacheReportInput : sig ... end

Cancels generation of a specified cache report. You can use this operation to manually cancel an IN-PROGRESS report for any reason. This action changes the report status from IN-PROGRESS to CANCELLED. You can only cancel in-progress reports. If the the report you attempt to cancel is in FAILED, ERROR, or COMPLETED state, the cancel operation returns an error.

Sourcemodule CancelArchivalOutput : sig ... end

CancelArchivalOutput

Sourcemodule CancelArchivalInput : sig ... end

CancelArchivalInput

Sourcemodule AttachVolumeOutput : sig ... end

AttachVolumeOutput

Sourcemodule AttachVolumeInput : sig ... end

AttachVolumeInput

Sourcemodule AssociateFileSystemOutput : sig ... end

Associate an Amazon FSx file system with the FSx File Gateway. After the association process is complete, the file shares on the Amazon FSx file system are available for access through the gateway. This operation only supports the FSx File Gateway type.

Sourcemodule AssociateFileSystemInput : sig ... end

Associate an Amazon FSx file system with the FSx File Gateway. After the association process is complete, the file shares on the Amazon FSx file system are available for access through the gateway. This operation only supports the FSx File Gateway type.

Sourcemodule AssignTapePoolOutput : sig ... end

Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

Sourcemodule AssignTapePoolInput : sig ... end

Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

Sourcemodule AddWorkingStorageOutput : sig ... end

A JSON object containing the Amazon Resource Name (ARN) of the gateway for which working storage was configured.

Sourcemodule AddWorkingStorageInput : sig ... end

A JSON object containing one or more of the following fields: AddWorkingStorageInput$DiskIds

Sourcemodule AddUploadBufferOutput : sig ... end

Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for the stored volume, cached volume, and tape gateway types. In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer.

Sourcemodule AddUploadBufferInput : sig ... end

Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for the stored volume, cached volume, and tape gateway types. In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer.

Sourcemodule AddTagsToResourceOutput : sig ... end

AddTagsToResourceOutput

Sourcemodule AddTagsToResourceInput : sig ... end

AddTagsToResourceInput

Sourcemodule AddCacheOutput : sig ... end

Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape, and file gateway type (see How Storage Gateway works (architecture). In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.

Sourcemodule AddCacheInput : sig ... end

Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape, and file gateway type (see How Storage Gateway works (architecture). In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.

Sourcemodule ActivateGatewayOutput : sig ... end

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.

Sourcemodule ActivateGatewayInput : sig ... end

A JSON object containing one or more of the following fields: ActivateGatewayInput$ActivationKey ActivateGatewayInput$GatewayName ActivateGatewayInput$GatewayRegion ActivateGatewayInput$GatewayTimezone ActivateGatewayInput$GatewayType ActivateGatewayInput$MediumChangerType ActivateGatewayInput$TapeDriveType