# Data Types
<a name="API_Types"></a>

The Storage Gateway API contains several data types that various actions use. This section describes each data type in detail.

**Note**  
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.

The following data types are supported:
+  [AutomaticTapeCreationPolicyInfo](API_AutomaticTapeCreationPolicyInfo.md) 
+  [AutomaticTapeCreationRule](API_AutomaticTapeCreationRule.md) 
+  [BandwidthRateLimitInterval](API_BandwidthRateLimitInterval.md) 
+  [CacheAttributes](API_CacheAttributes.md) 
+  [CachediSCSIVolume](API_CachediSCSIVolume.md) 
+  [CacheReportFilter](API_CacheReportFilter.md) 
+  [CacheReportInfo](API_CacheReportInfo.md) 
+  [ChapInfo](API_ChapInfo.md) 
+  [DeviceiSCSIAttributes](API_DeviceiSCSIAttributes.md) 
+  [Disk](API_Disk.md) 
+  [EndpointNetworkConfiguration](API_EndpointNetworkConfiguration.md) 
+  [FileShareInfo](API_FileShareInfo.md) 
+  [FileSystemAssociationInfo](API_FileSystemAssociationInfo.md) 
+  [FileSystemAssociationStatusDetail](API_FileSystemAssociationStatusDetail.md) 
+  [FileSystemAssociationSummary](API_FileSystemAssociationSummary.md) 
+  [GatewayInfo](API_GatewayInfo.md) 
+  [NetworkInterface](API_NetworkInterface.md) 
+  [NFSFileShareDefaults](API_NFSFileShareDefaults.md) 
+  [NFSFileShareInfo](API_NFSFileShareInfo.md) 
+  [PoolInfo](API_PoolInfo.md) 
+  [SMBFileShareInfo](API_SMBFileShareInfo.md) 
+  [SMBLocalGroups](API_SMBLocalGroups.md) 
+  [SoftwareUpdatePreferences](API_SoftwareUpdatePreferences.md) 
+  [StorageGatewayError](API_StorageGatewayError.md) 
+  [StorediSCSIVolume](API_StorediSCSIVolume.md) 
+  [Tag](API_Tag.md) 
+  [Tape](API_Tape.md) 
+  [TapeArchive](API_TapeArchive.md) 
+  [TapeInfo](API_TapeInfo.md) 
+  [TapeRecoveryPointInfo](API_TapeRecoveryPointInfo.md) 
+  [VolumeInfo](API_VolumeInfo.md) 
+  [VolumeiSCSIAttributes](API_VolumeiSCSIAttributes.md) 
+  [VolumeRecoveryPointInfo](API_VolumeRecoveryPointInfo.md) 
+  [VTLDevice](API_VTLDevice.md) 

# AutomaticTapeCreationPolicyInfo
<a name="API_AutomaticTapeCreationPolicyInfo"></a>

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

## Contents
<a name="API_AutomaticTapeCreationPolicyInfo_Contents"></a>

 ** AutomaticTapeCreationRules **   <a name="StorageGateway-Type-AutomaticTapeCreationPolicyInfo-AutomaticTapeCreationRules"></a>
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.  
Type: Array of [AutomaticTapeCreationRule](API_AutomaticTapeCreationRule.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: No

 ** GatewayARN **   <a name="StorageGateway-Type-AutomaticTapeCreationPolicyInfo-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and Amazon Web Services Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: No

## See Also
<a name="API_AutomaticTapeCreationPolicyInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/AutomaticTapeCreationPolicyInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/AutomaticTapeCreationPolicyInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/AutomaticTapeCreationPolicyInfo) 

# AutomaticTapeCreationRule
<a name="API_AutomaticTapeCreationRule"></a>

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](https://docs.amazonaws.cn/storagegateway/latest/userguide/GettingStartedCreateTapes.html#CreateTapesAutomatically).

## Contents
<a name="API_AutomaticTapeCreationRule_Contents"></a>

 ** MinimumNumTapes **   <a name="StorageGateway-Type-AutomaticTapeCreationRule-MinimumNumTapes"></a>
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](https://docs.amazonaws.cn/storagegateway/latest/userguide/GettingStartedCreateTapes.html#CreateTapesAutomatically).  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 10.  
Required: Yes

 ** PoolId **   <a name="StorageGateway-Type-AutomaticTapeCreationRule-PoolId"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** TapeBarcodePrefix **   <a name="StorageGateway-Type-AutomaticTapeCreationRule-TapeBarcodePrefix"></a>
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.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4.  
Pattern: `^[A-Z]*$`   
Required: Yes

 ** TapeSizeInBytes **   <a name="StorageGateway-Type-AutomaticTapeCreationRule-TapeSizeInBytes"></a>
The size, in bytes, of the virtual tape capacity.  
Type: Long  
Required: Yes

 ** Worm **   <a name="StorageGateway-Type-AutomaticTapeCreationRule-Worm"></a>
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.  
Type: Boolean  
Required: No

## See Also
<a name="API_AutomaticTapeCreationRule_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/AutomaticTapeCreationRule) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/AutomaticTapeCreationRule) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/AutomaticTapeCreationRule) 

# BandwidthRateLimitInterval
<a name="API_BandwidthRateLimitInterval"></a>

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.

**Note**  
FSx File Gateway does not support this feature.

## Contents
<a name="API_BandwidthRateLimitInterval_Contents"></a>

 ** DaysOfWeek **   <a name="StorageGateway-Type-BandwidthRateLimitInterval-DaysOfWeek"></a>
 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.   
Type: Array of integers  
Array Members: Minimum number of 1 item. Maximum number of 7 items.  
Valid Range: Minimum value of 0. Maximum value of 6.  
Required: Yes

 ** EndHourOfDay **   <a name="StorageGateway-Type-BandwidthRateLimitInterval-EndHourOfDay"></a>
 The hour of the day to end the bandwidth rate limit interval.   
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 23.  
Required: Yes

 ** EndMinuteOfHour **   <a name="StorageGateway-Type-BandwidthRateLimitInterval-EndMinuteOfHour"></a>
 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`. 
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 59.  
Required: Yes

 ** StartHourOfDay **   <a name="StorageGateway-Type-BandwidthRateLimitInterval-StartHourOfDay"></a>
 The hour of the day to start the bandwidth rate limit interval.   
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 23.  
Required: Yes

 ** StartMinuteOfHour **   <a name="StorageGateway-Type-BandwidthRateLimitInterval-StartMinuteOfHour"></a>
 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`.   
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 59.  
Required: Yes

 ** AverageDownloadRateLimitInBitsPerSec **   <a name="StorageGateway-Type-BandwidthRateLimitInterval-AverageDownloadRateLimitInBitsPerSec"></a>
 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.
Type: Long  
Valid Range: Minimum value of 102400.  
Required: No

 ** AverageUploadRateLimitInBitsPerSec **   <a name="StorageGateway-Type-BandwidthRateLimitInterval-AverageUploadRateLimitInBitsPerSec"></a>
 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`.
Type: Long  
Valid Range: Minimum value of 51200.  
Required: No

## See Also
<a name="API_BandwidthRateLimitInterval_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/BandwidthRateLimitInterval) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/BandwidthRateLimitInterval) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/BandwidthRateLimitInterval) 

# CacheAttributes
<a name="API_CacheAttributes"></a>

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

## Contents
<a name="API_CacheAttributes_Contents"></a>

 ** CacheStaleTimeoutInSeconds **   <a name="StorageGateway-Type-CacheAttributes-CacheStaleTimeoutInSeconds"></a>
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)  
Type: Integer  
Required: No

## See Also
<a name="API_CacheAttributes_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/CacheAttributes) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/CacheAttributes) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/CacheAttributes) 

# CachediSCSIVolume
<a name="API_CachediSCSIVolume"></a>

Describes an iSCSI cached volume.

## Contents
<a name="API_CachediSCSIVolume_Contents"></a>

 ** CreatedDate **   <a name="StorageGateway-Type-CachediSCSIVolume-CreatedDate"></a>
The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.  
Type: Timestamp  
Required: No

 ** KMSKey **   <a name="StorageGateway-Type-CachediSCSIVolume-KMSKey"></a>
Optional. The Amazon Resource Name (ARN) of a symmetric Amazon KMS key used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric KMS keys. This value must be set if `KMSEncrypted` is `true`, or if `EncryptionType` is `SseKms` or `DsseKms`.  
Type: String  
Length Constraints: Minimum length of 7. Maximum length of 2048.  
Pattern: `(^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)`   
Required: No

 ** SourceSnapshotId **   <a name="StorageGateway-Type-CachediSCSIVolume-SourceSnapshotId"></a>
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.  
Type: String  
Pattern: `\Asnap-([0-9A-Fa-f]{8}|[0-9A-Fa-f]{17})\z`   
Required: No

 ** TargetName **   <a name="StorageGateway-Type-CachediSCSIVolume-TargetName"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[-\.;a-z0-9]+$`   
Required: No

 ** VolumeARN **   <a name="StorageGateway-Type-CachediSCSIVolume-VolumeARN"></a>
The Amazon Resource Name (ARN) of the storage volume.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)`   
Required: No

 ** VolumeAttachmentStatus **   <a name="StorageGateway-Type-CachediSCSIVolume-VolumeAttachmentStatus"></a>
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](https://docs.amazonaws.cn/storagegateway/latest/userguide/managing-volumes.html#attach-detach-volume).  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 50.  
Required: No

 ** VolumeId **   <a name="StorageGateway-Type-CachediSCSIVolume-VolumeId"></a>
The unique identifier of the volume, e.g., vol-AE4B946D.  
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 30.  
Required: No

 ** VolumeiSCSIAttributes **   <a name="StorageGateway-Type-CachediSCSIVolume-VolumeiSCSIAttributes"></a>
An [VolumeiSCSIAttributes](API_VolumeiSCSIAttributes.md) object that represents a collection of iSCSI attributes for one stored volume.  
Type: [VolumeiSCSIAttributes](API_VolumeiSCSIAttributes.md) object  
Required: No

 ** VolumeProgress **   <a name="StorageGateway-Type-CachediSCSIVolume-VolumeProgress"></a>
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.  
Type: Double  
Required: No

 ** VolumeSizeInBytes **   <a name="StorageGateway-Type-CachediSCSIVolume-VolumeSizeInBytes"></a>
The size, in bytes, of the volume capacity.  
Type: Long  
Required: No

 ** VolumeStatus **   <a name="StorageGateway-Type-CachediSCSIVolume-VolumeStatus"></a>
One of the VolumeStatus values that indicates the state of the storage volume.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 50.  
Required: No

 ** VolumeType **   <a name="StorageGateway-Type-CachediSCSIVolume-VolumeType"></a>
One of the VolumeType enumeration values that describes the type of the volume.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 100.  
Required: No

 ** VolumeUsedInBytes **   <a name="StorageGateway-Type-CachediSCSIVolume-VolumeUsedInBytes"></a>
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.
Type: Long  
Required: No

## See Also
<a name="API_CachediSCSIVolume_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/CachediSCSIVolume) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/CachediSCSIVolume) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/CachediSCSIVolume) 

# CacheReportFilter
<a name="API_CacheReportFilter"></a>

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.

## Contents
<a name="API_CacheReportFilter_Contents"></a>

 ** Name **   <a name="StorageGateway-Type-CacheReportFilter-Name"></a>
The parameter name for a filter that determines which files are included or excluded from a cache report.  
 **Valid Names:**   
UploadFailureReason \$1 UploadState  
Type: String  
Valid Values: `UploadState | UploadFailureReason`   
Required: Yes

 ** Values **   <a name="StorageGateway-Type-CacheReportFilter-Values"></a>
The parameter value for a filter that determines which files are included or excluded from a cache report.  
 **Valid `UploadFailureReason` Values:**   
 `InaccessibleStorageClass` \$1 `InvalidObjectState` \$1 `ObjectMissing` \$1 `S3AccessDenied`   
 **Valid `UploadState` Values:**   
 `FailingUpload`   
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 25.  
Required: Yes

## See Also
<a name="API_CacheReportFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/CacheReportFilter) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/CacheReportFilter) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/CacheReportFilter) 

# CacheReportInfo
<a name="API_CacheReportInfo"></a>

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

## Contents
<a name="API_CacheReportInfo_Contents"></a>

 ** CacheReportARN **   <a name="StorageGateway-Type-CacheReportInfo-CacheReportARN"></a>
The Amazon Resource Name (ARN) of the cache report you want to describe.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: No

 ** CacheReportStatus **   <a name="StorageGateway-Type-CacheReportInfo-CacheReportStatus"></a>
The status of the specified cache report.  
Type: String  
Valid Values: `IN_PROGRESS | COMPLETED | CANCELED | FAILED | ERROR`   
Required: No

 ** EndTime **   <a name="StorageGateway-Type-CacheReportInfo-EndTime"></a>
The time at which the gateway stopped generating the cache report.  
Type: Timestamp  
Required: No

 ** ExclusionFilters **   <a name="StorageGateway-Type-CacheReportInfo-ExclusionFilters"></a>
The list of filters and parameters that determine which files are excluded from the report.  
Type: Array of [CacheReportFilter](API_CacheReportFilter.md) objects  
Required: No

 ** FileShareARN **   <a name="StorageGateway-Type-CacheReportInfo-FileShareARN"></a>
The Amazon Resource Name (ARN) of the file share.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: No

 ** InclusionFilters **   <a name="StorageGateway-Type-CacheReportInfo-InclusionFilters"></a>
The list of filters and parameters that determine which files are included in the report.  
Type: Array of [CacheReportFilter](API_CacheReportFilter.md) objects  
Required: No

 ** LocationARN **   <a name="StorageGateway-Type-CacheReportInfo-LocationARN"></a>
The ARN of the Amazon S3 bucket location where the cache report is saved.  
Type: String  
Length Constraints: Minimum length of 16. Maximum length of 1400.  
Required: No

 ** ReportCompletionPercent **   <a name="StorageGateway-Type-CacheReportInfo-ReportCompletionPercent"></a>
The percentage of the report generation process that has been completed at time of inquiry.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** ReportName **   <a name="StorageGateway-Type-CacheReportInfo-ReportName"></a>
The file name of the completed cache report object stored in Amazon S3.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** Role **   <a name="StorageGateway-Type-CacheReportInfo-Role"></a>
The ARN of the IAM role that an S3 File Gateway assumes when it accesses the underlying storage.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):iam::([0-9]+):role/(\S+)$`   
Required: No

 ** StartTime **   <a name="StorageGateway-Type-CacheReportInfo-StartTime"></a>
The time at which the gateway started generating the cache report.  
Type: Timestamp  
Required: No

 ** Tags **   <a name="StorageGateway-Type-CacheReportInfo-Tags"></a>
The list of key/value tags associated with the report.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_CacheReportInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/CacheReportInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/CacheReportInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/CacheReportInfo) 

# ChapInfo
<a name="API_ChapInfo"></a>

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

## Contents
<a name="API_ChapInfo_Contents"></a>

 ** InitiatorName **   <a name="StorageGateway-Type-ChapInfo-InitiatorName"></a>
The iSCSI initiator that connects to the target.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[0-9a-z:.-]+`   
Required: No

 ** SecretToAuthenticateInitiator **   <a name="StorageGateway-Type-ChapInfo-SecretToAuthenticateInitiator"></a>
The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** SecretToAuthenticateTarget **   <a name="StorageGateway-Type-ChapInfo-SecretToAuthenticateTarget"></a>
The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g., Windows client).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** TargetARN **   <a name="StorageGateway-Type-ChapInfo-TargetARN"></a>
The Amazon Resource Name (ARN) of the volume.  
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 800.  
Required: No

## See Also
<a name="API_ChapInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/ChapInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/ChapInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/ChapInfo) 

# DeviceiSCSIAttributes
<a name="API_DeviceiSCSIAttributes"></a>

Lists iSCSI information about a VTL device.

## Contents
<a name="API_DeviceiSCSIAttributes_Contents"></a>

 ** ChapEnabled **   <a name="StorageGateway-Type-DeviceiSCSIAttributes-ChapEnabled"></a>
Indicates whether mutual CHAP is enabled for the iSCSI target.  
Type: Boolean  
Required: No

 ** NetworkInterfaceId **   <a name="StorageGateway-Type-DeviceiSCSIAttributes-NetworkInterfaceId"></a>
The network interface identifier of the VTL device.  
Type: String  
Required: No

 ** NetworkInterfacePort **   <a name="StorageGateway-Type-DeviceiSCSIAttributes-NetworkInterfacePort"></a>
The port used to communicate with iSCSI VTL device targets.  
Type: Integer  
Required: No

 ** TargetARN **   <a name="StorageGateway-Type-DeviceiSCSIAttributes-TargetARN"></a>
Specifies the unique Amazon Resource Name (ARN) that encodes the iSCSI qualified name(iqn) of a tape drive or media changer target.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 800.  
Required: No

## See Also
<a name="API_DeviceiSCSIAttributes_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/DeviceiSCSIAttributes) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/DeviceiSCSIAttributes) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/DeviceiSCSIAttributes) 

# Disk
<a name="API_Disk"></a>

Represents a gateway's local disk.

## Contents
<a name="API_Disk_Contents"></a>

 ** DiskAllocationResource **   <a name="StorageGateway-Type-Disk-DiskAllocationResource"></a>
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*.  
Type: String  
Required: No

 ** DiskAllocationType **   <a name="StorageGateway-Type-Disk-DiskAllocationType"></a>
One of the `DiskAllocationType` enumeration values that identifies how a local disk is used.  
Valid Values: `UPLOAD_BUFFER` \$1 `CACHE_STORAGE`   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 100.  
Required: No

 ** DiskAttributeList **   <a name="StorageGateway-Type-Disk-DiskAttributeList"></a>
A list of values that represents attributes of a local disk.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

 ** DiskId **   <a name="StorageGateway-Type-Disk-DiskId"></a>
The unique device ID or other distinguishing data that identifies a local disk.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 300.  
Required: No

 ** DiskNode **   <a name="StorageGateway-Type-Disk-DiskNode"></a>
The device node of a local disk as assigned by the virtualization environment.  
Type: String  
Required: No

 ** DiskPath **   <a name="StorageGateway-Type-Disk-DiskPath"></a>
The path of a local disk in the gateway virtual machine (VM).  
Type: String  
Required: No

 ** DiskSizeInBytes **   <a name="StorageGateway-Type-Disk-DiskSizeInBytes"></a>
The local disk size in bytes.  
Type: Long  
Required: No

 ** DiskStatus **   <a name="StorageGateway-Type-Disk-DiskStatus"></a>
A value that represents the status of a local disk.  
Type: String  
Required: No

## See Also
<a name="API_Disk_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/Disk) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/Disk) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/Disk) 

# EndpointNetworkConfiguration
<a name="API_EndpointNetworkConfiguration"></a>

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

## Contents
<a name="API_EndpointNetworkConfiguration_Contents"></a>

 ** IpAddresses **   <a name="StorageGateway-Type-EndpointNetworkConfiguration-IpAddresses"></a>
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.
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Length Constraints: Minimum length of 7. Maximum length of 15.  
Pattern: `^((25[0-5]|(2[0-4]|1[0-9]|[1-9]|)[0-9])(\.(?!$)|$)){4}`   
Required: No

## See Also
<a name="API_EndpointNetworkConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/EndpointNetworkConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/EndpointNetworkConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/EndpointNetworkConfiguration) 

# FileShareInfo
<a name="API_FileShareInfo"></a>

Describes a file share. Only supported S3 File Gateway.

## Contents
<a name="API_FileShareInfo_Contents"></a>

 ** FileShareARN **   <a name="StorageGateway-Type-FileShareInfo-FileShareARN"></a>
The Amazon Resource Name (ARN) of the file share.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: No

 ** FileShareId **   <a name="StorageGateway-Type-FileShareInfo-FileShareId"></a>
The ID of the file share.  
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 30.  
Required: No

 ** FileShareStatus **   <a name="StorageGateway-Type-FileShareInfo-FileShareStatus"></a>
The status of the file share.  
Valid Values: `CREATING` \$1 `UPDATING` \$1 `AVAILABLE` \$1 `DELETING`   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 50.  
Required: No

 ** FileShareType **   <a name="StorageGateway-Type-FileShareInfo-FileShareType"></a>
The type of the file share.  
Type: String  
Valid Values: `NFS | SMB`   
Required: No

 ** GatewayARN **   <a name="StorageGateway-Type-FileShareInfo-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and Amazon Web Services Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: No

## See Also
<a name="API_FileShareInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/FileShareInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/FileShareInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/FileShareInfo) 

# FileSystemAssociationInfo
<a name="API_FileSystemAssociationInfo"></a>

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

## Contents
<a name="API_FileSystemAssociationInfo_Contents"></a>

 ** AuditDestinationARN **   <a name="StorageGateway-Type-FileSystemAssociationInfo-AuditDestinationARN"></a>
The Amazon Resource Name (ARN) of the storage used for the audit logs.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** CacheAttributes **   <a name="StorageGateway-Type-FileSystemAssociationInfo-CacheAttributes"></a>
The refresh cache information for the file share or FSx file systems.  
Type: [CacheAttributes](API_CacheAttributes.md) object  
Required: No

 ** EndpointNetworkConfiguration **   <a name="StorageGateway-Type-FileSystemAssociationInfo-EndpointNetworkConfiguration"></a>
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.
Type: [EndpointNetworkConfiguration](API_EndpointNetworkConfiguration.md) object  
Required: No

 ** FileSystemAssociationARN **   <a name="StorageGateway-Type-FileSystemAssociationInfo-FileSystemAssociationARN"></a>
The Amazon Resource Name (ARN) of the file system association.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: No

 ** FileSystemAssociationStatus **   <a name="StorageGateway-Type-FileSystemAssociationInfo-FileSystemAssociationStatus"></a>
The status of the file system association. Valid Values: `AVAILABLE` \$1 `CREATING` \$1 `DELETING` \$1 `FORCE_DELETING` \$1 `UPDATING` \$1 `ERROR`   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 50.  
Required: No

 ** FileSystemAssociationStatusDetails **   <a name="StorageGateway-Type-FileSystemAssociationInfo-FileSystemAssociationStatusDetails"></a>
An array containing the FileSystemAssociationStatusDetail data type, which provides detailed information on file system association status.  
Type: Array of [FileSystemAssociationStatusDetail](API_FileSystemAssociationStatusDetail.md) objects  
Required: No

 ** GatewayARN **   <a name="StorageGateway-Type-FileSystemAssociationInfo-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and Amazon Web Services Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: No

 ** LocationARN **   <a name="StorageGateway-Type-FileSystemAssociationInfo-LocationARN"></a>
The ARN of the backend Amazon FSx file system used for storing file data. For information, see [FileSystem](https://docs.amazonaws.cn/fsx/latest/APIReference/API_FileSystem.html) in the *Amazon FSx API Reference*.  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 512.  
Required: No

 ** Tags **   <a name="StorageGateway-Type-FileSystemAssociationInfo-Tags"></a>
A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a key-value pair.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_FileSystemAssociationInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/FileSystemAssociationInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/FileSystemAssociationInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/FileSystemAssociationInfo) 

# FileSystemAssociationStatusDetail
<a name="API_FileSystemAssociationStatusDetail"></a>

Detailed information on file system association status.

## Contents
<a name="API_FileSystemAssociationStatusDetail_Contents"></a>

 ** ErrorCode **   <a name="StorageGateway-Type-FileSystemAssociationStatusDetail-ErrorCode"></a>
The error code for a given file system association status.  
Type: String  
Required: No

## See Also
<a name="API_FileSystemAssociationStatusDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/FileSystemAssociationStatusDetail) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/FileSystemAssociationStatusDetail) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/FileSystemAssociationStatusDetail) 

# FileSystemAssociationSummary
<a name="API_FileSystemAssociationSummary"></a>

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

## Contents
<a name="API_FileSystemAssociationSummary_Contents"></a>

 ** FileSystemAssociationARN **   <a name="StorageGateway-Type-FileSystemAssociationSummary-FileSystemAssociationARN"></a>
The Amazon Resource Name (ARN) of the file system association.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: No

 ** FileSystemAssociationId **   <a name="StorageGateway-Type-FileSystemAssociationSummary-FileSystemAssociationId"></a>
The ID of the file system association.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 30.  
Required: No

 ** FileSystemAssociationStatus **   <a name="StorageGateway-Type-FileSystemAssociationSummary-FileSystemAssociationStatus"></a>
The status of the file share. Valid Values: `AVAILABLE` \$1 `CREATING` \$1 `DELETING` \$1 `FORCE_DELETING` \$1 `UPDATING` \$1 `ERROR`   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 50.  
Required: No

 ** GatewayARN **   <a name="StorageGateway-Type-FileSystemAssociationSummary-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and Amazon Web Services Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: No

## See Also
<a name="API_FileSystemAssociationSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/FileSystemAssociationSummary) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/FileSystemAssociationSummary) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/FileSystemAssociationSummary) 

# GatewayInfo
<a name="API_GatewayInfo"></a>

Describes a gateway object.

## Contents
<a name="API_GatewayInfo_Contents"></a>

 ** DeprecationDate **   <a name="StorageGateway-Type-GatewayInfo-DeprecationDate"></a>
Date after which this gateway will not receive software updates for new features and bug fixes.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 25.  
Required: No

 ** Ec2InstanceId **   <a name="StorageGateway-Type-GatewayInfo-Ec2InstanceId"></a>
The ID of the Amazon EC2 instance that was used to launch the gateway.  
Type: String  
Required: No

 ** Ec2InstanceRegion **   <a name="StorageGateway-Type-GatewayInfo-Ec2InstanceRegion"></a>
The Amazon Web Services Region where the Amazon EC2 instance is located.  
Type: String  
Required: No

 ** GatewayARN **   <a name="StorageGateway-Type-GatewayInfo-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and Amazon Web Services Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: No

 ** GatewayId **   <a name="StorageGateway-Type-GatewayInfo-GatewayId"></a>
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.  
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 30.  
Required: No

 ** GatewayName **   <a name="StorageGateway-Type-GatewayInfo-GatewayName"></a>
The name of the gateway.  
Type: String  
Required: No

 ** GatewayOperationalState **   <a name="StorageGateway-Type-GatewayInfo-GatewayOperationalState"></a>
The state of the gateway.  
Valid Values: `DISABLED` \$1 `ACTIVE`   
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 25.  
Required: No

 ** GatewayType **   <a name="StorageGateway-Type-GatewayInfo-GatewayType"></a>
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](https://aws.amazon.com/blogs/storage/switch-your-file-share-access-from-amazon-fsx-file-gateway-to-amazon-fsx-for-windows-file-server/).
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 20.  
Required: No

 ** HostEnvironment **   <a name="StorageGateway-Type-GatewayInfo-HostEnvironment"></a>
The type of hardware or software platform on which the gateway is running.  
Tape Gateway is no longer available on Snow Family devices.
Type: String  
Valid Values: `VMWARE | HYPER-V | EC2 | KVM | OTHER | SNOWBALL`   
Required: No

 ** HostEnvironmentId **   <a name="StorageGateway-Type-GatewayInfo-HostEnvironmentId"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** SoftwareVersion **   <a name="StorageGateway-Type-GatewayInfo-SoftwareVersion"></a>
The version number of the software running on the gateway appliance.  
Type: String  
Required: No

## See Also
<a name="API_GatewayInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/GatewayInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/GatewayInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/GatewayInfo) 

# NetworkInterface
<a name="API_NetworkInterface"></a>

Describes a gateway's network interface.

## Contents
<a name="API_NetworkInterface_Contents"></a>

 ** Ipv4Address **   <a name="StorageGateway-Type-NetworkInterface-Ipv4Address"></a>
The Internet Protocol version 4 (IPv4) address of the interface.  
Type: String  
Required: No

 ** Ipv6Address **   <a name="StorageGateway-Type-NetworkInterface-Ipv6Address"></a>
The Internet Protocol version 6 (IPv6) address of the interface.  
This element returns IPv6 addresses for all gateway types except FSx File Gateway.
Type: String  
Required: No

 ** MacAddress **   <a name="StorageGateway-Type-NetworkInterface-MacAddress"></a>
The Media Access Control (MAC) address of the interface.  
This is currently unsupported and will not be returned in output.
Type: String  
Required: No

## See Also
<a name="API_NetworkInterface_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/NetworkInterface) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/NetworkInterface) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/NetworkInterface) 

# NFSFileShareDefaults
<a name="API_NFSFileShareDefaults"></a>

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.

## Contents
<a name="API_NFSFileShareDefaults_Contents"></a>

 ** DirectoryMode **   <a name="StorageGateway-Type-NFSFileShareDefaults-DirectoryMode"></a>
The Unix directory mode in the form "nnnn". For example, `0666` represents the default access mode for all directories inside the file share. The default value is `0777`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4.  
Pattern: `^[0-7]{4}$`   
Required: No

 ** FileMode **   <a name="StorageGateway-Type-NFSFileShareDefaults-FileMode"></a>
The Unix file mode in the form "nnnn". For example, `0666` represents the default file mode inside the file share. The default value is `0666`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4.  
Pattern: `^[0-7]{4}$`   
Required: No

 ** GroupId **   <a name="StorageGateway-Type-NFSFileShareDefaults-GroupId"></a>
The default group ID for the file share (unless the files have another group ID specified). The default value is `nfsnobody`.  
Type: Long  
Valid Range: Minimum value of 0. Maximum value of 4294967294.  
Required: No

 ** OwnerId **   <a name="StorageGateway-Type-NFSFileShareDefaults-OwnerId"></a>
The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is `nfsnobody`.  
Type: Long  
Valid Range: Minimum value of 0. Maximum value of 4294967294.  
Required: No

## See Also
<a name="API_NFSFileShareDefaults_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/NFSFileShareDefaults) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/NFSFileShareDefaults) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/NFSFileShareDefaults) 

# NFSFileShareInfo
<a name="API_NFSFileShareInfo"></a>

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.

## Contents
<a name="API_NFSFileShareInfo_Contents"></a>

 ** AuditDestinationARN **   <a name="StorageGateway-Type-NFSFileShareInfo-AuditDestinationARN"></a>
The Amazon Resource Name (ARN) of the storage used for audit logs.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** BucketRegion **   <a name="StorageGateway-Type-NFSFileShareInfo-BucketRegion"></a>
Specifies the Region of the S3 bucket where the NFS file share stores files.  
This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 25.  
Required: No

 ** CacheAttributes **   <a name="StorageGateway-Type-NFSFileShareInfo-CacheAttributes"></a>
Refresh cache information for the file share.  
Type: [CacheAttributes](API_CacheAttributes.md) object  
Required: No

 ** ClientList **   <a name="StorageGateway-Type-NFSFileShareInfo-ClientList"></a>
The list of clients that are allowed to access the S3 File Gateway. The list must contain either valid IPv4/IPv6 addresses or valid CIDR blocks.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Pattern: `^(?:(?:[0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}(?:[0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(?:\/(?:[0-9]|[1-2][0-9]|3[0-2]))?$|^(?:(?:(?:[A-Fa-f0-9]{1,4}:){6}|(?=(?:[A-Fa-f0-9]{0,4}:){0,6}(?:[0-9]{1,3}\.){3}[0-9]{1,3}(?![:.\w]))(?:(?:[0-9A-Fa-f]{1,4}:){0,5}|:)(?:(?::[0-9A-Fa-f]{1,4}){1,5}:|:)|::(?:[A-Fa-f0-9]{1,4}:){5})(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}|(?=(?:[A-Fa-f0-9]{0,4}:){0,7}[A-Fa-f0-9]{0,4}(?![:.\w]))(?:(?:[0-9A-Fa-f]{1,4}:){1,7}|:)(?:(:[0-9A-Fa-f]{1,4}){1,7}|:)|(?:[A-Fa-f0-9]{1,4}:){7}:|:(:[A-Fa-f0-9]{1,4}){7})(?:\/(?:12[0-8]|1[01][0-9]|[1-9]?[0-9]))?$`   
Required: No

 ** DefaultStorageClass **   <a name="StorageGateway-Type-NFSFileShareInfo-DefaultStorageClass"></a>
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is `S3_STANDARD`. Optional.  
Valid Values: `S3_STANDARD` \$1 `S3_INTELLIGENT_TIERING` \$1 `S3_STANDARD_IA` \$1 `S3_ONEZONE_IA`   
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 50.  
Required: No

 ** EncryptionType **   <a name="StorageGateway-Type-NFSFileShareInfo-EncryptionType"></a>
A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.  
We recommend using `EncryptionType` instead of `KMSEncrypted` to set the file share encryption method. You do not need to provide values for both parameters.  
If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if `EncryptionType` is `SseS3`, then `KMSEncrypted` must be `false`. If `EncryptionType` is `SseKms` or `DsseKms`, then `KMSEncrypted` must be `true`.
Type: String  
Valid Values: `SseS3 | SseKms | DsseKms`   
Required: No

 ** FileShareARN **   <a name="StorageGateway-Type-NFSFileShareInfo-FileShareARN"></a>
The Amazon Resource Name (ARN) of the file share.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: No

 ** FileShareId **   <a name="StorageGateway-Type-NFSFileShareInfo-FileShareId"></a>
The ID of the file share.  
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 30.  
Required: No

 ** FileShareName **   <a name="StorageGateway-Type-NFSFileShareInfo-FileShareName"></a>
The name of the file share. Optional.  
 `FileShareName` must be set if an S3 prefix name is set in `LocationARN`, or if an access point or access point alias is used.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** FileShareStatus **   <a name="StorageGateway-Type-NFSFileShareInfo-FileShareStatus"></a>
The status of the file share.  
Valid Values: `CREATING` \$1 `UPDATING` \$1 `AVAILABLE` \$1 `DELETING`   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 50.  
Required: No

 ** GatewayARN **   <a name="StorageGateway-Type-NFSFileShareInfo-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and Amazon Web Services Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: No

 ** GuessMIMETypeEnabled **   <a name="StorageGateway-Type-NFSFileShareInfo-GuessMIMETypeEnabled"></a>
A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to `true` to enable MIME type guessing, otherwise set to `false`. The default value is `true`.  
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** KMSEncrypted **   <a name="StorageGateway-Type-NFSFileShareInfo-KMSEncrypted"></a>
 *This member has been deprecated.*   
Optional. Set to `true` to use Amazon S3 server-side encryption with your own Amazon KMS key (SSE-KMS), or `false` to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the `EncryptionType` parameter instead.  
We recommend using `EncryptionType` instead of `KMSEncrypted` to set the file share encryption method. You do not need to provide values for both parameters.  
If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if `EncryptionType` is `SseS3`, then `KMSEncrypted` must be `false`. If `EncryptionType` is `SseKms` or `DsseKms`, then `KMSEncrypted` must be `true`.
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** KMSKey **   <a name="StorageGateway-Type-NFSFileShareInfo-KMSKey"></a>
Optional. The Amazon Resource Name (ARN) of a symmetric Amazon KMS key used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric KMS keys. This value must be set if `KMSEncrypted` is `true`, or if `EncryptionType` is `SseKms` or `DsseKms`.  
Type: String  
Length Constraints: Minimum length of 7. Maximum length of 2048.  
Pattern: `(^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)`   
Required: No

 ** LocationARN **   <a name="StorageGateway-Type-NFSFileShareInfo-LocationARN"></a>
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](https://docs.amazonaws.cn/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control) in the *Amazon S3 User Guide*.  
Access point alias:  
 `test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias` 
Type: String  
Length Constraints: Minimum length of 16. Maximum length of 1400.  
Required: No

 ** NFSFileShareDefaults **   <a name="StorageGateway-Type-NFSFileShareInfo-NFSFileShareDefaults"></a>
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.  
Type: [NFSFileShareDefaults](API_NFSFileShareDefaults.md) object  
Required: No

 ** NotificationPolicy **   <a name="StorageGateway-Type-NFSFileShareInfo-NotificationPolicy"></a>
The notification policy of the file share. `SettlingTimeInSeconds` controls the number of seconds to wait after the last point in time a client wrote to a file before generating an `ObjectUploaded` notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.  
 `SettlingTimeInSeconds` has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.  
This setting is not meant to specify an exact time at which the notification will be sent. In some cases, the gateway might require more than the specified delay time to generate and send notifications.
The following example sets `NotificationPolicy` on with `SettlingTimeInSeconds` set to 60.  
 `{\"Upload\": {\"SettlingTimeInSeconds\": 60}}`   
The following example sets `NotificationPolicy` off.  
 `{}`   
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 100.  
Pattern: `^\{[\w\s:\{\}\[\]"]*}$`   
Required: No

 ** ObjectACL **   <a name="StorageGateway-Type-NFSFileShareInfo-ObjectACL"></a>
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: String  
Valid Values: `private | public-read | public-read-write | authenticated-read | bucket-owner-read | bucket-owner-full-control | aws-exec-read`   
Required: No

 ** Path **   <a name="StorageGateway-Type-NFSFileShareInfo-Path"></a>
The file share path used by the NFS client to identify the mount point.  
Type: String  
Required: No

 ** ReadOnly **   <a name="StorageGateway-Type-NFSFileShareInfo-ReadOnly"></a>
A value that sets the write status of a file share. Set this value to `true` to set the write status to read-only, otherwise set to `false`.  
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** RequesterPays **   <a name="StorageGateway-Type-NFSFileShareInfo-RequesterPays"></a>
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to `true`, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.  
 `RequesterPays` is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** Role **   <a name="StorageGateway-Type-NFSFileShareInfo-Role"></a>
The ARN of the IAM role that an S3 File Gateway assumes when it accesses the underlying storage.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):iam::([0-9]+):role/(\S+)$`   
Required: No

 ** Squash **   <a name="StorageGateway-Type-NFSFileShareInfo-Squash"></a>
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.
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 15.  
Required: No

 ** Tags **   <a name="StorageGateway-Type-NFSFileShareInfo-Tags"></a>
A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the `ListTagsForResource` API operation.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** VPCEndpointDNSName **   <a name="StorageGateway-Type-NFSFileShareInfo-VPCEndpointDNSName"></a>
Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.  
This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$`   
Required: No

## See Also
<a name="API_NFSFileShareInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/NFSFileShareInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/NFSFileShareInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/NFSFileShareInfo) 

# PoolInfo
<a name="API_PoolInfo"></a>

Describes a custom tape pool.

## Contents
<a name="API_PoolInfo_Contents"></a>

 ** PoolARN **   <a name="StorageGateway-Type-PoolInfo-PoolARN"></a>
The Amazon Resource Name (ARN) of the custom tape pool. Use the [ListTapePools](API_ListTapePools.md) operation to return a list of custom tape pools for your account and Amazon Web Services Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: No

 ** PoolName **   <a name="StorageGateway-Type-PoolInfo-PoolName"></a>
The name of the custom tape pool. `PoolName` can use all ASCII characters, except '/' and '\$1'.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$`   
Required: No

 ** PoolStatus **   <a name="StorageGateway-Type-PoolInfo-PoolStatus"></a>
Status of the custom tape pool. Pool can be `ACTIVE` or `DELETED`.  
Type: String  
Valid Values: `ACTIVE | DELETED`   
Required: No

 ** RetentionLockTimeInDays **   <a name="StorageGateway-Type-PoolInfo-RetentionLockTimeInDays"></a>
Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days).  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 36500.  
Required: No

 ** RetentionLockType **   <a name="StorageGateway-Type-PoolInfo-RetentionLockType"></a>
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.  
Type: String  
Valid Values: `COMPLIANCE | GOVERNANCE | NONE`   
Required: No

 ** StorageClass **   <a name="StorageGateway-Type-PoolInfo-StorageClass"></a>
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.  
Type: String  
Valid Values: `DEEP_ARCHIVE | GLACIER`   
Required: No

## See Also
<a name="API_PoolInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/PoolInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/PoolInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/PoolInfo) 

# SMBFileShareInfo
<a name="API_SMBFileShareInfo"></a>

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.

## Contents
<a name="API_SMBFileShareInfo_Contents"></a>

 ** AccessBasedEnumeration **   <a name="StorageGateway-Type-SMBFileShareInfo-AccessBasedEnumeration"></a>
Indicates whether `AccessBasedEnumeration` is enabled.  
Type: Boolean  
Required: No

 ** AdminUserList **   <a name="StorageGateway-Type-SMBFileShareInfo-AdminUserList"></a>
A list of users or groups in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. Acceptable formats include: `DOMAIN\User1`, `user1`, `@group1`, and `@DOMAIN\group1`. Can only be set if Authentication is set to `ActiveDirectory`.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

 ** AuditDestinationARN **   <a name="StorageGateway-Type-SMBFileShareInfo-AuditDestinationARN"></a>
The Amazon Resource Name (ARN) of the storage used for audit logs.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** Authentication **   <a name="StorageGateway-Type-SMBFileShareInfo-Authentication"></a>
The authentication method of the file share. The default is `ActiveDirectory`.  
Valid Values: `ActiveDirectory` \$1 `GuestAccess`   
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 15.  
Required: No

 ** BucketRegion **   <a name="StorageGateway-Type-SMBFileShareInfo-BucketRegion"></a>
Specifies the Region of the S3 bucket where the SMB file share stores files.  
This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 25.  
Required: No

 ** CacheAttributes **   <a name="StorageGateway-Type-SMBFileShareInfo-CacheAttributes"></a>
Refresh cache information for the file share.  
Type: [CacheAttributes](API_CacheAttributes.md) object  
Required: No

 ** CaseSensitivity **   <a name="StorageGateway-Type-SMBFileShareInfo-CaseSensitivity"></a>
The case of an object name in an Amazon S3 bucket. For `ClientSpecified`, the client determines the case sensitivity. For `CaseSensitive`, the gateway determines the case sensitivity. The default value is `ClientSpecified`.  
Type: String  
Valid Values: `ClientSpecified | CaseSensitive`   
Required: No

 ** DefaultStorageClass **   <a name="StorageGateway-Type-SMBFileShareInfo-DefaultStorageClass"></a>
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is `S3_STANDARD`. Optional.  
Valid Values: `S3_STANDARD` \$1 `S3_INTELLIGENT_TIERING` \$1 `S3_STANDARD_IA` \$1 `S3_ONEZONE_IA`   
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 50.  
Required: No

 ** EncryptionType **   <a name="StorageGateway-Type-SMBFileShareInfo-EncryptionType"></a>
A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.  
We recommend using `EncryptionType` instead of `KMSEncrypted` to set the file share encryption method. You do not need to provide values for both parameters.  
If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if `EncryptionType` is `SseS3`, then `KMSEncrypted` must be `false`. If `EncryptionType` is `SseKms` or `DsseKms`, then `KMSEncrypted` must be `true`.
Type: String  
Valid Values: `SseS3 | SseKms | DsseKms`   
Required: No

 ** FileShareARN **   <a name="StorageGateway-Type-SMBFileShareInfo-FileShareARN"></a>
The Amazon Resource Name (ARN) of the file share.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: No

 ** FileShareId **   <a name="StorageGateway-Type-SMBFileShareInfo-FileShareId"></a>
The ID of the file share.  
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 30.  
Required: No

 ** FileShareName **   <a name="StorageGateway-Type-SMBFileShareInfo-FileShareName"></a>
The name of the file share. Optional.  
 `FileShareName` must be set if an S3 prefix name is set in `LocationARN`, or if an access point or access point alias is used.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** FileShareStatus **   <a name="StorageGateway-Type-SMBFileShareInfo-FileShareStatus"></a>
The status of the file share.  
Valid Values: `CREATING` \$1 `UPDATING` \$1 `AVAILABLE` \$1 `DELETING`   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 50.  
Required: No

 ** GatewayARN **   <a name="StorageGateway-Type-SMBFileShareInfo-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and Amazon Web Services Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: No

 ** GuessMIMETypeEnabled **   <a name="StorageGateway-Type-SMBFileShareInfo-GuessMIMETypeEnabled"></a>
A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to `true` to enable MIME type guessing, otherwise set to `false`. The default value is `true`.  
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** InvalidUserList **   <a name="StorageGateway-Type-SMBFileShareInfo-InvalidUserList"></a>
A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: `DOMAIN\User1`, `user1`, `@group1`, and `@DOMAIN\group1`. Can only be set if Authentication is set to `ActiveDirectory`.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

 ** KMSEncrypted **   <a name="StorageGateway-Type-SMBFileShareInfo-KMSEncrypted"></a>
 *This member has been deprecated.*   
Optional. Set to `true` to use Amazon S3 server-side encryption with your own Amazon KMS key (SSE-KMS), or `false` to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the `EncryptionType` parameter instead.  
We recommend using `EncryptionType` instead of `KMSEncrypted` to set the file share encryption method. You do not need to provide values for both parameters.  
If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if `EncryptionType` is `SseS3`, then `KMSEncrypted` must be `false`. If `EncryptionType` is `SseKms` or `DsseKms`, then `KMSEncrypted` must be `true`.
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** KMSKey **   <a name="StorageGateway-Type-SMBFileShareInfo-KMSKey"></a>
Optional. The Amazon Resource Name (ARN) of a symmetric Amazon KMS key used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric KMS keys. This value must be set if `KMSEncrypted` is `true`, or if `EncryptionType` is `SseKms` or `DsseKms`.  
Type: String  
Length Constraints: Minimum length of 7. Maximum length of 2048.  
Pattern: `(^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)`   
Required: No

 ** LocationARN **   <a name="StorageGateway-Type-SMBFileShareInfo-LocationARN"></a>
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](https://docs.amazonaws.cn/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control) in the *Amazon S3 User Guide*.  
Access point alias:  
 `test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias` 
Type: String  
Length Constraints: Minimum length of 16. Maximum length of 1400.  
Required: No

 ** NotificationPolicy **   <a name="StorageGateway-Type-SMBFileShareInfo-NotificationPolicy"></a>
The notification policy of the file share. `SettlingTimeInSeconds` controls the number of seconds to wait after the last point in time a client wrote to a file before generating an `ObjectUploaded` notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.  
 `SettlingTimeInSeconds` has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.  
This setting is not meant to specify an exact time at which the notification will be sent. In some cases, the gateway might require more than the specified delay time to generate and send notifications.
The following example sets `NotificationPolicy` on with `SettlingTimeInSeconds` set to 60.  
 `{\"Upload\": {\"SettlingTimeInSeconds\": 60}}`   
The following example sets `NotificationPolicy` off.  
 `{}`   
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 100.  
Pattern: `^\{[\w\s:\{\}\[\]"]*}$`   
Required: No

 ** ObjectACL **   <a name="StorageGateway-Type-SMBFileShareInfo-ObjectACL"></a>
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: String  
Valid Values: `private | public-read | public-read-write | authenticated-read | bucket-owner-read | bucket-owner-full-control | aws-exec-read`   
Required: No

 ** OplocksEnabled **   <a name="StorageGateway-Type-SMBFileShareInfo-OplocksEnabled"></a>
Specifies whether opportunistic locking is enabled for the SMB file share.  
Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** Path **   <a name="StorageGateway-Type-SMBFileShareInfo-Path"></a>
The file share path used by the SMB client to identify the mount point.  
Type: String  
Required: No

 ** ReadOnly **   <a name="StorageGateway-Type-SMBFileShareInfo-ReadOnly"></a>
A value that sets the write status of a file share. Set this value to `true` to set the write status to read-only, otherwise set to `false`.  
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** RequesterPays **   <a name="StorageGateway-Type-SMBFileShareInfo-RequesterPays"></a>
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to `true`, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.  
 `RequesterPays` is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** Role **   <a name="StorageGateway-Type-SMBFileShareInfo-Role"></a>
The ARN of the IAM role that an S3 File Gateway assumes when it accesses the underlying storage.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):iam::([0-9]+):role/(\S+)$`   
Required: No

 ** SMBACLEnabled **   <a name="StorageGateway-Type-SMBFileShareInfo-SMBACLEnabled"></a>
If this value is set to `true`, it indicates that access control list (ACL) is enabled on the SMB file share. If it is set to `false`, it indicates that file and directory permissions are mapped to the POSIX permission.  
For more information, see [Using Windows ACLs to limit SMB file share access](https://docs.amazonaws.cn/filegateway/latest/files3/smb-acl.html) in the *Amazon S3 File Gateway User Guide*.  
Type: Boolean  
Required: No

 ** Tags **   <a name="StorageGateway-Type-SMBFileShareInfo-Tags"></a>
A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the `ListTagsForResource` API operation.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** ValidUserList **   <a name="StorageGateway-Type-SMBFileShareInfo-ValidUserList"></a>
A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: `DOMAIN\User1`, `user1`, `@group1`, and `@DOMAIN\group1`. Can only be set if Authentication is set to `ActiveDirectory`.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

 ** VPCEndpointDNSName **   <a name="StorageGateway-Type-SMBFileShareInfo-VPCEndpointDNSName"></a>
Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.  
This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$`   
Required: No

## See Also
<a name="API_SMBFileShareInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/SMBFileShareInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/SMBFileShareInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/SMBFileShareInfo) 

# SMBLocalGroups
<a name="API_SMBLocalGroups"></a>

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

## Contents
<a name="API_SMBLocalGroups_Contents"></a>

 ** GatewayAdmins **   <a name="StorageGateway-Type-SMBLocalGroups-GatewayAdmins"></a>
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.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

## See Also
<a name="API_SMBLocalGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/SMBLocalGroups) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/SMBLocalGroups) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/SMBLocalGroups) 

# SoftwareUpdatePreferences
<a name="API_SoftwareUpdatePreferences"></a>

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

## Contents
<a name="API_SoftwareUpdatePreferences_Contents"></a>

 ** AutomaticUpdatePolicy **   <a name="StorageGateway-Type-SoftwareUpdatePreferences-AutomaticUpdatePolicy"></a>
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.  
Type: String  
Valid Values: `ALL_VERSIONS | EMERGENCY_VERSIONS_ONLY`   
Required: No

## See Also
<a name="API_SoftwareUpdatePreferences_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/SoftwareUpdatePreferences) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/SoftwareUpdatePreferences) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/SoftwareUpdatePreferences) 

# StorageGatewayError
<a name="API_StorageGatewayError"></a>

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

## Contents
<a name="API_StorageGatewayError_Contents"></a>

 ** errorCode **   <a name="StorageGateway-Type-StorageGatewayError-errorCode"></a>
Additional information about the error.  
Type: String  
Valid Values: `ActivationKeyExpired | ActivationKeyInvalid | ActivationKeyNotFound | GatewayInternalError | GatewayNotConnected | GatewayNotFound | GatewayProxyNetworkConnectionBusy | AuthenticationFailure | BandwidthThrottleScheduleNotFound | Blocked | CannotExportSnapshot | ChapCredentialNotFound | DiskAlreadyAllocated | DiskDoesNotExist | DiskSizeGreaterThanVolumeMaxSize | DiskSizeLessThanVolumeSize | DiskSizeNotGigAligned | DuplicateCertificateInfo | DuplicateSchedule | EndpointNotFound | IAMNotSupported | InitiatorInvalid | InitiatorNotFound | InternalError | InvalidGateway | InvalidEndpoint | InvalidParameters | InvalidSchedule | LocalStorageLimitExceeded | LunAlreadyAllocated | LunInvalid | JoinDomainInProgress | MaximumContentLengthExceeded | MaximumTapeCartridgeCountExceeded | MaximumVolumeCountExceeded | NetworkConfigurationChanged | NoDisksAvailable | NotImplemented | NotSupported | OperationAborted | OutdatedGateway | ParametersNotImplemented | RegionInvalid | RequestTimeout | ServiceUnavailable | SnapshotDeleted | SnapshotIdInvalid | SnapshotInProgress | SnapshotNotFound | SnapshotScheduleNotFound | StagingAreaFull | StorageFailure | TapeCartridgeNotFound | TargetAlreadyExists | TargetInvalid | TargetNotFound | UnauthorizedOperation | VolumeAlreadyExists | VolumeIdInvalid | VolumeInUse | VolumeNotFound | VolumeNotReady`   
Required: No

 ** errorDetails **   <a name="StorageGateway-Type-StorageGatewayError-errorDetails"></a>
Human-readable text that provides detail about the error that occurred.  
Type: String to string map  
Required: No

## See Also
<a name="API_StorageGatewayError_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/StorageGatewayError) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/StorageGatewayError) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/StorageGatewayError) 

# StorediSCSIVolume
<a name="API_StorediSCSIVolume"></a>

Describes an iSCSI stored volume.

## Contents
<a name="API_StorediSCSIVolume_Contents"></a>

 ** CreatedDate **   <a name="StorageGateway-Type-StorediSCSIVolume-CreatedDate"></a>
The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.  
Type: Timestamp  
Required: No

 ** KMSKey **   <a name="StorageGateway-Type-StorediSCSIVolume-KMSKey"></a>
Optional. The Amazon Resource Name (ARN) of a symmetric Amazon KMS key used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric KMS keys. This value must be set if `KMSEncrypted` is `true`, or if `EncryptionType` is `SseKms` or `DsseKms`.  
Type: String  
Length Constraints: Minimum length of 7. Maximum length of 2048.  
Pattern: `(^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)`   
Required: No

 ** PreservedExistingData **   <a name="StorageGateway-Type-StorediSCSIVolume-PreservedExistingData"></a>
Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.  
Valid Values: `true` \$1 `false`   
Type: Boolean  
Required: No

 ** SourceSnapshotId **   <a name="StorageGateway-Type-StorediSCSIVolume-SourceSnapshotId"></a>
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.  
Type: String  
Pattern: `\Asnap-([0-9A-Fa-f]{8}|[0-9A-Fa-f]{17})\z`   
Required: No

 ** TargetName **   <a name="StorageGateway-Type-StorediSCSIVolume-TargetName"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[-\.;a-z0-9]+$`   
Required: No

 ** VolumeARN **   <a name="StorageGateway-Type-StorediSCSIVolume-VolumeARN"></a>
The Amazon Resource Name (ARN) of the storage volume.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)`   
Required: No

 ** VolumeAttachmentStatus **   <a name="StorageGateway-Type-StorediSCSIVolume-VolumeAttachmentStatus"></a>
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](https://docs.amazonaws.cn/storagegateway/latest/userguide/managing-volumes.html#attach-detach-volume).  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 50.  
Required: No

 ** VolumeDiskId **   <a name="StorageGateway-Type-StorediSCSIVolume-VolumeDiskId"></a>
The ID of the local disk that was specified in the [CreateStorediSCSIVolume](API_CreateStorediSCSIVolume.md) operation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 300.  
Required: No

 ** VolumeId **   <a name="StorageGateway-Type-StorediSCSIVolume-VolumeId"></a>
The unique identifier of the volume, e.g., vol-AE4B946D.  
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 30.  
Required: No

 ** VolumeiSCSIAttributes **   <a name="StorageGateway-Type-StorediSCSIVolume-VolumeiSCSIAttributes"></a>
An [VolumeiSCSIAttributes](API_VolumeiSCSIAttributes.md) object that represents a collection of iSCSI attributes for one stored volume.  
Type: [VolumeiSCSIAttributes](API_VolumeiSCSIAttributes.md) object  
Required: No

 ** VolumeProgress **   <a name="StorageGateway-Type-StorediSCSIVolume-VolumeProgress"></a>
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.  
Type: Double  
Required: No

 ** VolumeSizeInBytes **   <a name="StorageGateway-Type-StorediSCSIVolume-VolumeSizeInBytes"></a>
The size of the volume in bytes.  
Type: Long  
Required: No

 ** VolumeStatus **   <a name="StorageGateway-Type-StorediSCSIVolume-VolumeStatus"></a>
One of the VolumeStatus values that indicates the state of the storage volume.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 50.  
Required: No

 ** VolumeType **   <a name="StorageGateway-Type-StorediSCSIVolume-VolumeType"></a>
One of the VolumeType enumeration values describing the type of the volume.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 100.  
Required: No

 ** VolumeUsedInBytes **   <a name="StorageGateway-Type-StorediSCSIVolume-VolumeUsedInBytes"></a>
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.
Type: Long  
Required: No

## See Also
<a name="API_StorediSCSIVolume_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/StorediSCSIVolume) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/StorediSCSIVolume) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/StorediSCSIVolume) 

# Tag
<a name="API_Tag"></a>

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: \$1 - = . \$1 : /.

## Contents
<a name="API_Tag_Contents"></a>

 ** Key **   <a name="StorageGateway-Type-Tag-Key"></a>
Tag key. The key can't start with aws:.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

 ** Value **   <a name="StorageGateway-Type-Tag-Value"></a>
Value of the tag key.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: Yes

## See Also
<a name="API_Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/Tag) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/Tag) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/Tag) 

# Tape
<a name="API_Tape"></a>

Describes a virtual tape object.

## Contents
<a name="API_Tape_Contents"></a>

 ** KMSKey **   <a name="StorageGateway-Type-Tape-KMSKey"></a>
Optional. The Amazon Resource Name (ARN) of a symmetric Amazon KMS key used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric KMS keys. This value must be set if `KMSEncrypted` is `true`, or if `EncryptionType` is `SseKms` or `DsseKms`.  
Type: String  
Length Constraints: Minimum length of 7. Maximum length of 2048.  
Pattern: `(^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)`   
Required: No

 ** PoolEntryDate **   <a name="StorageGateway-Type-Tape-PoolEntryDate"></a>
The date that the tape enters a custom tape pool.  
Type: Timestamp  
Required: No

 ** PoolId **   <a name="StorageGateway-Type-Tape-PoolId"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** Progress **   <a name="StorageGateway-Type-Tape-Progress"></a>
For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.  
Range: 0 (not started) to 100 (complete).  
Type: Double  
Required: No

 ** RetentionStartDate **   <a name="StorageGateway-Type-Tape-RetentionStartDate"></a>
The date that the tape is first archived with tape retention lock enabled.  
Type: Timestamp  
Required: No

 ** TapeARN **   <a name="StorageGateway-Type-Tape-TapeARN"></a>
The Amazon Resource Name (ARN) of the virtual tape.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$`   
Required: No

 ** TapeBarcode **   <a name="StorageGateway-Type-Tape-TapeBarcode"></a>
The barcode that identifies a specific virtual tape.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 16.  
Pattern: `^[A-Z0-9]*$`   
Required: No

 ** TapeCreatedDate **   <a name="StorageGateway-Type-Tape-TapeCreatedDate"></a>
The date the virtual tape was created.  
Type: Timestamp  
Required: No

 ** TapeSizeInBytes **   <a name="StorageGateway-Type-Tape-TapeSizeInBytes"></a>
The size, in bytes, of the virtual tape capacity.  
Type: Long  
Required: No

 ** TapeStatus **   <a name="StorageGateway-Type-Tape-TapeStatus"></a>
The current state of the virtual tape.  
Type: String  
Required: No

 ** TapeUsedInBytes **   <a name="StorageGateway-Type-Tape-TapeUsedInBytes"></a>
The size, in bytes, of data stored on the virtual tape.  
This value is not available for tapes created prior to May 13, 2015.
Type: Long  
Required: No

 ** VTLDevice **   <a name="StorageGateway-Type-Tape-VTLDevice"></a>
The virtual tape library (VTL) device that the virtual tape is associated with.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: No

 ** Worm **   <a name="StorageGateway-Type-Tape-Worm"></a>
If the tape is archived as write-once-read-many (WORM), this value is `true`.  
Type: Boolean  
Required: No

## See Also
<a name="API_Tape_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/Tape) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/Tape) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/Tape) 

# TapeArchive
<a name="API_TapeArchive"></a>

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

## Contents
<a name="API_TapeArchive_Contents"></a>

 ** CompletionTime **   <a name="StorageGateway-Type-TapeArchive-CompletionTime"></a>
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.  
Type: Timestamp  
Required: No

 ** KMSKey **   <a name="StorageGateway-Type-TapeArchive-KMSKey"></a>
Optional. The Amazon Resource Name (ARN) of a symmetric Amazon KMS key used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric KMS keys. This value must be set if `KMSEncrypted` is `true`, or if `EncryptionType` is `SseKms` or `DsseKms`.  
Type: String  
Length Constraints: Minimum length of 7. Maximum length of 2048.  
Pattern: `(^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)`   
Required: No

 ** PoolEntryDate **   <a name="StorageGateway-Type-TapeArchive-PoolEntryDate"></a>
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.  
Type: Timestamp  
Required: No

 ** PoolId **   <a name="StorageGateway-Type-TapeArchive-PoolId"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** RetentionStartDate **   <a name="StorageGateway-Type-TapeArchive-RetentionStartDate"></a>
If the archived tape is subject to tape retention lock, the date that the archived tape started being retained.  
Type: Timestamp  
Required: No

 ** RetrievedTo **   <a name="StorageGateway-Type-TapeArchive-RetrievedTo"></a>
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).  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: No

 ** TapeARN **   <a name="StorageGateway-Type-TapeArchive-TapeARN"></a>
The Amazon Resource Name (ARN) of an archived virtual tape.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$`   
Required: No

 ** TapeBarcode **   <a name="StorageGateway-Type-TapeArchive-TapeBarcode"></a>
The barcode that identifies the archived virtual tape.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 16.  
Pattern: `^[A-Z0-9]*$`   
Required: No

 ** TapeCreatedDate **   <a name="StorageGateway-Type-TapeArchive-TapeCreatedDate"></a>
The date the virtual tape was created.  
Type: Timestamp  
Required: No

 ** TapeSizeInBytes **   <a name="StorageGateway-Type-TapeArchive-TapeSizeInBytes"></a>
The size, in bytes, of the archived virtual tape.  
Type: Long  
Required: No

 ** TapeStatus **   <a name="StorageGateway-Type-TapeArchive-TapeStatus"></a>
The current state of the archived virtual tape.  
Type: String  
Required: No

 ** TapeUsedInBytes **   <a name="StorageGateway-Type-TapeArchive-TapeUsedInBytes"></a>
The size, in bytes, of data stored on the virtual tape.  
This value is not available for tapes created prior to May 13, 2015.
Type: Long  
Required: No

 ** Worm **   <a name="StorageGateway-Type-TapeArchive-Worm"></a>
Set to `true` if the archived tape is stored as write-once-read-many (WORM).  
Type: Boolean  
Required: No

## See Also
<a name="API_TapeArchive_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/TapeArchive) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/TapeArchive) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/TapeArchive) 

# TapeInfo
<a name="API_TapeInfo"></a>

Describes a virtual tape.

## Contents
<a name="API_TapeInfo_Contents"></a>

 ** GatewayARN **   <a name="StorageGateway-Type-TapeInfo-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and Amazon Web Services Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: No

 ** PoolEntryDate **   <a name="StorageGateway-Type-TapeInfo-PoolEntryDate"></a>
The date that the tape entered the custom tape pool with tape retention lock enabled.  
Type: Timestamp  
Required: No

 ** PoolId **   <a name="StorageGateway-Type-TapeInfo-PoolId"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** RetentionStartDate **   <a name="StorageGateway-Type-TapeInfo-RetentionStartDate"></a>
The date that the tape became subject to tape retention lock.  
Type: Timestamp  
Required: No

 ** TapeARN **   <a name="StorageGateway-Type-TapeInfo-TapeARN"></a>
The Amazon Resource Name (ARN) of a virtual tape.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$`   
Required: No

 ** TapeBarcode **   <a name="StorageGateway-Type-TapeInfo-TapeBarcode"></a>
The barcode that identifies a specific virtual tape.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 16.  
Pattern: `^[A-Z0-9]*$`   
Required: No

 ** TapeSizeInBytes **   <a name="StorageGateway-Type-TapeInfo-TapeSizeInBytes"></a>
The size, in bytes, of a virtual tape.  
Type: Long  
Required: No

 ** TapeStatus **   <a name="StorageGateway-Type-TapeInfo-TapeStatus"></a>
The status of the tape.  
Type: String  
Required: No

## See Also
<a name="API_TapeInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/TapeInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/TapeInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/TapeInfo) 

# TapeRecoveryPointInfo
<a name="API_TapeRecoveryPointInfo"></a>

Describes a recovery point.

## Contents
<a name="API_TapeRecoveryPointInfo_Contents"></a>

 ** TapeARN **   <a name="StorageGateway-Type-TapeRecoveryPointInfo-TapeARN"></a>
The Amazon Resource Name (ARN) of the virtual tape.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$`   
Required: No

 ** TapeRecoveryPointTime **   <a name="StorageGateway-Type-TapeRecoveryPointInfo-TapeRecoveryPointTime"></a>
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.  
Type: Timestamp  
Required: No

 ** TapeSizeInBytes **   <a name="StorageGateway-Type-TapeRecoveryPointInfo-TapeSizeInBytes"></a>
The size, in bytes, of the virtual tapes to recover.  
Type: Long  
Required: No

 ** TapeStatus **   <a name="StorageGateway-Type-TapeRecoveryPointInfo-TapeStatus"></a>
The status of the virtual tapes.  
Type: String  
Required: No

## See Also
<a name="API_TapeRecoveryPointInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/TapeRecoveryPointInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/TapeRecoveryPointInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/TapeRecoveryPointInfo) 

# VolumeInfo
<a name="API_VolumeInfo"></a>

Describes a storage volume object.

## Contents
<a name="API_VolumeInfo_Contents"></a>

 ** GatewayARN **   <a name="StorageGateway-Type-VolumeInfo-GatewayARN"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways](API_ListGateways.md) operation to return a list of gateways for your account and Amazon Web Services Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: No

 ** GatewayId **   <a name="StorageGateway-Type-VolumeInfo-GatewayId"></a>
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 (-).  
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 30.  
Required: No

 ** VolumeARN **   <a name="StorageGateway-Type-VolumeInfo-VolumeARN"></a>
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 (-).  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)`   
Required: No

 ** VolumeAttachmentStatus **   <a name="StorageGateway-Type-VolumeInfo-VolumeAttachmentStatus"></a>
One of the VolumeStatus values that indicates the state of the storage volume.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 50.  
Required: No

 ** VolumeId **   <a name="StorageGateway-Type-VolumeInfo-VolumeId"></a>
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 (-).  
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 30.  
Required: No

 ** VolumeSizeInBytes **   <a name="StorageGateway-Type-VolumeInfo-VolumeSizeInBytes"></a>
The size of the volume in bytes.  
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).  
Type: Long  
Required: No

 ** VolumeType **   <a name="StorageGateway-Type-VolumeInfo-VolumeType"></a>
One of the VolumeType enumeration values describing the type of the volume.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 100.  
Required: No

## See Also
<a name="API_VolumeInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/VolumeInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/VolumeInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/VolumeInfo) 

# VolumeiSCSIAttributes
<a name="API_VolumeiSCSIAttributes"></a>

Lists iSCSI information about a volume.

## Contents
<a name="API_VolumeiSCSIAttributes_Contents"></a>

 ** ChapEnabled **   <a name="StorageGateway-Type-VolumeiSCSIAttributes-ChapEnabled"></a>
Indicates whether mutual CHAP is enabled for the iSCSI target.  
Type: Boolean  
Required: No

 ** LunNumber **   <a name="StorageGateway-Type-VolumeiSCSIAttributes-LunNumber"></a>
The logical disk number.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** NetworkInterfaceId **   <a name="StorageGateway-Type-VolumeiSCSIAttributes-NetworkInterfaceId"></a>
The network interface identifier.  
Type: String  
Required: No

 ** NetworkInterfacePort **   <a name="StorageGateway-Type-VolumeiSCSIAttributes-NetworkInterfacePort"></a>
The port used to communicate with iSCSI targets.  
Type: Integer  
Required: No

 ** TargetARN **   <a name="StorageGateway-Type-VolumeiSCSIAttributes-TargetARN"></a>
The Amazon Resource Name (ARN) of the volume target.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 800.  
Required: No

## See Also
<a name="API_VolumeiSCSIAttributes_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/VolumeiSCSIAttributes) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/VolumeiSCSIAttributes) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/VolumeiSCSIAttributes) 

# VolumeRecoveryPointInfo
<a name="API_VolumeRecoveryPointInfo"></a>

Describes a storage volume recovery point object.

## Contents
<a name="API_VolumeRecoveryPointInfo_Contents"></a>

 ** VolumeARN **   <a name="StorageGateway-Type-VolumeRecoveryPointInfo-VolumeARN"></a>
The Amazon Resource Name (ARN) of the volume target.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)`   
Required: No

 ** VolumeRecoveryPointTime **   <a name="StorageGateway-Type-VolumeRecoveryPointInfo-VolumeRecoveryPointTime"></a>
The time the recovery point was taken.  
Type: String  
Required: No

 ** VolumeSizeInBytes **   <a name="StorageGateway-Type-VolumeRecoveryPointInfo-VolumeSizeInBytes"></a>
The size of the volume in bytes.  
Type: Long  
Required: No

 ** VolumeUsageInBytes **   <a name="StorageGateway-Type-VolumeRecoveryPointInfo-VolumeUsageInBytes"></a>
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.
Type: Long  
Required: No

## See Also
<a name="API_VolumeRecoveryPointInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/VolumeRecoveryPointInfo) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/VolumeRecoveryPointInfo) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/VolumeRecoveryPointInfo) 

# VTLDevice
<a name="API_VTLDevice"></a>

Represents a device object associated with a tape gateway.

## Contents
<a name="API_VTLDevice_Contents"></a>

 ** DeviceiSCSIAttributes **   <a name="StorageGateway-Type-VTLDevice-DeviceiSCSIAttributes"></a>
A list of iSCSI information about a VTL device.  
Type: [DeviceiSCSIAttributes](API_DeviceiSCSIAttributes.md) object  
Required: No

 ** VTLDeviceARN **   <a name="StorageGateway-Type-VTLDevice-VTLDeviceARN"></a>
Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer).  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Required: No

 ** VTLDeviceProductIdentifier **   <a name="StorageGateway-Type-VTLDevice-VTLDeviceProductIdentifier"></a>
Specifies the model number of device that the VTL device emulates.  
Type: String  
Required: No

 ** VTLDeviceType **   <a name="StorageGateway-Type-VTLDevice-VTLDeviceType"></a>
Specifies the type of device that the VTL device emulates.  
Type: String  
Required: No

 ** VTLDeviceVendor **   <a name="StorageGateway-Type-VTLDevice-VTLDeviceVendor"></a>
Specifies the vendor of the device that the VTL device object emulates.  
Type: String  
Required: No

## See Also
<a name="API_VTLDevice_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/storagegateway-2013-06-30/VTLDevice) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/storagegateway-2013-06-30/VTLDevice) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/storagegateway-2013-06-30/VTLDevice)