UNPKG

212 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class StorageGateway extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: StorageGateway.Types.ClientConfiguration)
13 config: Config & StorageGateway.Types.ClientConfiguration;
14 /**
15 * Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the AWS Region that you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account; for more information, see UpdateGatewayInformation. You must turn on the gateway VM before you can activate your gateway.
16 */
17 activateGateway(params: StorageGateway.Types.ActivateGatewayInput, callback?: (err: AWSError, data: StorageGateway.Types.ActivateGatewayOutput) => void): Request<StorageGateway.Types.ActivateGatewayOutput, AWSError>;
18 /**
19 * Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the AWS Region that you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account; for more information, see UpdateGatewayInformation. You must turn on the gateway VM before you can activate your gateway.
20 */
21 activateGateway(callback?: (err: AWSError, data: StorageGateway.Types.ActivateGatewayOutput) => void): Request<StorageGateway.Types.ActivateGatewayOutput, AWSError>;
22 /**
23 * Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape and file gateway type (see Storage Gateway Concepts). In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.
24 */
25 addCache(params: StorageGateway.Types.AddCacheInput, callback?: (err: AWSError, data: StorageGateway.Types.AddCacheOutput) => void): Request<StorageGateway.Types.AddCacheOutput, AWSError>;
26 /**
27 * Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape and file gateway type (see Storage Gateway Concepts). In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.
28 */
29 addCache(callback?: (err: AWSError, data: StorageGateway.Types.AddCacheOutput) => void): Request<StorageGateway.Types.AddCacheOutput, AWSError>;
30 /**
31 * Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following AWS Storage Gateway resources: Storage gateways of all types Storage volumes Virtual tapes NFS and SMB file shares You can create a maximum of 50 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags.
32 */
33 addTagsToResource(params: StorageGateway.Types.AddTagsToResourceInput, callback?: (err: AWSError, data: StorageGateway.Types.AddTagsToResourceOutput) => void): Request<StorageGateway.Types.AddTagsToResourceOutput, AWSError>;
34 /**
35 * Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following AWS Storage Gateway resources: Storage gateways of all types Storage volumes Virtual tapes NFS and SMB file shares You can create a maximum of 50 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags.
36 */
37 addTagsToResource(callback?: (err: AWSError, data: StorageGateway.Types.AddTagsToResourceOutput) => void): Request<StorageGateway.Types.AddTagsToResourceOutput, AWSError>;
38 /**
39 * Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for the stored volume, cached volume and tape gateway types. In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer.
40 */
41 addUploadBuffer(params: StorageGateway.Types.AddUploadBufferInput, callback?: (err: AWSError, data: StorageGateway.Types.AddUploadBufferOutput) => void): Request<StorageGateway.Types.AddUploadBufferOutput, AWSError>;
42 /**
43 * Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for the stored volume, cached volume and tape gateway types. In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer.
44 */
45 addUploadBuffer(callback?: (err: AWSError, data: StorageGateway.Types.AddUploadBufferOutput) => void): Request<StorageGateway.Types.AddUploadBufferOutput, AWSError>;
46 /**
47 * Configures one or more gateway local disks as working storage for a gateway. This operation is only supported in the stored volume gateway type. This operation is deprecated in cached volume API version 20120630. Use AddUploadBuffer instead. Working storage is also referred to as upload buffer. You can also use the AddUploadBuffer operation to add upload buffer to a stored volume gateway. In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage.
48 */
49 addWorkingStorage(params: StorageGateway.Types.AddWorkingStorageInput, callback?: (err: AWSError, data: StorageGateway.Types.AddWorkingStorageOutput) => void): Request<StorageGateway.Types.AddWorkingStorageOutput, AWSError>;
50 /**
51 * Configures one or more gateway local disks as working storage for a gateway. This operation is only supported in the stored volume gateway type. This operation is deprecated in cached volume API version 20120630. Use AddUploadBuffer instead. Working storage is also referred to as upload buffer. You can also use the AddUploadBuffer operation to add upload buffer to a stored volume gateway. In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage.
52 */
53 addWorkingStorage(callback?: (err: AWSError, data: StorageGateway.Types.AddWorkingStorageOutput) => void): Request<StorageGateway.Types.AddWorkingStorageOutput, AWSError>;
54 /**
55 * Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (Glacier or Deep Archive) that corresponds to the pool. Valid values: "GLACIER", "DEEP_ARCHIVE"
56 */
57 assignTapePool(params: StorageGateway.Types.AssignTapePoolInput, callback?: (err: AWSError, data: StorageGateway.Types.AssignTapePoolOutput) => void): Request<StorageGateway.Types.AssignTapePoolOutput, AWSError>;
58 /**
59 * Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (Glacier or Deep Archive) that corresponds to the pool. Valid values: "GLACIER", "DEEP_ARCHIVE"
60 */
61 assignTapePool(callback?: (err: AWSError, data: StorageGateway.Types.AssignTapePoolOutput) => void): Request<StorageGateway.Types.AssignTapePoolOutput, AWSError>;
62 /**
63 * Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance.
64 */
65 attachVolume(params: StorageGateway.Types.AttachVolumeInput, callback?: (err: AWSError, data: StorageGateway.Types.AttachVolumeOutput) => void): Request<StorageGateway.Types.AttachVolumeOutput, AWSError>;
66 /**
67 * Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance.
68 */
69 attachVolume(callback?: (err: AWSError, data: StorageGateway.Types.AttachVolumeOutput) => void): Request<StorageGateway.Types.AttachVolumeOutput, AWSError>;
70 /**
71 * Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. This operation is only supported in the tape gateway type.
72 */
73 cancelArchival(params: StorageGateway.Types.CancelArchivalInput, callback?: (err: AWSError, data: StorageGateway.Types.CancelArchivalOutput) => void): Request<StorageGateway.Types.CancelArchivalOutput, AWSError>;
74 /**
75 * Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. This operation is only supported in the tape gateway type.
76 */
77 cancelArchival(callback?: (err: AWSError, data: StorageGateway.Types.CancelArchivalOutput) => void): Request<StorageGateway.Types.CancelArchivalOutput, AWSError>;
78 /**
79 * Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS. This operation is only supported in the tape gateway type.
80 */
81 cancelRetrieval(params: StorageGateway.Types.CancelRetrievalInput, callback?: (err: AWSError, data: StorageGateway.Types.CancelRetrievalOutput) => void): Request<StorageGateway.Types.CancelRetrievalOutput, AWSError>;
82 /**
83 * Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS. This operation is only supported in the tape gateway type.
84 */
85 cancelRetrieval(callback?: (err: AWSError, data: StorageGateway.Types.CancelRetrievalOutput) => void): Request<StorageGateway.Types.CancelRetrievalOutput, AWSError>;
86 /**
87 * Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type. Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway. In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes.
88 */
89 createCachediSCSIVolume(params: StorageGateway.Types.CreateCachediSCSIVolumeInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateCachediSCSIVolumeOutput) => void): Request<StorageGateway.Types.CreateCachediSCSIVolumeOutput, AWSError>;
90 /**
91 * Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type. Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway. In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes.
92 */
93 createCachediSCSIVolume(callback?: (err: AWSError, data: StorageGateway.Types.CreateCachediSCSIVolumeOutput) => void): Request<StorageGateway.Types.CreateCachediSCSIVolumeOutput, AWSError>;
94 /**
95 * Creates a Network File System (NFS) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using a NFS interface. This operation is only supported for file gateways. File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you create a file share. Make sure AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in the AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide. File gateway does not support creating hard or symbolic links on a file share.
96 */
97 createNFSFileShare(params: StorageGateway.Types.CreateNFSFileShareInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateNFSFileShareOutput) => void): Request<StorageGateway.Types.CreateNFSFileShareOutput, AWSError>;
98 /**
99 * Creates a Network File System (NFS) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using a NFS interface. This operation is only supported for file gateways. File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you create a file share. Make sure AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in the AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide. File gateway does not support creating hard or symbolic links on a file share.
100 */
101 createNFSFileShare(callback?: (err: AWSError, data: StorageGateway.Types.CreateNFSFileShareOutput) => void): Request<StorageGateway.Types.CreateNFSFileShareOutput, AWSError>;
102 /**
103 * Creates a Server Message Block (SMB) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway expose file shares using a SMB interface. This operation is only supported for file gateways. File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide. File gateways don't support creating hard or symbolic links on a file share.
104 */
105 createSMBFileShare(params: StorageGateway.Types.CreateSMBFileShareInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateSMBFileShareOutput) => void): Request<StorageGateway.Types.CreateSMBFileShareOutput, AWSError>;
106 /**
107 * Creates a Server Message Block (SMB) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway expose file shares using a SMB interface. This operation is only supported for file gateways. File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide. File gateways don't support creating hard or symbolic links on a file share.
108 */
109 createSMBFileShare(callback?: (err: AWSError, data: StorageGateway.Types.CreateSMBFileShareOutput) => void): Request<StorageGateway.Types.CreateSMBFileShareOutput, AWSError>;
110 /**
111 * Initiates a snapshot of a volume. AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis. This API enables you to take ad-hoc snapshot. For more information, see Editing a Snapshot Schedule. In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. This operation is only supported in stored and cached volume gateway type. To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the EC2 API reference. Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page.
112 */
113 createSnapshot(params: StorageGateway.Types.CreateSnapshotInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateSnapshotOutput) => void): Request<StorageGateway.Types.CreateSnapshotOutput, AWSError>;
114 /**
115 * Initiates a snapshot of a volume. AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis. This API enables you to take ad-hoc snapshot. For more information, see Editing a Snapshot Schedule. In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. This operation is only supported in stored and cached volume gateway type. To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the EC2 API reference. Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page.
116 */
117 createSnapshot(callback?: (err: AWSError, data: StorageGateway.Types.CreateSnapshotOutput) => void): Request<StorageGateway.Types.CreateSnapshotOutput, AWSError>;
118 /**
119 * Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for cached volume gateway, use ListVolumeRecoveryPoints. In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference.
120 */
121 createSnapshotFromVolumeRecoveryPoint(params: StorageGateway.Types.CreateSnapshotFromVolumeRecoveryPointInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateSnapshotFromVolumeRecoveryPointOutput) => void): Request<StorageGateway.Types.CreateSnapshotFromVolumeRecoveryPointOutput, AWSError>;
122 /**
123 * Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for cached volume gateway, use ListVolumeRecoveryPoints. In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference.
124 */
125 createSnapshotFromVolumeRecoveryPoint(callback?: (err: AWSError, data: StorageGateway.Types.CreateSnapshotFromVolumeRecoveryPointOutput) => void): Request<StorageGateway.Types.CreateSnapshotFromVolumeRecoveryPointOutput, AWSError>;
126 /**
127 * Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway type. The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased. In the request you must specify the gateway and the disk information on which you are creating the volume. In response, the gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.
128 */
129 createStorediSCSIVolume(params: StorageGateway.Types.CreateStorediSCSIVolumeInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateStorediSCSIVolumeOutput) => void): Request<StorageGateway.Types.CreateStorediSCSIVolumeOutput, AWSError>;
130 /**
131 * Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway type. The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased. In the request you must specify the gateway and the disk information on which you are creating the volume. In response, the gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.
132 */
133 createStorediSCSIVolume(callback?: (err: AWSError, data: StorageGateway.Types.CreateStorediSCSIVolumeOutput) => void): Request<StorageGateway.Types.CreateStorediSCSIVolumeOutput, AWSError>;
134 /**
135 * Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and can not be reused if it has already been used on a tape . This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type. Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.
136 */
137 createTapeWithBarcode(params: StorageGateway.Types.CreateTapeWithBarcodeInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateTapeWithBarcodeOutput) => void): Request<StorageGateway.Types.CreateTapeWithBarcodeOutput, AWSError>;
138 /**
139 * Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and can not be reused if it has already been used on a tape . This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type. Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.
140 */
141 createTapeWithBarcode(callback?: (err: AWSError, data: StorageGateway.Types.CreateTapeWithBarcodeOutput) => void): Request<StorageGateway.Types.CreateTapeWithBarcodeOutput, AWSError>;
142 /**
143 * Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway type. Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache operation to add cache storage to a gateway.
144 */
145 createTapes(params: StorageGateway.Types.CreateTapesInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateTapesOutput) => void): Request<StorageGateway.Types.CreateTapesOutput, AWSError>;
146 /**
147 * Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway type. Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache operation to add cache storage to a gateway.
148 */
149 createTapes(callback?: (err: AWSError, data: StorageGateway.Types.CreateTapesOutput) => void): Request<StorageGateway.Types.CreateTapesOutput, AWSError>;
150 /**
151 * Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request. This operation is supported for the stored volume, cached volume and tape gateway types.
152 */
153 deleteBandwidthRateLimit(params: StorageGateway.Types.DeleteBandwidthRateLimitInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteBandwidthRateLimitOutput) => void): Request<StorageGateway.Types.DeleteBandwidthRateLimitOutput, AWSError>;
154 /**
155 * Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request. This operation is supported for the stored volume, cached volume and tape gateway types.
156 */
157 deleteBandwidthRateLimit(callback?: (err: AWSError, data: StorageGateway.Types.DeleteBandwidthRateLimitOutput) => void): Request<StorageGateway.Types.DeleteBandwidthRateLimitOutput, AWSError>;
158 /**
159 * Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair. This operation is supported in volume and tape gateway types.
160 */
161 deleteChapCredentials(params: StorageGateway.Types.DeleteChapCredentialsInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteChapCredentialsOutput) => void): Request<StorageGateway.Types.DeleteChapCredentialsOutput, AWSError>;
162 /**
163 * Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair. This operation is supported in volume and tape gateway types.
164 */
165 deleteChapCredentials(callback?: (err: AWSError, data: StorageGateway.Types.DeleteChapCredentialsOutput) => void): Request<StorageGateway.Types.DeleteChapCredentialsOutput, AWSError>;
166 /**
167 * Deletes a file share from a file gateway. This operation is only supported for file gateways.
168 */
169 deleteFileShare(params: StorageGateway.Types.DeleteFileShareInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteFileShareOutput) => void): Request<StorageGateway.Types.DeleteFileShareOutput, AWSError>;
170 /**
171 * Deletes a file share from a file gateway. This operation is only supported for file gateways.
172 */
173 deleteFileShare(callback?: (err: AWSError, data: StorageGateway.Types.DeleteFileShareOutput) => void): Request<StorageGateway.Types.DeleteFileShareOutput, AWSError>;
174 /**
175 * Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer. After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment. You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription.  If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the AWS Storage Gateway Detail Page.
176 */
177 deleteGateway(params: StorageGateway.Types.DeleteGatewayInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteGatewayOutput) => void): Request<StorageGateway.Types.DeleteGatewayOutput, AWSError>;
178 /**
179 * Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer. After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment. You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription.  If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the AWS Storage Gateway Detail Page.
180 */
181 deleteGateway(callback?: (err: AWSError, data: StorageGateway.Types.DeleteGatewayOutput) => void): Request<StorageGateway.Types.DeleteGatewayOutput, AWSError>;
182 /**
183 * Deletes a snapshot of a volume. You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Working with Snapshots. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported in stored and cached volume gateway types. To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference.
184 */
185 deleteSnapshotSchedule(params: StorageGateway.Types.DeleteSnapshotScheduleInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteSnapshotScheduleOutput) => void): Request<StorageGateway.Types.DeleteSnapshotScheduleOutput, AWSError>;
186 /**
187 * Deletes a snapshot of a volume. You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Working with Snapshots. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported in stored and cached volume gateway types. To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference.
188 */
189 deleteSnapshotSchedule(callback?: (err: AWSError, data: StorageGateway.Types.DeleteSnapshotScheduleOutput) => void): Request<StorageGateway.Types.DeleteSnapshotScheduleOutput, AWSError>;
190 /**
191 * Deletes the specified virtual tape. This operation is only supported in the tape gateway type.
192 */
193 deleteTape(params: StorageGateway.Types.DeleteTapeInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteTapeOutput) => void): Request<StorageGateway.Types.DeleteTapeOutput, AWSError>;
194 /**
195 * Deletes the specified virtual tape. This operation is only supported in the tape gateway type.
196 */
197 deleteTape(callback?: (err: AWSError, data: StorageGateway.Types.DeleteTapeOutput) => void): Request<StorageGateway.Types.DeleteTapeOutput, AWSError>;
198 /**
199 * Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.
200 */
201 deleteTapeArchive(params: StorageGateway.Types.DeleteTapeArchiveInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteTapeArchiveOutput) => void): Request<StorageGateway.Types.DeleteTapeArchiveOutput, AWSError>;
202 /**
203 * Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.
204 */
205 deleteTapeArchive(callback?: (err: AWSError, data: StorageGateway.Types.DeleteTapeArchiveOutput) => void): Request<StorageGateway.Types.DeleteTapeArchiveOutput, AWSError>;
206 /**
207 * Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This operation is only supported in the cached volume and stored volume types. For stored volume gateways, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume. Before you delete a volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference. In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete.
208 */
209 deleteVolume(params: StorageGateway.Types.DeleteVolumeInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteVolumeOutput) => void): Request<StorageGateway.Types.DeleteVolumeOutput, AWSError>;
210 /**
211 * Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This operation is only supported in the cached volume and stored volume types. For stored volume gateways, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume. Before you delete a volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference. In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete.
212 */
213 deleteVolume(callback?: (err: AWSError, data: StorageGateway.Types.DeleteVolumeOutput) => void): Request<StorageGateway.Types.DeleteVolumeOutput, AWSError>;
214 /**
215 * Returns information about the most recent High Availability monitoring test that was performed on the host in a cluster. If a test isn't performed, the status and start time in the response would be null.
216 */
217 describeAvailabilityMonitorTest(params: StorageGateway.Types.DescribeAvailabilityMonitorTestInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeAvailabilityMonitorTestOutput) => void): Request<StorageGateway.Types.DescribeAvailabilityMonitorTestOutput, AWSError>;
218 /**
219 * Returns information about the most recent High Availability monitoring test that was performed on the host in a cluster. If a test isn't performed, the status and start time in the response would be null.
220 */
221 describeAvailabilityMonitorTest(callback?: (err: AWSError, data: StorageGateway.Types.DescribeAvailabilityMonitorTestOutput) => void): Request<StorageGateway.Types.DescribeAvailabilityMonitorTestOutput, AWSError>;
222 /**
223 * Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect. This operation is supported for the stored volume, cached volume and tape gateway types.' This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
224 */
225 describeBandwidthRateLimit(params: StorageGateway.Types.DescribeBandwidthRateLimitInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeBandwidthRateLimitOutput) => void): Request<StorageGateway.Types.DescribeBandwidthRateLimitOutput, AWSError>;
226 /**
227 * Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect. This operation is supported for the stored volume, cached volume and tape gateway types.' This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
228 */
229 describeBandwidthRateLimit(callback?: (err: AWSError, data: StorageGateway.Types.DescribeBandwidthRateLimitOutput) => void): Request<StorageGateway.Types.DescribeBandwidthRateLimitOutput, AWSError>;
230 /**
231 * Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape and file gateway types. The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.
232 */
233 describeCache(params: StorageGateway.Types.DescribeCacheInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeCacheOutput) => void): Request<StorageGateway.Types.DescribeCacheOutput, AWSError>;
234 /**
235 * Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape and file gateway types. The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.
236 */
237 describeCache(callback?: (err: AWSError, data: StorageGateway.Types.DescribeCacheOutput) => void): Request<StorageGateway.Types.DescribeCacheOutput, AWSError>;
238 /**
239 * Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).
240 */
241 describeCachediSCSIVolumes(params: StorageGateway.Types.DescribeCachediSCSIVolumesInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeCachediSCSIVolumesOutput) => void): Request<StorageGateway.Types.DescribeCachediSCSIVolumesOutput, AWSError>;
242 /**
243 * Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).
244 */
245 describeCachediSCSIVolumes(callback?: (err: AWSError, data: StorageGateway.Types.DescribeCachediSCSIVolumesOutput) => void): Request<StorageGateway.Types.DescribeCachediSCSIVolumesOutput, AWSError>;
246 /**
247 * Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. This operation is supported in the volume and tape gateway types.
248 */
249 describeChapCredentials(params: StorageGateway.Types.DescribeChapCredentialsInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeChapCredentialsOutput) => void): Request<StorageGateway.Types.DescribeChapCredentialsOutput, AWSError>;
250 /**
251 * Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. This operation is supported in the volume and tape gateway types.
252 */
253 describeChapCredentials(callback?: (err: AWSError, data: StorageGateway.Types.DescribeChapCredentialsOutput) => void): Request<StorageGateway.Types.DescribeChapCredentialsOutput, AWSError>;
254 /**
255 * Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
256 */
257 describeGatewayInformation(params: StorageGateway.Types.DescribeGatewayInformationInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeGatewayInformationOutput) => void): Request<StorageGateway.Types.DescribeGatewayInformationOutput, AWSError>;
258 /**
259 * Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
260 */
261 describeGatewayInformation(callback?: (err: AWSError, data: StorageGateway.Types.DescribeGatewayInformationOutput) => void): Request<StorageGateway.Types.DescribeGatewayInformationOutput, AWSError>;
262 /**
263 * Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone.
264 */
265 describeMaintenanceStartTime(params: StorageGateway.Types.DescribeMaintenanceStartTimeInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeMaintenanceStartTimeOutput) => void): Request<StorageGateway.Types.DescribeMaintenanceStartTimeOutput, AWSError>;
266 /**
267 * Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone.
268 */
269 describeMaintenanceStartTime(callback?: (err: AWSError, data: StorageGateway.Types.DescribeMaintenanceStartTimeOutput) => void): Request<StorageGateway.Types.DescribeMaintenanceStartTimeOutput, AWSError>;
270 /**
271 * Gets a description for one or more Network File System (NFS) file shares from a file gateway. This operation is only supported for file gateways.
272 */
273 describeNFSFileShares(params: StorageGateway.Types.DescribeNFSFileSharesInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeNFSFileSharesOutput) => void): Request<StorageGateway.Types.DescribeNFSFileSharesOutput, AWSError>;
274 /**
275 * Gets a description for one or more Network File System (NFS) file shares from a file gateway. This operation is only supported for file gateways.
276 */
277 describeNFSFileShares(callback?: (err: AWSError, data: StorageGateway.Types.DescribeNFSFileSharesOutput) => void): Request<StorageGateway.Types.DescribeNFSFileSharesOutput, AWSError>;
278 /**
279 * Gets a description for one or more Server Message Block (SMB) file shares from a file gateway. This operation is only supported for file gateways.
280 */
281 describeSMBFileShares(params: StorageGateway.Types.DescribeSMBFileSharesInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeSMBFileSharesOutput) => void): Request<StorageGateway.Types.DescribeSMBFileSharesOutput, AWSError>;
282 /**
283 * Gets a description for one or more Server Message Block (SMB) file shares from a file gateway. This operation is only supported for file gateways.
284 */
285 describeSMBFileShares(callback?: (err: AWSError, data: StorageGateway.Types.DescribeSMBFileSharesOutput) => void): Request<StorageGateway.Types.DescribeSMBFileSharesOutput, AWSError>;
286 /**
287 * Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.
288 */
289 describeSMBSettings(params: StorageGateway.Types.DescribeSMBSettingsInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeSMBSettingsOutput) => void): Request<StorageGateway.Types.DescribeSMBSettingsOutput, AWSError>;
290 /**
291 * Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.
292 */
293 describeSMBSettings(callback?: (err: AWSError, data: StorageGateway.Types.DescribeSMBSettingsOutput) => void): Request<StorageGateway.Types.DescribeSMBSettingsOutput, AWSError>;
294 /**
295 * Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. This operation is only supported in the cached volume and stored volume types.
296 */
297 describeSnapshotSchedule(params: StorageGateway.Types.DescribeSnapshotScheduleInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeSnapshotScheduleOutput) => void): Request<StorageGateway.Types.DescribeSnapshotScheduleOutput, AWSError>;
298 /**
299 * Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. This operation is only supported in the cached volume and stored volume types.
300 */
301 describeSnapshotSchedule(callback?: (err: AWSError, data: StorageGateway.Types.DescribeSnapshotScheduleOutput) => void): Request<StorageGateway.Types.DescribeSnapshotScheduleOutput, AWSError>;
302 /**
303 * Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.
304 */
305 describeStorediSCSIVolumes(params: StorageGateway.Types.DescribeStorediSCSIVolumesInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeStorediSCSIVolumesOutput) => void): Request<StorageGateway.Types.DescribeStorediSCSIVolumesOutput, AWSError>;
306 /**
307 * Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.
308 */
309 describeStorediSCSIVolumes(callback?: (err: AWSError, data: StorageGateway.Types.DescribeStorediSCSIVolumesOutput) => void): Request<StorageGateway.Types.DescribeStorediSCSIVolumesOutput, AWSError>;
310 /**
311 * Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type. If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.
312 */
313 describeTapeArchives(params: StorageGateway.Types.DescribeTapeArchivesInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeTapeArchivesOutput) => void): Request<StorageGateway.Types.DescribeTapeArchivesOutput, AWSError>;
314 /**
315 * Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type. If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.
316 */
317 describeTapeArchives(callback?: (err: AWSError, data: StorageGateway.Types.DescribeTapeArchivesOutput) => void): Request<StorageGateway.Types.DescribeTapeArchivesOutput, AWSError>;
318 /**
319 * Returns a list of virtual tape recovery points that are available for the specified tape gateway. A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. This operation is only supported in the tape gateway type.
320 */
321 describeTapeRecoveryPoints(params: StorageGateway.Types.DescribeTapeRecoveryPointsInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeTapeRecoveryPointsOutput) => void): Request<StorageGateway.Types.DescribeTapeRecoveryPointsOutput, AWSError>;
322 /**
323 * Returns a list of virtual tape recovery points that are available for the specified tape gateway. A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. This operation is only supported in the tape gateway type.
324 */
325 describeTapeRecoveryPoints(callback?: (err: AWSError, data: StorageGateway.Types.DescribeTapeRecoveryPointsOutput) => void): Request<StorageGateway.Types.DescribeTapeRecoveryPointsOutput, AWSError>;
326 /**
327 * Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes associated with the specified gateway. This operation is only supported in the tape gateway type.
328 */
329 describeTapes(params: StorageGateway.Types.DescribeTapesInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeTapesOutput) => void): Request<StorageGateway.Types.DescribeTapesOutput, AWSError>;
330 /**
331 * Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes associated with the specified gateway. This operation is only supported in the tape gateway type.
332 */
333 describeTapes(callback?: (err: AWSError, data: StorageGateway.Types.DescribeTapesOutput) => void): Request<StorageGateway.Types.DescribeTapesOutput, AWSError>;
334 /**
335 * Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume and tape gateway types. The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.
336 */
337 describeUploadBuffer(params: StorageGateway.Types.DescribeUploadBufferInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeUploadBufferOutput) => void): Request<StorageGateway.Types.DescribeUploadBufferOutput, AWSError>;
338 /**
339 * Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume and tape gateway types. The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.
340 */
341 describeUploadBuffer(callback?: (err: AWSError, data: StorageGateway.Types.DescribeUploadBufferOutput) => void): Request<StorageGateway.Types.DescribeUploadBufferOutput, AWSError>;
342 /**
343 * Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, AWS Storage Gateway returns VTL device information. This operation is only supported in the tape gateway type.
344 */
345 describeVTLDevices(params: StorageGateway.Types.DescribeVTLDevicesInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeVTLDevicesOutput) => void): Request<StorageGateway.Types.DescribeVTLDevicesOutput, AWSError>;
346 /**
347 * Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, AWS Storage Gateway returns VTL device information. This operation is only supported in the tape gateway type.
348 */
349 describeVTLDevices(callback?: (err: AWSError, data: StorageGateway.Types.DescribeVTLDevicesOutput) => void): Request<StorageGateway.Types.DescribeVTLDevicesOutput, AWSError>;
350 /**
351 * Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway type. This operation is deprecated in cached volumes API version (20120630). Use DescribeUploadBuffer instead. Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored volume gateway. The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.
352 */
353 describeWorkingStorage(params: StorageGateway.Types.DescribeWorkingStorageInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeWorkingStorageOutput) => void): Request<StorageGateway.Types.DescribeWorkingStorageOutput, AWSError>;
354 /**
355 * Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway type. This operation is deprecated in cached volumes API version (20120630). Use DescribeUploadBuffer instead. Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored volume gateway. The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.
356 */
357 describeWorkingStorage(callback?: (err: AWSError, data: StorageGateway.Types.DescribeWorkingStorageOutput) => void): Request<StorageGateway.Types.DescribeWorkingStorageOutput, AWSError>;
358 /**
359 * Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance. This operation is only supported in the volume gateway type.
360 */
361 detachVolume(params: StorageGateway.Types.DetachVolumeInput, callback?: (err: AWSError, data: StorageGateway.Types.DetachVolumeOutput) => void): Request<StorageGateway.Types.DetachVolumeOutput, AWSError>;
362 /**
363 * Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance. This operation is only supported in the volume gateway type.
364 */
365 detachVolume(callback?: (err: AWSError, data: StorageGateway.Types.DetachVolumeOutput) => void): Request<StorageGateway.Types.DetachVolumeOutput, AWSError>;
366 /**
367 * Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes. Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway type. Once a gateway is disabled it cannot be enabled.
368 */
369 disableGateway(params: StorageGateway.Types.DisableGatewayInput, callback?: (err: AWSError, data: StorageGateway.Types.DisableGatewayOutput) => void): Request<StorageGateway.Types.DisableGatewayOutput, AWSError>;
370 /**
371 * Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes. Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway type. Once a gateway is disabled it cannot be enabled.
372 */
373 disableGateway(callback?: (err: AWSError, data: StorageGateway.Types.DisableGatewayOutput) => void): Request<StorageGateway.Types.DisableGatewayOutput, AWSError>;
374 /**
375 * Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.
376 */
377 joinDomain(params: StorageGateway.Types.JoinDomainInput, callback?: (err: AWSError, data: StorageGateway.Types.JoinDomainOutput) => void): Request<StorageGateway.Types.JoinDomainOutput, AWSError>;
378 /**
379 * Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.
380 */
381 joinDomain(callback?: (err: AWSError, data: StorageGateway.Types.JoinDomainOutput) => void): Request<StorageGateway.Types.JoinDomainOutput, AWSError>;
382 /**
383 * Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling user account. This operation is only supported for file gateways.
384 */
385 listFileShares(params: StorageGateway.Types.ListFileSharesInput, callback?: (err: AWSError, data: StorageGateway.Types.ListFileSharesOutput) => void): Request<StorageGateway.Types.ListFileSharesOutput, AWSError>;
386 /**
387 * Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling user account. This operation is only supported for file gateways.
388 */
389 listFileShares(callback?: (err: AWSError, data: StorageGateway.Types.ListFileSharesOutput) => void): Request<StorageGateway.Types.ListFileSharesOutput, AWSError>;
390 /**
391 * Lists gateways owned by an AWS account in an AWS Region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN). By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response. If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.
392 */
393 listGateways(params: StorageGateway.Types.ListGatewaysInput, callback?: (err: AWSError, data: StorageGateway.Types.ListGatewaysOutput) => void): Request<StorageGateway.Types.ListGatewaysOutput, AWSError>;
394 /**
395 * Lists gateways owned by an AWS account in an AWS Region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN). By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response. If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.
396 */
397 listGateways(callback?: (err: AWSError, data: StorageGateway.Types.ListGatewaysOutput) => void): Request<StorageGateway.Types.ListGatewaysOutput, AWSError>;
398 /**
399 * Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request. The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a DiskStatus field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted).
400 */
401 listLocalDisks(params: StorageGateway.Types.ListLocalDisksInput, callback?: (err: AWSError, data: StorageGateway.Types.ListLocalDisksOutput) => void): Request<StorageGateway.Types.ListLocalDisksOutput, AWSError>;
402 /**
403 * Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request. The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a DiskStatus field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted).
404 */
405 listLocalDisks(callback?: (err: AWSError, data: StorageGateway.Types.ListLocalDisksOutput) => void): Request<StorageGateway.Types.ListLocalDisksOutput, AWSError>;
406 /**
407 * Lists the tags that have been added to the specified resource. This operation is supported in storage gateways of all types.
408 */
409 listTagsForResource(params: StorageGateway.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: StorageGateway.Types.ListTagsForResourceOutput) => void): Request<StorageGateway.Types.ListTagsForResourceOutput, AWSError>;
410 /**
411 * Lists the tags that have been added to the specified resource. This operation is supported in storage gateways of all types.
412 */
413 listTagsForResource(callback?: (err: AWSError, data: StorageGateway.Types.ListTagsForResourceOutput) => void): Request<StorageGateway.Types.ListTagsForResourceOutput, AWSError>;
414 /**
415 * Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS. This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit parameter in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported in the tape gateway type.
416 */
417 listTapes(params: StorageGateway.Types.ListTapesInput, callback?: (err: AWSError, data: StorageGateway.Types.ListTapesOutput) => void): Request<StorageGateway.Types.ListTapesOutput, AWSError>;
418 /**
419 * Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS. This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit parameter in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported in the tape gateway type.
420 */
421 listTapes(callback?: (err: AWSError, data: StorageGateway.Types.ListTapesOutput) => void): Request<StorageGateway.Types.ListTapesOutput, AWSError>;
422 /**
423 * Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. This operation is only supported in the cached volume and stored volume gateway types.
424 */
425 listVolumeInitiators(params: StorageGateway.Types.ListVolumeInitiatorsInput, callback?: (err: AWSError, data: StorageGateway.Types.ListVolumeInitiatorsOutput) => void): Request<StorageGateway.Types.ListVolumeInitiatorsOutput, AWSError>;
426 /**
427 * Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. This operation is only supported in the cached volume and stored volume gateway types.
428 */
429 listVolumeInitiators(callback?: (err: AWSError, data: StorageGateway.Types.ListVolumeInitiatorsOutput) => void): Request<StorageGateway.Types.ListVolumeInitiatorsOutput, AWSError>;
430 /**
431 * Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type. Each cache volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot or clone a new cached volume from a source volume. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.
432 */
433 listVolumeRecoveryPoints(params: StorageGateway.Types.ListVolumeRecoveryPointsInput, callback?: (err: AWSError, data: StorageGateway.Types.ListVolumeRecoveryPointsOutput) => void): Request<StorageGateway.Types.ListVolumeRecoveryPointsOutput, AWSError>;
434 /**
435 * Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type. Each cache volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot or clone a new cached volume from a source volume. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.
436 */
437 listVolumeRecoveryPoints(callback?: (err: AWSError, data: StorageGateway.Types.ListVolumeRecoveryPointsOutput) => void): Request<StorageGateway.Types.ListVolumeRecoveryPointsOutput, AWSError>;
438 /**
439 * Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the DescribeCachediSCSIVolumes API. The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only supported in the cached volume and stored volume gateway types.
440 */
441 listVolumes(params: StorageGateway.Types.ListVolumesInput, callback?: (err: AWSError, data: StorageGateway.Types.ListVolumesOutput) => void): Request<StorageGateway.Types.ListVolumesOutput, AWSError>;
442 /**
443 * Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the DescribeCachediSCSIVolumes API. The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only supported in the cached volume and stored volume gateway types.
444 */
445 listVolumes(callback?: (err: AWSError, data: StorageGateway.Types.ListVolumesOutput) => void): Request<StorageGateway.Types.ListVolumesOutput, AWSError>;
446 /**
447 * Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to Amazon S3. AWS Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or AWS Lambda function. This operation is only supported for file gateways. For more information, see Getting File Upload Notification in the Storage Gateway User Guide (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification).
448 */
449 notifyWhenUploaded(params: StorageGateway.Types.NotifyWhenUploadedInput, callback?: (err: AWSError, data: StorageGateway.Types.NotifyWhenUploadedOutput) => void): Request<StorageGateway.Types.NotifyWhenUploadedOutput, AWSError>;
450 /**
451 * Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to Amazon S3. AWS Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or AWS Lambda function. This operation is only supported for file gateways. For more information, see Getting File Upload Notification in the Storage Gateway User Guide (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification).
452 */
453 notifyWhenUploaded(callback?: (err: AWSError, data: StorageGateway.Types.NotifyWhenUploadedOutput) => void): Request<StorageGateway.Types.NotifyWhenUploadedOutput, AWSError>;
454 /**
455 * Refreshes the cache for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed or replaced since the gateway last listed the bucket's contents and cached the results. This operation is only supported in the file gateway type. You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see Getting Notified About File Operations. When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through an CloudWatch event when your RefreshCache operation completes. Throttle limit: This API is asynchronous so the gateway will accept no more than two refreshes at any time. We recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more information, see Getting Notified About File Operations. If you invoke the RefreshCache API when two requests are already being processed, any new request will cause an InvalidGatewayRequestException error because too many requests were sent to the server. For more information, see "https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification".
456 */
457 refreshCache(params: StorageGateway.Types.RefreshCacheInput, callback?: (err: AWSError, data: StorageGateway.Types.RefreshCacheOutput) => void): Request<StorageGateway.Types.RefreshCacheOutput, AWSError>;
458 /**
459 * Refreshes the cache for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed or replaced since the gateway last listed the bucket's contents and cached the results. This operation is only supported in the file gateway type. You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see Getting Notified About File Operations. When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through an CloudWatch event when your RefreshCache operation completes. Throttle limit: This API is asynchronous so the gateway will accept no more than two refreshes at any time. We recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more information, see Getting Notified About File Operations. If you invoke the RefreshCache API when two requests are already being processed, any new request will cause an InvalidGatewayRequestException error because too many requests were sent to the server. For more information, see "https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification".
460 */
461 refreshCache(callback?: (err: AWSError, data: StorageGateway.Types.RefreshCacheOutput) => void): Request<StorageGateway.Types.RefreshCacheOutput, AWSError>;
462 /**
463 * Removes one or more tags from the specified resource. This operation is supported in storage gateways of all types.
464 */
465 removeTagsFromResource(params: StorageGateway.Types.RemoveTagsFromResourceInput, callback?: (err: AWSError, data: StorageGateway.Types.RemoveTagsFromResourceOutput) => void): Request<StorageGateway.Types.RemoveTagsFromResourceOutput, AWSError>;
466 /**
467 * Removes one or more tags from the specified resource. This operation is supported in storage gateways of all types.
468 */
469 removeTagsFromResource(callback?: (err: AWSError, data: StorageGateway.Types.RemoveTagsFromResourceOutput) => void): Request<StorageGateway.Types.RemoveTagsFromResourceOutput, AWSError>;
470 /**
471 * Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types. If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.
472 */
473 resetCache(params: StorageGateway.Types.ResetCacheInput, callback?: (err: AWSError, data: StorageGateway.Types.ResetCacheOutput) => void): Request<StorageGateway.Types.ResetCacheOutput, AWSError>;
474 /**
475 * Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types. If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.
476 */
477 resetCache(callback?: (err: AWSError, data: StorageGateway.Types.ResetCacheOutput) => void): Request<StorageGateway.Types.ResetCacheOutput, AWSError>;
478 /**
479 * Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS, that is, archive. This operation is only supported in the tape gateway type. Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway. This operation is only supported in the tape gateway type.
480 */
481 retrieveTapeArchive(params: StorageGateway.Types.RetrieveTapeArchiveInput, callback?: (err: AWSError, data: StorageGateway.Types.RetrieveTapeArchiveOutput) => void): Request<StorageGateway.Types.RetrieveTapeArchiveOutput, AWSError>;
482 /**
483 * Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS, that is, archive. This operation is only supported in the tape gateway type. Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway. This operation is only supported in the tape gateway type.
484 */
485 retrieveTapeArchive(callback?: (err: AWSError, data: StorageGateway.Types.RetrieveTapeArchiveOutput) => void): Request<StorageGateway.Types.RetrieveTapeArchiveOutput, AWSError>;
486 /**
487 * Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway type. A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a tape gateway. There is no charge for retrieving recovery points.
488 */
489 retrieveTapeRecoveryPoint(params: StorageGateway.Types.RetrieveTapeRecoveryPointInput, callback?: (err: AWSError, data: StorageGateway.Types.RetrieveTapeRecoveryPointOutput) => void): Request<StorageGateway.Types.RetrieveTapeRecoveryPointOutput, AWSError>;
490 /**
491 * Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway type. A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a tape gateway. There is no charge for retrieving recovery points.
492 */
493 retrieveTapeRecoveryPoint(callback?: (err: AWSError, data: StorageGateway.Types.RetrieveTapeRecoveryPointOutput) => void): Request<StorageGateway.Types.RetrieveTapeRecoveryPointOutput, AWSError>;
494 /**
495 * Sets the password for your VM local console. When you log in to the local console for the first time, you log in to the VM with the default credentials. We recommend that you set a new password. You don't need to know the default password to set a new password.
496 */
497 setLocalConsolePassword(params: StorageGateway.Types.SetLocalConsolePasswordInput, callback?: (err: AWSError, data: StorageGateway.Types.SetLocalConsolePasswordOutput) => void): Request<StorageGateway.Types.SetLocalConsolePasswordOutput, AWSError>;
498 /**
499 * Sets the password for your VM local console. When you log in to the local console for the first time, you log in to the VM with the default credentials. We recommend that you set a new password. You don't need to know the default password to set a new password.
500 */
501 setLocalConsolePassword(callback?: (err: AWSError, data: StorageGateway.Types.SetLocalConsolePasswordOutput) => void): Request<StorageGateway.Types.SetLocalConsolePasswordOutput, AWSError>;
502 /**
503 * Sets the password for the guest user smbguest. The smbguest user is the user when the authentication method for the file share is set to GuestAccess.
504 */
505 setSMBGuestPassword(params: StorageGateway.Types.SetSMBGuestPasswordInput, callback?: (err: AWSError, data: StorageGateway.Types.SetSMBGuestPasswordOutput) => void): Request<StorageGateway.Types.SetSMBGuestPasswordOutput, AWSError>;
506 /**
507 * Sets the password for the guest user smbguest. The smbguest user is the user when the authentication method for the file share is set to GuestAccess.
508 */
509 setSMBGuestPassword(callback?: (err: AWSError, data: StorageGateway.Types.SetSMBGuestPasswordOutput) => void): Request<StorageGateway.Types.SetSMBGuestPasswordOutput, AWSError>;
510 /**
511 * Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request. The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM. If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions. After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken. When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway. If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.
512 */
513 shutdownGateway(params: StorageGateway.Types.ShutdownGatewayInput, callback?: (err: AWSError, data: StorageGateway.Types.ShutdownGatewayOutput) => void): Request<StorageGateway.Types.ShutdownGatewayOutput, AWSError>;
514 /**
515 * Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request. The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM. If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions. After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken. When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway. If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.
516 */
517 shutdownGateway(callback?: (err: AWSError, data: StorageGateway.Types.ShutdownGatewayOutput) => void): Request<StorageGateway.Types.ShutdownGatewayOutput, AWSError>;
518 /**
519 * Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment. This request only initiates the test and that a successful response only indicates that the test was started. It doesn't indicate that the test passed. For the status of the test, invoke the DescribeAvailabilityMonitorTest API. Starting this test will cause your gateway to go offline for a brief period.
520 */
521 startAvailabilityMonitorTest(params: StorageGateway.Types.StartAvailabilityMonitorTestInput, callback?: (err: AWSError, data: StorageGateway.Types.StartAvailabilityMonitorTestOutput) => void): Request<StorageGateway.Types.StartAvailabilityMonitorTestOutput, AWSError>;
522 /**
523 * Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment. This request only initiates the test and that a successful response only indicates that the test was started. It doesn't indicate that the test passed. For the status of the test, invoke the DescribeAvailabilityMonitorTest API. Starting this test will cause your gateway to go offline for a brief period.
524 */
525 startAvailabilityMonitorTest(callback?: (err: AWSError, data: StorageGateway.Types.StartAvailabilityMonitorTestOutput) => void): Request<StorageGateway.Types.StartAvailabilityMonitorTestOutput, AWSError>;
526 /**
527 * Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups. When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any additional API calls. For more information, see ActivateGateway. To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.
528 */
529 startGateway(params: StorageGateway.Types.StartGatewayInput, callback?: (err: AWSError, data: StorageGateway.Types.StartGatewayOutput) => void): Request<StorageGateway.Types.StartGatewayOutput, AWSError>;
530 /**
531 * Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups. When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any additional API calls. For more information, see ActivateGateway. To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.
532 */
533 startGateway(callback?: (err: AWSError, data: StorageGateway.Types.StartGatewayOutput) => void): Request<StorageGateway.Types.StartGatewayOutput, AWSError>;
534 /**
535 * Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains. This operation is supported for the stored volume, cached volume and tape gateway types.' By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
536 */
537 updateBandwidthRateLimit(params: StorageGateway.Types.UpdateBandwidthRateLimitInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateBandwidthRateLimitOutput) => void): Request<StorageGateway.Types.UpdateBandwidthRateLimitOutput, AWSError>;
538 /**
539 * Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains. This operation is supported for the stored volume, cached volume and tape gateway types.' By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
540 */
541 updateBandwidthRateLimit(callback?: (err: AWSError, data: StorageGateway.Types.UpdateBandwidthRateLimitOutput) => void): Request<StorageGateway.Types.UpdateBandwidthRateLimitOutput, AWSError>;
542 /**
543 * Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it. This operation is supported in the volume and tape gateway types. When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.
544 */
545 updateChapCredentials(params: StorageGateway.Types.UpdateChapCredentialsInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateChapCredentialsOutput) => void): Request<StorageGateway.Types.UpdateChapCredentialsOutput, AWSError>;
546 /**
547 * Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it. This operation is supported in the volume and tape gateway types. When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.
548 */
549 updateChapCredentials(callback?: (err: AWSError, data: StorageGateway.Types.UpdateChapCredentialsOutput) => void): Request<StorageGateway.Types.UpdateChapCredentialsOutput, AWSError>;
550 /**
551 * Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request. For Gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN.
552 */
553 updateGatewayInformation(params: StorageGateway.Types.UpdateGatewayInformationInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateGatewayInformationOutput) => void): Request<StorageGateway.Types.UpdateGatewayInformationOutput, AWSError>;
554 /**
555 * Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request. For Gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN.
556 */
557 updateGatewayInformation(callback?: (err: AWSError, data: StorageGateway.Types.UpdateGatewayInformationOutput) => void): Request<StorageGateway.Types.UpdateGatewayInformationOutput, AWSError>;
558 /**
559 * Updates the gateway virtual machine (VM) software. The request immediately triggers the software update. When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete. You can call DescribeGatewayInformation to verify the gateway is in the STATE_RUNNING state. A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see Customizing Your Windows iSCSI Settings and Customizing Your Linux iSCSI Settings, respectively.
560 */
561 updateGatewaySoftwareNow(params: StorageGateway.Types.UpdateGatewaySoftwareNowInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateGatewaySoftwareNowOutput) => void): Request<StorageGateway.Types.UpdateGatewaySoftwareNowOutput, AWSError>;
562 /**
563 * Updates the gateway virtual machine (VM) software. The request immediately triggers the software update. When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete. You can call DescribeGatewayInformation to verify the gateway is in the STATE_RUNNING state. A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see Customizing Your Windows iSCSI Settings and Customizing Your Linux iSCSI Settings, respectively.
564 */
565 updateGatewaySoftwareNow(callback?: (err: AWSError, data: StorageGateway.Types.UpdateGatewaySoftwareNowOutput) => void): Request<StorageGateway.Types.UpdateGatewaySoftwareNowOutput, AWSError>;
566 /**
567 * Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone.
568 */
569 updateMaintenanceStartTime(params: StorageGateway.Types.UpdateMaintenanceStartTimeInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateMaintenanceStartTimeOutput) => void): Request<StorageGateway.Types.UpdateMaintenanceStartTimeOutput, AWSError>;
570 /**
571 * Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone.
572 */
573 updateMaintenanceStartTime(callback?: (err: AWSError, data: StorageGateway.Types.UpdateMaintenanceStartTimeOutput) => void): Request<StorageGateway.Types.UpdateMaintenanceStartTimeOutput, AWSError>;
574 /**
575 * Updates a Network File System (NFS) file share. This operation is only supported in the file gateway type. To leave a file share field unchanged, set the corresponding input field to null. Updates the following file share setting: Default storage class for your S3 bucket Metadata defaults for your S3 bucket Allowed NFS clients for your file share Squash settings Write status of your file share To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported in file gateways.
576 */
577 updateNFSFileShare(params: StorageGateway.Types.UpdateNFSFileShareInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateNFSFileShareOutput) => void): Request<StorageGateway.Types.UpdateNFSFileShareOutput, AWSError>;
578 /**
579 * Updates a Network File System (NFS) file share. This operation is only supported in the file gateway type. To leave a file share field unchanged, set the corresponding input field to null. Updates the following file share setting: Default storage class for your S3 bucket Metadata defaults for your S3 bucket Allowed NFS clients for your file share Squash settings Write status of your file share To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported in file gateways.
580 */
581 updateNFSFileShare(callback?: (err: AWSError, data: StorageGateway.Types.UpdateNFSFileShareOutput) => void): Request<StorageGateway.Types.UpdateNFSFileShareOutput, AWSError>;
582 /**
583 * Updates a Server Message Block (SMB) file share. To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported for file gateways. File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide. File gateways don't support creating hard or symbolic links on a file share.
584 */
585 updateSMBFileShare(params: StorageGateway.Types.UpdateSMBFileShareInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateSMBFileShareOutput) => void): Request<StorageGateway.Types.UpdateSMBFileShareOutput, AWSError>;
586 /**
587 * Updates a Server Message Block (SMB) file share. To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported for file gateways. File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide. File gateways don't support creating hard or symbolic links on a file share.
588 */
589 updateSMBFileShare(callback?: (err: AWSError, data: StorageGateway.Types.UpdateSMBFileShareOutput) => void): Request<StorageGateway.Types.UpdateSMBFileShareOutput, AWSError>;
590 /**
591 * Updates the SMB security strategy on a file gateway. This action is only supported in file gateways. This API is called Security level in the User Guide. A higher security level can affect performance of the gateway.
592 */
593 updateSMBSecurityStrategy(params: StorageGateway.Types.UpdateSMBSecurityStrategyInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateSMBSecurityStrategyOutput) => void): Request<StorageGateway.Types.UpdateSMBSecurityStrategyOutput, AWSError>;
594 /**
595 * Updates the SMB security strategy on a file gateway. This action is only supported in file gateways. This API is called Security level in the User Guide. A higher security level can affect performance of the gateway.
596 */
597 updateSMBSecurityStrategy(callback?: (err: AWSError, data: StorageGateway.Types.UpdateSMBSecurityStrategyOutput) => void): Request<StorageGateway.Types.UpdateSMBSecurityStrategyOutput, AWSError>;
598 /**
599 * Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway types. The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume. In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.
600 */
601 updateSnapshotSchedule(params: StorageGateway.Types.UpdateSnapshotScheduleInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateSnapshotScheduleOutput) => void): Request<StorageGateway.Types.UpdateSnapshotScheduleOutput, AWSError>;
602 /**
603 * Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway types. The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume. In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.
604 */
605 updateSnapshotSchedule(callback?: (err: AWSError, data: StorageGateway.Types.UpdateSnapshotScheduleOutput) => void): Request<StorageGateway.Types.UpdateSnapshotScheduleOutput, AWSError>;
606 /**
607 * Updates the type of medium changer in a tape gateway. When you activate a tape gateway, you select a medium changer type for the tape gateway. This operation enables you to select a different type of medium changer after a tape gateway is activated. This operation is only supported in the tape gateway type.
608 */
609 updateVTLDeviceType(params: StorageGateway.Types.UpdateVTLDeviceTypeInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateVTLDeviceTypeOutput) => void): Request<StorageGateway.Types.UpdateVTLDeviceTypeOutput, AWSError>;
610 /**
611 * Updates the type of medium changer in a tape gateway. When you activate a tape gateway, you select a medium changer type for the tape gateway. This operation enables you to select a different type of medium changer after a tape gateway is activated. This operation is only supported in the tape gateway type.
612 */
613 updateVTLDeviceType(callback?: (err: AWSError, data: StorageGateway.Types.UpdateVTLDeviceTypeOutput) => void): Request<StorageGateway.Types.UpdateVTLDeviceTypeOutput, AWSError>;
614}
615declare namespace StorageGateway {
616 export interface ActivateGatewayInput {
617 /**
618 * Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway. For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html in the Storage Gateway User Guide.
619 */
620 ActivationKey: ActivationKey;
621 /**
622 * The name you configured for your gateway.
623 */
624 GatewayName: GatewayName;
625 /**
626 * A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
627 */
628 GatewayTimezone: GatewayTimezone;
629 /**
630 * A value that indicates the AWS Region where you want to store your data. The gateway AWS Region specified must be the same AWS Region as the AWS Region in your Host header in the request. For more information about available AWS Regions and endpoints for AWS Storage Gateway, see Regions and Endpoints in the Amazon Web Services Glossary. Valid Values: See AWS Storage Gateway Regions and Endpoints in the AWS General Reference.
631 */
632 GatewayRegion: RegionId;
633 /**
634 * A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is CACHED. Valid Values: "STORED", "CACHED", "VTL", "FILE_S3"
635 */
636 GatewayType?: GatewayType;
637 /**
638 * The value that indicates the type of tape drive to use for tape gateway. This field is optional. Valid Values: "IBM-ULT3580-TD5"
639 */
640 TapeDriveType?: TapeDriveType;
641 /**
642 * The value that indicates the type of medium changer to use for tape gateway. This field is optional. Valid Values: "STK-L700", "AWS-Gateway-VTL"
643 */
644 MediumChangerType?: MediumChangerType;
645 /**
646 * A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair. Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.
647 */
648 Tags?: Tags;
649 }
650 export interface ActivateGatewayOutput {
651 GatewayARN?: GatewayARN;
652 }
653 export type ActivationKey = string;
654 export type ActiveDirectoryStatus = "ACCESS_DENIED"|"DETACHED"|"JOINED"|"JOINING"|"NETWORK_ERROR"|"TIMEOUT"|"UNKNOWN_ERROR"|string;
655 export interface AddCacheInput {
656 GatewayARN: GatewayARN;
657 /**
658 * An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
659 */
660 DiskIds: DiskIds;
661 }
662 export interface AddCacheOutput {
663 GatewayARN?: GatewayARN;
664 }
665 export interface AddTagsToResourceInput {
666 /**
667 * The Amazon Resource Name (ARN) of the resource you want to add tags to.
668 */
669 ResourceARN: ResourceARN;
670 /**
671 * The key-value pair that represents the tag you want to add to the resource. The value can be an empty string. Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
672 */
673 Tags: Tags;
674 }
675 export interface AddTagsToResourceOutput {
676 /**
677 * The Amazon Resource Name (ARN) of the resource you want to add tags to.
678 */
679 ResourceARN?: ResourceARN;
680 }
681 export interface AddUploadBufferInput {
682 GatewayARN: GatewayARN;
683 /**
684 * An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
685 */
686 DiskIds: DiskIds;
687 }
688 export interface AddUploadBufferOutput {
689 GatewayARN?: GatewayARN;
690 }
691 export interface AddWorkingStorageInput {
692 GatewayARN: GatewayARN;
693 /**
694 * An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
695 */
696 DiskIds: DiskIds;
697 }
698 export interface AddWorkingStorageOutput {
699 GatewayARN?: GatewayARN;
700 }
701 export interface AssignTapePoolInput {
702 /**
703 * The unique Amazon Resource Name (ARN) of the virtual tape that you want to add to the tape pool.
704 */
705 TapeARN: TapeARN;
706 /**
707 * 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 (Glacier or Deep Archive) that corresponds to the pool. Valid values: "GLACIER", "DEEP_ARCHIVE"
708 */
709 PoolId: PoolId;
710 }
711 export interface AssignTapePoolOutput {
712 /**
713 * The unique Amazon Resource Names (ARN) of the virtual tape that was added to the tape pool.
714 */
715 TapeARN?: TapeARN;
716 }
717 export interface AttachVolumeInput {
718 /**
719 * The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to.
720 */
721 GatewayARN: GatewayARN;
722 /**
723 * 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.
724 */
725 TargetName?: TargetName;
726 /**
727 * The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.
728 */
729 VolumeARN: VolumeARN;
730 /**
731 * The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway. Valid Values: A valid IP address.
732 */
733 NetworkInterfaceId: NetworkInterfaceId;
734 /**
735 * The unique device ID or other distinguishing data that identifies the local disk used to create the volume. This value is only required when you are attaching a stored volume.
736 */
737 DiskId?: DiskId;
738 }
739 export interface AttachVolumeOutput {
740 /**
741 * The Amazon Resource Name (ARN) of the volume that was attached to the gateway.
742 */
743 VolumeARN?: VolumeARN;
744 /**
745 * The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name for the initiator that was used to connect to the target.
746 */
747 TargetARN?: TargetARN;
748 }
749 export type AuditDestinationARN = string;
750 export type Authentication = string;
751 export type AvailabilityMonitorTestStatus = "COMPLETE"|"FAILED"|"PENDING"|string;
752 export type BandwidthDownloadRateLimit = number;
753 export type BandwidthType = string;
754 export type BandwidthUploadRateLimit = number;
755 export type Boolean = boolean;
756 export interface CachediSCSIVolume {
757 /**
758 * The Amazon Resource Name (ARN) of the storage volume.
759 */
760 VolumeARN?: VolumeARN;
761 /**
762 * The unique identifier of the volume, e.g. vol-AE4B946D.
763 */
764 VolumeId?: VolumeId;
765 /**
766 * One of the VolumeType enumeration values that describes the type of the volume.
767 */
768 VolumeType?: VolumeType;
769 /**
770 * One of the VolumeStatus values that indicates the state of the storage volume.
771 */
772 VolumeStatus?: VolumeStatus;
773 /**
774 * 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.
775 */
776 VolumeAttachmentStatus?: VolumeAttachmentStatus;
777 /**
778 * The size, in bytes, of the volume capacity.
779 */
780 VolumeSizeInBytes?: long;
781 /**
782 * 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.
783 */
784 VolumeProgress?: DoubleObject;
785 /**
786 * 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.
787 */
788 SourceSnapshotId?: SnapshotId;
789 /**
790 * An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
791 */
792 VolumeiSCSIAttributes?: VolumeiSCSIAttributes;
793 /**
794 * The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp.
795 */
796 CreatedDate?: CreatedDate;
797 /**
798 * 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.
799 */
800 VolumeUsedInBytes?: VolumeUsedInBytes;
801 KMSKey?: KMSKey;
802 /**
803 * 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.
804 */
805 TargetName?: TargetName;
806 }
807 export type CachediSCSIVolumes = CachediSCSIVolume[];
808 export interface CancelArchivalInput {
809 GatewayARN: GatewayARN;
810 /**
811 * The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving for.
812 */
813 TapeARN: TapeARN;
814 }
815 export interface CancelArchivalOutput {
816 /**
817 * The Amazon Resource Name (ARN) of the virtual tape for which archiving was canceled.
818 */
819 TapeARN?: TapeARN;
820 }
821 export interface CancelRetrievalInput {
822 GatewayARN: GatewayARN;
823 /**
824 * The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.
825 */
826 TapeARN: TapeARN;
827 }
828 export interface CancelRetrievalOutput {
829 /**
830 * The Amazon Resource Name (ARN) of the virtual tape for which retrieval was canceled.
831 */
832 TapeARN?: TapeARN;
833 }
834 export type ChapCredentials = ChapInfo[];
835 export interface ChapInfo {
836 /**
837 * The Amazon Resource Name (ARN) of the volume. Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
838 */
839 TargetARN?: TargetARN;
840 /**
841 * The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
842 */
843 SecretToAuthenticateInitiator?: ChapSecret;
844 /**
845 * The iSCSI initiator that connects to the target.
846 */
847 InitiatorName?: IqnName;
848 /**
849 * The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
850 */
851 SecretToAuthenticateTarget?: ChapSecret;
852 }
853 export type ChapSecret = string;
854 export type ClientToken = string;
855 export type CloudWatchLogGroupARN = string;
856 export interface CreateCachediSCSIVolumeInput {
857 GatewayARN: GatewayARN;
858 /**
859 * The size of the volume in bytes.
860 */
861 VolumeSizeInBytes: long;
862 /**
863 * The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new cached volume. Specify this field if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.
864 */
865 SnapshotId?: SnapshotId;
866 /**
867 * 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.
868 */
869 TargetName: TargetName;
870 /**
871 * The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.
872 */
873 SourceVolumeARN?: VolumeARN;
874 /**
875 * The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway. Valid Values: A valid IP address.
876 */
877 NetworkInterfaceId: NetworkInterfaceId;
878 /**
879 * A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.
880 */
881 ClientToken: ClientToken;
882 /**
883 * True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
884 */
885 KMSEncrypted?: Boolean;
886 /**
887 * The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
888 */
889 KMSKey?: KMSKey;
890 /**
891 * A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair. Valid characters for key and value are letters, spaces, and numbers that you can represent in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.
892 */
893 Tags?: Tags;
894 }
895 export interface CreateCachediSCSIVolumeOutput {
896 /**
897 * The Amazon Resource Name (ARN) of the configured volume.
898 */
899 VolumeARN?: VolumeARN;
900 /**
901 * The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target.
902 */
903 TargetARN?: TargetARN;
904 }
905 export interface CreateNFSFileShareInput {
906 /**
907 * A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
908 */
909 ClientToken: ClientToken;
910 /**
911 * File share default values. Optional.
912 */
913 NFSFileShareDefaults?: NFSFileShareDefaults;
914 /**
915 * The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
916 */
917 GatewayARN: GatewayARN;
918 /**
919 * True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
920 */
921 KMSEncrypted?: Boolean;
922 /**
923 * The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
924 */
925 KMSKey?: KMSKey;
926 /**
927 * The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
928 */
929 Role: Role;
930 /**
931 * The ARN of the backed storage used for storing file data.
932 */
933 LocationARN: LocationARN;
934 /**
935 * The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.
936 */
937 DefaultStorageClass?: StorageClass;
938 /**
939 * A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".
940 */
941 ObjectACL?: ObjectACL;
942 /**
943 * The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.
944 */
945 ClientList?: FileShareClientList;
946 /**
947 * A value that maps a user 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.
948 */
949 Squash?: Squash;
950 /**
951 * A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
952 */
953 ReadOnly?: Boolean;
954 /**
955 * 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, and otherwise to false. The default value is true.
956 */
957 GuessMIMETypeEnabled?: Boolean;
958 /**
959 * 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.
960 */
961 RequesterPays?: Boolean;
962 /**
963 * A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair. Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
964 */
965 Tags?: Tags;
966 }
967 export interface CreateNFSFileShareOutput {
968 /**
969 * The Amazon Resource Name (ARN) of the newly created file share.
970 */
971 FileShareARN?: FileShareARN;
972 }
973 export interface CreateSMBFileShareInput {
974 /**
975 * A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
976 */
977 ClientToken: ClientToken;
978 /**
979 * The ARN of the file gateway on which you want to create a file share.
980 */
981 GatewayARN: GatewayARN;
982 /**
983 * True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
984 */
985 KMSEncrypted?: Boolean;
986 /**
987 * The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
988 */
989 KMSKey?: KMSKey;
990 /**
991 * The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
992 */
993 Role: Role;
994 /**
995 * The ARN of the backed storage used for storing file data.
996 */
997 LocationARN: LocationARN;
998 /**
999 * The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.
1000 */
1001 DefaultStorageClass?: StorageClass;
1002 /**
1003 * A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".
1004 */
1005 ObjectACL?: ObjectACL;
1006 /**
1007 * A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
1008 */
1009 ReadOnly?: Boolean;
1010 /**
1011 * 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, and otherwise to false. The default value is true.
1012 */
1013 GuessMIMETypeEnabled?: Boolean;
1014 /**
1015 * 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.
1016 */
1017 RequesterPays?: Boolean;
1018 /**
1019 * Set this value to "true to enable ACL (access control list) on the SMB file share. Set it to "false" to map file and directory permissions to the POSIX permissions. For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.
1020 */
1021 SMBACLEnabled?: Boolean;
1022 /**
1023 * A list of users in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user. Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.
1024 */
1025 AdminUserList?: FileShareUserList;
1026 /**
1027 * 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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
1028 */
1029 ValidUserList?: FileShareUserList;
1030 /**
1031 * 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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
1032 */
1033 InvalidUserList?: FileShareUserList;
1034 /**
1035 * The Amazon Resource Name (ARN) of the storage used for the audit logs.
1036 */
1037 AuditDestinationARN?: AuditDestinationARN;
1038 /**
1039 * The authentication method that users use to access the file share. Valid values are ActiveDirectory or GuestAccess. The default is ActiveDirectory.
1040 */
1041 Authentication?: Authentication;
1042 /**
1043 * A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair. Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
1044 */
1045 Tags?: Tags;
1046 }
1047 export interface CreateSMBFileShareOutput {
1048 /**
1049 * The Amazon Resource Name (ARN) of the newly created file share.
1050 */
1051 FileShareARN?: FileShareARN;
1052 }
1053 export interface CreateSnapshotFromVolumeRecoveryPointInput {
1054 /**
1055 * The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
1056 */
1057 VolumeARN: VolumeARN;
1058 /**
1059 * Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field
1060 */
1061 SnapshotDescription: SnapshotDescription;
1062 /**
1063 * A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair. Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
1064 */
1065 Tags?: Tags;
1066 }
1067 export interface CreateSnapshotFromVolumeRecoveryPointOutput {
1068 /**
1069 * The ID of the snapshot.
1070 */
1071 SnapshotId?: SnapshotId;
1072 /**
1073 * The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
1074 */
1075 VolumeARN?: VolumeARN;
1076 /**
1077 * The time the volume was created from the recovery point.
1078 */
1079 VolumeRecoveryPointTime?: string;
1080 }
1081 export interface CreateSnapshotInput {
1082 /**
1083 * The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
1084 */
1085 VolumeARN: VolumeARN;
1086 /**
1087 * Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field
1088 */
1089 SnapshotDescription: SnapshotDescription;
1090 /**
1091 * A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair. Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
1092 */
1093 Tags?: Tags;
1094 }
1095 export interface CreateSnapshotOutput {
1096 /**
1097 * The Amazon Resource Name (ARN) of the volume of which the snapshot was taken.
1098 */
1099 VolumeARN?: VolumeARN;
1100 /**
1101 * The snapshot ID that is used to refer to the snapshot in future operations such as describing snapshots (Amazon Elastic Compute Cloud API DescribeSnapshots) or creating a volume from a snapshot (CreateStorediSCSIVolume).
1102 */
1103 SnapshotId?: SnapshotId;
1104 }
1105 export interface CreateStorediSCSIVolumeInput {
1106 GatewayARN: GatewayARN;
1107 /**
1108 * The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.
1109 */
1110 DiskId: DiskId;
1111 /**
1112 * The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.
1113 */
1114 SnapshotId?: SnapshotId;
1115 /**
1116 * Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field as false creates an empty volume. Valid Values: true, false
1117 */
1118 PreserveExistingData: boolean;
1119 /**
1120 * 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.
1121 */
1122 TargetName: TargetName;
1123 /**
1124 * The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway. Valid Values: A valid IP address.
1125 */
1126 NetworkInterfaceId: NetworkInterfaceId;
1127 /**
1128 * True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
1129 */
1130 KMSEncrypted?: Boolean;
1131 /**
1132 * The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
1133 */
1134 KMSKey?: KMSKey;
1135 /**
1136 * A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value pair. Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
1137 */
1138 Tags?: Tags;
1139 }
1140 export interface CreateStorediSCSIVolumeOutput {
1141 /**
1142 * The Amazon Resource Name (ARN) of the configured volume.
1143 */
1144 VolumeARN?: VolumeARN;
1145 /**
1146 * The size of the volume in bytes.
1147 */
1148 VolumeSizeInBytes?: long;
1149 /**
1150 * The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target.
1151 */
1152 TargetARN?: TargetARN;
1153 }
1154 export interface CreateTapeWithBarcodeInput {
1155 /**
1156 * The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
1157 */
1158 GatewayARN: GatewayARN;
1159 /**
1160 * The size, in bytes, of the virtual tape that you want to create. The size must be aligned by gigabyte (1024*1024*1024 byte).
1161 */
1162 TapeSizeInBytes: TapeSize;
1163 /**
1164 * The barcode that you want to assign to the tape. Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.
1165 */
1166 TapeBarcode: TapeBarcode;
1167 /**
1168 * True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
1169 */
1170 KMSEncrypted?: Boolean;
1171 /**
1172 * The Amazon Resource Name (ARN) of the AWS KMS Key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
1173 */
1174 KMSKey?: KMSKey;
1175 /**
1176 * 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 (Glacier or Deep Archive) that corresponds to the pool. Valid values: "GLACIER", "DEEP_ARCHIVE"
1177 */
1178 PoolId?: PoolId;
1179 /**
1180 * A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each tag is a key-value pair. Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
1181 */
1182 Tags?: Tags;
1183 }
1184 export interface CreateTapeWithBarcodeOutput {
1185 /**
1186 * A unique Amazon Resource Name (ARN) that represents the virtual tape that was created.
1187 */
1188 TapeARN?: TapeARN;
1189 }
1190 export interface CreateTapesInput {
1191 /**
1192 * The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
1193 */
1194 GatewayARN: GatewayARN;
1195 /**
1196 * The size, in bytes, of the virtual tapes that you want to create. The size must be aligned by gigabyte (1024*1024*1024 byte).
1197 */
1198 TapeSizeInBytes: TapeSize;
1199 /**
1200 * A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request. Using the same ClientToken prevents creating the tape multiple times.
1201 */
1202 ClientToken: ClientToken;
1203 /**
1204 * The number of virtual tapes that you want to create.
1205 */
1206 NumTapesToCreate: NumTapesToCreate;
1207 /**
1208 * A prefix that you append to the barcode of the virtual tape you are creating. This prefix makes the barcode unique. The prefix must be 1 to 4 characters in length and must be one of the uppercase letters from A to Z.
1209 */
1210 TapeBarcodePrefix: TapeBarcodePrefix;
1211 /**
1212 * True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
1213 */
1214 KMSEncrypted?: Boolean;
1215 /**
1216 * The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
1217 */
1218 KMSKey?: KMSKey;
1219 /**
1220 * 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 (Glacier or Deep Archive) that corresponds to the pool. Valid values: "GLACIER", "DEEP_ARCHIVE"
1221 */
1222 PoolId?: PoolId;
1223 /**
1224 * A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value pair. Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
1225 */
1226 Tags?: Tags;
1227 }
1228 export interface CreateTapesOutput {
1229 /**
1230 * A list of unique Amazon Resource Names (ARNs) that represents the virtual tapes that were created.
1231 */
1232 TapeARNs?: TapeARNs;
1233 }
1234 export type CreatedDate = Date;
1235 export type DayOfMonth = number;
1236 export type DayOfWeek = number;
1237 export interface DeleteBandwidthRateLimitInput {
1238 GatewayARN: GatewayARN;
1239 /**
1240 * One of the BandwidthType values that indicates the gateway bandwidth rate limit to delete. Valid Values: Upload, Download, All.
1241 */
1242 BandwidthType: BandwidthType;
1243 }
1244 export interface DeleteBandwidthRateLimitOutput {
1245 GatewayARN?: GatewayARN;
1246 }
1247 export interface DeleteChapCredentialsInput {
1248 /**
1249 * The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
1250 */
1251 TargetARN: TargetARN;
1252 /**
1253 * The iSCSI initiator that connects to the target.
1254 */
1255 InitiatorName: IqnName;
1256 }
1257 export interface DeleteChapCredentialsOutput {
1258 /**
1259 * The Amazon Resource Name (ARN) of the target.
1260 */
1261 TargetARN?: TargetARN;
1262 /**
1263 * The iSCSI initiator that connects to the target.
1264 */
1265 InitiatorName?: IqnName;
1266 }
1267 export interface DeleteFileShareInput {
1268 /**
1269 * The Amazon Resource Name (ARN) of the file share to be deleted.
1270 */
1271 FileShareARN: FileShareARN;
1272 /**
1273 * If this value is set to true, the operation deletes a file share immediately and aborts all data uploads to AWS. Otherwise, the file share is not deleted until all data is uploaded to AWS. This process aborts the data upload process, and the file share enters the FORCE_DELETING status.
1274 */
1275 ForceDelete?: boolean;
1276 }
1277 export interface DeleteFileShareOutput {
1278 /**
1279 * The Amazon Resource Name (ARN) of the deleted file share.
1280 */
1281 FileShareARN?: FileShareARN;
1282 }
1283 export interface DeleteGatewayInput {
1284 GatewayARN: GatewayARN;
1285 }
1286 export interface DeleteGatewayOutput {
1287 GatewayARN?: GatewayARN;
1288 }
1289 export interface DeleteSnapshotScheduleInput {
1290 /**
1291 * The volume which snapshot schedule to delete.
1292 */
1293 VolumeARN: VolumeARN;
1294 }
1295 export interface DeleteSnapshotScheduleOutput {
1296 /**
1297 * The volume which snapshot schedule was deleted.
1298 */
1299 VolumeARN?: VolumeARN;
1300 }
1301 export interface DeleteTapeArchiveInput {
1302 /**
1303 * The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS).
1304 */
1305 TapeARN: TapeARN;
1306 }
1307 export interface DeleteTapeArchiveOutput {
1308 /**
1309 * The Amazon Resource Name (ARN) of the virtual tape that was deleted from the virtual tape shelf (VTS).
1310 */
1311 TapeARN?: TapeARN;
1312 }
1313 export interface DeleteTapeInput {
1314 /**
1315 * The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
1316 */
1317 GatewayARN: GatewayARN;
1318 /**
1319 * The Amazon Resource Name (ARN) of the virtual tape to delete.
1320 */
1321 TapeARN: TapeARN;
1322 }
1323 export interface DeleteTapeOutput {
1324 /**
1325 * The Amazon Resource Name (ARN) of the deleted virtual tape.
1326 */
1327 TapeARN?: TapeARN;
1328 }
1329 export interface DeleteVolumeInput {
1330 /**
1331 * The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
1332 */
1333 VolumeARN: VolumeARN;
1334 }
1335 export interface DeleteVolumeOutput {
1336 /**
1337 * The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the request.
1338 */
1339 VolumeARN?: VolumeARN;
1340 }
1341 export interface DescribeAvailabilityMonitorTestInput {
1342 GatewayARN: GatewayARN;
1343 }
1344 export interface DescribeAvailabilityMonitorTestOutput {
1345 GatewayARN?: GatewayARN;
1346 /**
1347 * The status of the High Availability monitoring test. If a test hasn't been performed, the value of this field is null.
1348 */
1349 Status?: AvailabilityMonitorTestStatus;
1350 /**
1351 * The time the High Availability monitoring test was started. If a test hasn't been performed, the value of this field is null.
1352 */
1353 StartTime?: Time;
1354 }
1355 export interface DescribeBandwidthRateLimitInput {
1356 GatewayARN: GatewayARN;
1357 }
1358 export interface DescribeBandwidthRateLimitOutput {
1359 GatewayARN?: GatewayARN;
1360 /**
1361 * The average upload bandwidth rate limit in bits per second. This field does not appear in the response if the upload rate limit is not set.
1362 */
1363 AverageUploadRateLimitInBitsPerSec?: BandwidthUploadRateLimit;
1364 /**
1365 * The average download bandwidth rate limit in bits per second. This field does not appear in the response if the download rate limit is not set.
1366 */
1367 AverageDownloadRateLimitInBitsPerSec?: BandwidthDownloadRateLimit;
1368 }
1369 export interface DescribeCacheInput {
1370 GatewayARN: GatewayARN;
1371 }
1372 export interface DescribeCacheOutput {
1373 GatewayARN?: GatewayARN;
1374 /**
1375 * An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.
1376 */
1377 DiskIds?: DiskIds;
1378 /**
1379 * The amount of cache in bytes allocated to the a gateway.
1380 */
1381 CacheAllocatedInBytes?: long;
1382 /**
1383 * Percent use of the gateway's cache storage. This metric applies only to the gateway-cached volume setup. The sample is taken at the end of the reporting period.
1384 */
1385 CacheUsedPercentage?: double;
1386 /**
1387 * The file share's contribution to the overall percentage of the gateway's cache that has not been persisted to AWS. The sample is taken at the end of the reporting period.
1388 */
1389 CacheDirtyPercentage?: double;
1390 /**
1391 * Percent of application read operations from the file shares that are served from cache. The sample is taken at the end of the reporting period.
1392 */
1393 CacheHitPercentage?: double;
1394 /**
1395 * Percent of application read operations from the file shares that are not served from cache. The sample is taken at the end of the reporting period.
1396 */
1397 CacheMissPercentage?: double;
1398 }
1399 export interface DescribeCachediSCSIVolumesInput {
1400 /**
1401 * An array of strings where each string represents the Amazon Resource Name (ARN) of a cached volume. All of the specified cached volumes must from the same gateway. Use ListVolumes to get volume ARNs for a gateway.
1402 */
1403 VolumeARNs: VolumeARNs;
1404 }
1405 export interface DescribeCachediSCSIVolumesOutput {
1406 /**
1407 * An array of objects where each object contains metadata about one cached volume.
1408 */
1409 CachediSCSIVolumes?: CachediSCSIVolumes;
1410 }
1411 export interface DescribeChapCredentialsInput {
1412 /**
1413 * The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
1414 */
1415 TargetARN: TargetARN;
1416 }
1417 export interface DescribeChapCredentialsOutput {
1418 /**
1419 * An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields: InitiatorName: The iSCSI initiator that connects to the target. SecretToAuthenticateInitiator: The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target. SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client). TargetARN: The Amazon Resource Name (ARN) of the storage volume.
1420 */
1421 ChapCredentials?: ChapCredentials;
1422 }
1423 export interface DescribeGatewayInformationInput {
1424 GatewayARN: GatewayARN;
1425 }
1426 export interface DescribeGatewayInformationOutput {
1427 GatewayARN?: GatewayARN;
1428 /**
1429 * 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.
1430 */
1431 GatewayId?: GatewayId;
1432 /**
1433 * The name you configured for your gateway.
1434 */
1435 GatewayName?: string;
1436 /**
1437 * A value that indicates the time zone configured for the gateway.
1438 */
1439 GatewayTimezone?: GatewayTimezone;
1440 /**
1441 * A value that indicates the operating state of the gateway.
1442 */
1443 GatewayState?: GatewayState;
1444 /**
1445 * A NetworkInterface array that contains descriptions of the gateway network interfaces.
1446 */
1447 GatewayNetworkInterfaces?: GatewayNetworkInterfaces;
1448 /**
1449 * The type of the gateway.
1450 */
1451 GatewayType?: GatewayType;
1452 /**
1453 * The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.
1454 */
1455 NextUpdateAvailabilityDate?: NextUpdateAvailabilityDate;
1456 /**
1457 * The date on which the last software update was applied to the gateway. If the gateway has never been updated, this field does not return a value in the response.
1458 */
1459 LastSoftwareUpdate?: LastSoftwareUpdate;
1460 /**
1461 * The ID of the Amazon EC2 instance that was used to launch the gateway.
1462 */
1463 Ec2InstanceId?: Ec2InstanceId;
1464 /**
1465 * The AWS Region where the Amazon EC2 instance is located.
1466 */
1467 Ec2InstanceRegion?: Ec2InstanceRegion;
1468 /**
1469 * A list of up to 50 tags assigned to the gateway, 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.
1470 */
1471 Tags?: Tags;
1472 /**
1473 * The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.
1474 */
1475 VPCEndpoint?: string;
1476 /**
1477 * The Amazon Resource Name (ARN) of the Amazon CloudWatch Log Group that is used to monitor events in the gateway.
1478 */
1479 CloudWatchLogGroupARN?: CloudWatchLogGroupARN;
1480 /**
1481 * The type of hypervisor environment used by the host.
1482 */
1483 HostEnvironment?: HostEnvironment;
1484 }
1485 export interface DescribeMaintenanceStartTimeInput {
1486 GatewayARN: GatewayARN;
1487 }
1488 export interface DescribeMaintenanceStartTimeOutput {
1489 GatewayARN?: GatewayARN;
1490 /**
1491 * The hour component of the maintenance start time represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.
1492 */
1493 HourOfDay?: HourOfDay;
1494 /**
1495 * The minute component of the maintenance start time represented as mm, where mm is the minute (0 to 59). The minute of the hour is in the time zone of the gateway.
1496 */
1497 MinuteOfHour?: MinuteOfHour;
1498 /**
1499 * An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday and 6 represents Saturday. The day of week is in the time zone of the gateway.
1500 */
1501 DayOfWeek?: DayOfWeek;
1502 /**
1503 * The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month. This value is only available for tape and volume gateways.
1504 */
1505 DayOfMonth?: DayOfMonth;
1506 /**
1507 * A value that indicates the time zone that is set for the gateway. The start time and day of week specified should be in the time zone of the gateway.
1508 */
1509 Timezone?: GatewayTimezone;
1510 }
1511 export interface DescribeNFSFileSharesInput {
1512 /**
1513 * An array containing the Amazon Resource Name (ARN) of each file share to be described.
1514 */
1515 FileShareARNList: FileShareARNList;
1516 }
1517 export interface DescribeNFSFileSharesOutput {
1518 /**
1519 * An array containing a description for each requested file share.
1520 */
1521 NFSFileShareInfoList?: NFSFileShareInfoList;
1522 }
1523 export interface DescribeSMBFileSharesInput {
1524 /**
1525 * An array containing the Amazon Resource Name (ARN) of each file share to be described.
1526 */
1527 FileShareARNList: FileShareARNList;
1528 }
1529 export interface DescribeSMBFileSharesOutput {
1530 /**
1531 * An array containing a description for each requested file share.
1532 */
1533 SMBFileShareInfoList?: SMBFileShareInfoList;
1534 }
1535 export interface DescribeSMBSettingsInput {
1536 GatewayARN: GatewayARN;
1537 }
1538 export interface DescribeSMBSettingsOutput {
1539 GatewayARN?: GatewayARN;
1540 /**
1541 * The name of the domain that the gateway is joined to.
1542 */
1543 DomainName?: DomainName;
1544 /**
1545 * Indicates the status of a gateway that is a member of the Active Directory domain. ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error. DETACHED: Indicates that gateway is not joined to a domain. JOINED: Indicates that the gateway has successfully joined a domain. JOINING: Indicates that a JoinDomain operation is in progress. NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error. TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time. UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.
1546 */
1547 ActiveDirectoryStatus?: ActiveDirectoryStatus;
1548 /**
1549 * This value is true if a password for the guest user “smbguest” is set, and otherwise false.
1550 */
1551 SMBGuestPasswordSet?: Boolean;
1552 /**
1553 * The type of security strategy that was specified for file gateway. ClientSpecified: if you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. MandatorySigning: if you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer. MandatoryEncryption: if you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.
1554 */
1555 SMBSecurityStrategy?: SMBSecurityStrategy;
1556 }
1557 export interface DescribeSnapshotScheduleInput {
1558 /**
1559 * The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
1560 */
1561 VolumeARN: VolumeARN;
1562 }
1563 export interface DescribeSnapshotScheduleOutput {
1564 /**
1565 * The Amazon Resource Name (ARN) of the volume that was specified in the request.
1566 */
1567 VolumeARN?: VolumeARN;
1568 /**
1569 * The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.
1570 */
1571 StartAt?: HourOfDay;
1572 /**
1573 * The number of hours between snapshots.
1574 */
1575 RecurrenceInHours?: RecurrenceInHours;
1576 /**
1577 * The snapshot description.
1578 */
1579 Description?: Description;
1580 /**
1581 * A value that indicates the time zone of the gateway.
1582 */
1583 Timezone?: GatewayTimezone;
1584 /**
1585 * A list of up to 50 tags assigned to the snapshot schedule, 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.
1586 */
1587 Tags?: Tags;
1588 }
1589 export interface DescribeStorediSCSIVolumesInput {
1590 /**
1591 * An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must from the same gateway. Use ListVolumes to get volume ARNs for a gateway.
1592 */
1593 VolumeARNs: VolumeARNs;
1594 }
1595 export interface DescribeStorediSCSIVolumesOutput {
1596 /**
1597 * Describes a single unit of output from DescribeStorediSCSIVolumes. The following fields are returned: ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target. LunNumber: The logical disk number. NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map the stored volume as an iSCSI target. NetworkInterfacePort: The port used to communicate with iSCSI targets. PreservedExistingData: Indicates if when the stored volume was created, existing data on the underlying local disk was preserved. SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-1122aabb. Otherwise, this field is not included. StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata about one stored volume. TargetARN: The Amazon Resource Name (ARN) of the volume target. VolumeARN: The Amazon Resource Name (ARN) of the stored volume. VolumeDiskId: The disk ID of the local disk that was specified in the CreateStorediSCSIVolume operation. VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB. VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume. VolumeProgress: Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping. VolumeSizeInBytes: The size of the volume in bytes. VolumeStatus: One of the VolumeStatus values that indicates the state of the volume. VolumeType: One of the enumeration values describing the type of the volume. Currently, on STORED volumes are supported.
1598 */
1599 StorediSCSIVolumes?: StorediSCSIVolumes;
1600 }
1601 export interface DescribeTapeArchivesInput {
1602 /**
1603 * Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.
1604 */
1605 TapeARNs?: TapeARNs;
1606 /**
1607 * An opaque string that indicates the position at which to begin describing virtual tapes.
1608 */
1609 Marker?: Marker;
1610 /**
1611 * Specifies that the number of virtual tapes descried be limited to the specified number.
1612 */
1613 Limit?: PositiveIntObject;
1614 }
1615 export interface DescribeTapeArchivesOutput {
1616 /**
1617 * An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name (ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description and tape barcode.
1618 */
1619 TapeArchives?: TapeArchives;
1620 /**
1621 * An opaque string that indicates the position at which the virtual tapes that were fetched for description ended. Use this marker in your next request to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to describe, this field does not appear in the response.
1622 */
1623 Marker?: Marker;
1624 }
1625 export interface DescribeTapeRecoveryPointsInput {
1626 GatewayARN: GatewayARN;
1627 /**
1628 * An opaque string that indicates the position at which to begin describing the virtual tape recovery points.
1629 */
1630 Marker?: Marker;
1631 /**
1632 * Specifies that the number of virtual tape recovery points that are described be limited to the specified number.
1633 */
1634 Limit?: PositiveIntObject;
1635 }
1636 export interface DescribeTapeRecoveryPointsOutput {
1637 GatewayARN?: GatewayARN;
1638 /**
1639 * An array of TapeRecoveryPointInfos that are available for the specified gateway.
1640 */
1641 TapeRecoveryPointInfos?: TapeRecoveryPointInfos;
1642 /**
1643 * An opaque string that indicates the position at which the virtual tape recovery points that were listed for description ended. Use this marker in your next request to list the next set of virtual tape recovery points in the list. If there are no more recovery points to describe, this field does not appear in the response.
1644 */
1645 Marker?: Marker;
1646 }
1647 export interface DescribeTapesInput {
1648 GatewayARN: GatewayARN;
1649 /**
1650 * Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.
1651 */
1652 TapeARNs?: TapeARNs;
1653 /**
1654 * A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve. If not specified, the first page of results is retrieved.
1655 */
1656 Marker?: Marker;
1657 /**
1658 * Specifies that the number of virtual tapes described be limited to the specified number. Amazon Web Services may impose its own limit, if this field is not set.
1659 */
1660 Limit?: PositiveIntObject;
1661 }
1662 export interface DescribeTapesOutput {
1663 /**
1664 * An array of virtual tape descriptions.
1665 */
1666 Tapes?: Tapes;
1667 /**
1668 * An opaque string which can be used as part of a subsequent DescribeTapes call to retrieve the next page of results. If a response does not contain a marker, then there are no more results to be retrieved.
1669 */
1670 Marker?: Marker;
1671 }
1672 export interface DescribeUploadBufferInput {
1673 GatewayARN: GatewayARN;
1674 }
1675 export interface DescribeUploadBufferOutput {
1676 GatewayARN?: GatewayARN;
1677 /**
1678 * An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.
1679 */
1680 DiskIds?: DiskIds;
1681 /**
1682 * The total number of bytes being used in the gateway's upload buffer.
1683 */
1684 UploadBufferUsedInBytes?: long;
1685 /**
1686 * The total number of bytes allocated in the gateway's as upload buffer.
1687 */
1688 UploadBufferAllocatedInBytes?: long;
1689 }
1690 export interface DescribeVTLDevicesInput {
1691 GatewayARN: GatewayARN;
1692 /**
1693 * An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device. All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.
1694 */
1695 VTLDeviceARNs?: VTLDeviceARNs;
1696 /**
1697 * An opaque string that indicates the position at which to begin describing the VTL devices.
1698 */
1699 Marker?: Marker;
1700 /**
1701 * Specifies that the number of VTL devices described be limited to the specified number.
1702 */
1703 Limit?: PositiveIntObject;
1704 }
1705 export interface DescribeVTLDevicesOutput {
1706 GatewayARN?: GatewayARN;
1707 /**
1708 * An array of VTL device objects composed of the Amazon Resource Name(ARN) of the VTL devices.
1709 */
1710 VTLDevices?: VTLDevices;
1711 /**
1712 * An opaque string that indicates the position at which the VTL devices that were fetched for description ended. Use the marker in your next request to fetch the next set of VTL devices in the list. If there are no more VTL devices to describe, this field does not appear in the response.
1713 */
1714 Marker?: Marker;
1715 }
1716 export interface DescribeWorkingStorageInput {
1717 GatewayARN: GatewayARN;
1718 }
1719 export interface DescribeWorkingStorageOutput {
1720 GatewayARN?: GatewayARN;
1721 /**
1722 * An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.
1723 */
1724 DiskIds?: DiskIds;
1725 /**
1726 * The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0.
1727 */
1728 WorkingStorageUsedInBytes?: long;
1729 /**
1730 * The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0.
1731 */
1732 WorkingStorageAllocatedInBytes?: long;
1733 }
1734 export type Description = string;
1735 export interface DetachVolumeInput {
1736 /**
1737 * The Amazon Resource Name (ARN) of the volume to detach from the gateway.
1738 */
1739 VolumeARN: VolumeARN;
1740 /**
1741 * Set to true to forcibly remove the iSCSI connection of the target volume and detach the volume. The default is false. If this value is set to false, you must manually disconnect the iSCSI connection from the target volume.
1742 */
1743 ForceDetach?: Boolean;
1744 }
1745 export interface DetachVolumeOutput {
1746 /**
1747 * The Amazon Resource Name (ARN) of the volume that was detached.
1748 */
1749 VolumeARN?: VolumeARN;
1750 }
1751 export type DeviceType = string;
1752 export interface DeviceiSCSIAttributes {
1753 /**
1754 * Specifies the unique Amazon Resource Name (ARN) that encodes the iSCSI qualified name(iqn) of a tape drive or media changer target.
1755 */
1756 TargetARN?: TargetARN;
1757 /**
1758 * The network interface identifier of the VTL device.
1759 */
1760 NetworkInterfaceId?: NetworkInterfaceId;
1761 /**
1762 * The port used to communicate with iSCSI VTL device targets.
1763 */
1764 NetworkInterfacePort?: integer;
1765 /**
1766 * Indicates whether mutual CHAP is enabled for the iSCSI target.
1767 */
1768 ChapEnabled?: boolean;
1769 }
1770 export interface DisableGatewayInput {
1771 GatewayARN: GatewayARN;
1772 }
1773 export interface DisableGatewayOutput {
1774 /**
1775 * The unique Amazon Resource Name (ARN) of the disabled gateway.
1776 */
1777 GatewayARN?: GatewayARN;
1778 }
1779 export interface Disk {
1780 /**
1781 * The unique device ID or other distinguishing data that identifies a local disk.
1782 */
1783 DiskId?: DiskId;
1784 /**
1785 * The path of a local disk in the gateway virtual machine (VM).
1786 */
1787 DiskPath?: string;
1788 /**
1789 * The device node of a local disk as assigned by the virtualization environment.
1790 */
1791 DiskNode?: string;
1792 /**
1793 * A value that represents the status of a local disk.
1794 */
1795 DiskStatus?: string;
1796 /**
1797 * The local disk size in bytes.
1798 */
1799 DiskSizeInBytes?: long;
1800 DiskAllocationType?: DiskAllocationType;
1801 /**
1802 * 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.
1803 */
1804 DiskAllocationResource?: string;
1805 DiskAttributeList?: DiskAttributeList;
1806 }
1807 export type DiskAllocationType = string;
1808 export type DiskAttribute = string;
1809 export type DiskAttributeList = DiskAttribute[];
1810 export type DiskId = string;
1811 export type DiskIds = DiskId[];
1812 export type Disks = Disk[];
1813 export type DomainName = string;
1814 export type DomainUserName = string;
1815 export type DomainUserPassword = string;
1816 export type DoubleObject = number;
1817 export type Ec2InstanceId = string;
1818 export type Ec2InstanceRegion = string;
1819 export type FileShareARN = string;
1820 export type FileShareARNList = FileShareARN[];
1821 export type FileShareClientList = IPV4AddressCIDR[];
1822 export type FileShareId = string;
1823 export interface FileShareInfo {
1824 FileShareType?: FileShareType;
1825 FileShareARN?: FileShareARN;
1826 FileShareId?: FileShareId;
1827 FileShareStatus?: FileShareStatus;
1828 GatewayARN?: GatewayARN;
1829 }
1830 export type FileShareInfoList = FileShareInfo[];
1831 export type FileShareStatus = string;
1832 export type FileShareType = "NFS"|"SMB"|string;
1833 export type FileShareUser = string;
1834 export type FileShareUserList = FileShareUser[];
1835 export type Folder = string;
1836 export type FolderList = Folder[];
1837 export type GatewayARN = string;
1838 export type GatewayId = string;
1839 export interface GatewayInfo {
1840 /**
1841 * 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.
1842 */
1843 GatewayId?: GatewayId;
1844 /**
1845 * The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
1846 */
1847 GatewayARN?: GatewayARN;
1848 /**
1849 * The type of the gateway.
1850 */
1851 GatewayType?: GatewayType;
1852 /**
1853 * The state of the gateway. Valid Values: DISABLED or ACTIVE
1854 */
1855 GatewayOperationalState?: GatewayOperationalState;
1856 /**
1857 * The name of the gateway.
1858 */
1859 GatewayName?: string;
1860 /**
1861 * The ID of the Amazon EC2 instance that was used to launch the gateway.
1862 */
1863 Ec2InstanceId?: Ec2InstanceId;
1864 /**
1865 * The AWS Region where the Amazon EC2 instance is located.
1866 */
1867 Ec2InstanceRegion?: Ec2InstanceRegion;
1868 }
1869 export type GatewayName = string;
1870 export type GatewayNetworkInterfaces = NetworkInterface[];
1871 export type GatewayOperationalState = string;
1872 export type GatewayState = string;
1873 export type GatewayTimezone = string;
1874 export type GatewayType = string;
1875 export type Gateways = GatewayInfo[];
1876 export type Host = string;
1877 export type HostEnvironment = "VMWARE"|"HYPER-V"|"EC2"|"KVM"|"OTHER"|string;
1878 export type Hosts = Host[];
1879 export type HourOfDay = number;
1880 export type IPV4AddressCIDR = string;
1881 export type Initiator = string;
1882 export type Initiators = Initiator[];
1883 export type IqnName = string;
1884 export interface JoinDomainInput {
1885 /**
1886 * The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
1887 */
1888 GatewayARN: GatewayARN;
1889 /**
1890 * The name of the domain that you want the gateway to join.
1891 */
1892 DomainName: DomainName;
1893 /**
1894 * The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.
1895 */
1896 OrganizationalUnit?: OrganizationalUnit;
1897 /**
1898 * List of IPv4 addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, mydc.mydomain.com:389.
1899 */
1900 DomainControllers?: Hosts;
1901 /**
1902 * Specifies the time in seconds, in which the JoinDomain operation must complete. The default is 20 seconds.
1903 */
1904 TimeoutInSeconds?: TimeoutInSeconds;
1905 /**
1906 * Sets the user name of user who has permission to add the gateway to the Active Directory domain. The domain user account should be enabled to join computers to the domain. For example, you can use the domain administrator account or an account with delegated permissions to join computers to the domain.
1907 */
1908 UserName: DomainUserName;
1909 /**
1910 * Sets the password of the user who has permission to add the gateway to the Active Directory domain.
1911 */
1912 Password: DomainUserPassword;
1913 }
1914 export interface JoinDomainOutput {
1915 /**
1916 * The unique Amazon Resource Name (ARN) of the gateway that joined the domain.
1917 */
1918 GatewayARN?: GatewayARN;
1919 /**
1920 * Indicates the status of the gateway as a member of the Active Directory domain. ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error. DETACHED: Indicates that gateway is not joined to a domain. JOINED: Indicates that the gateway has successfully joined a domain. JOINING: Indicates that a JoinDomain operation is in progress. NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error. TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time. UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.
1921 */
1922 ActiveDirectoryStatus?: ActiveDirectoryStatus;
1923 }
1924 export type KMSKey = string;
1925 export type LastSoftwareUpdate = string;
1926 export interface ListFileSharesInput {
1927 /**
1928 * The Amazon resource Name (ARN) of the gateway whose file shares you want to list. If this field is not present, all file shares under your account are listed.
1929 */
1930 GatewayARN?: GatewayARN;
1931 /**
1932 * The maximum number of file shares to return in the response. The value must be an integer with a value greater than zero. Optional.
1933 */
1934 Limit?: PositiveIntObject;
1935 /**
1936 * Opaque pagination token returned from a previous ListFileShares operation. If present, Marker specifies where to continue the list from after a previous call to ListFileShares. Optional.
1937 */
1938 Marker?: Marker;
1939 }
1940 export interface ListFileSharesOutput {
1941 /**
1942 * If the request includes Marker, the response returns that value in this field.
1943 */
1944 Marker?: Marker;
1945 /**
1946 * If a value is present, there are more file shares to return. In a subsequent request, use NextMarker as the value for Marker to retrieve the next set of file shares.
1947 */
1948 NextMarker?: Marker;
1949 /**
1950 * An array of information about the file gateway's file shares.
1951 */
1952 FileShareInfoList?: FileShareInfoList;
1953 }
1954 export interface ListGatewaysInput {
1955 /**
1956 * An opaque string that indicates the position at which to begin the returned list of gateways.
1957 */
1958 Marker?: Marker;
1959 /**
1960 * Specifies that the list of gateways returned be limited to the specified number of items.
1961 */
1962 Limit?: PositiveIntObject;
1963 }
1964 export interface ListGatewaysOutput {
1965 /**
1966 * An array of GatewayInfo objects.
1967 */
1968 Gateways?: Gateways;
1969 /**
1970 * Use the marker in your next request to fetch the next set of gateways in the list. If there are no more gateways to list, this field does not appear in the response.
1971 */
1972 Marker?: Marker;
1973 }
1974 export interface ListLocalDisksInput {
1975 GatewayARN: GatewayARN;
1976 }
1977 export interface ListLocalDisksOutput {
1978 GatewayARN?: GatewayARN;
1979 /**
1980 * A JSON object containing the following fields: ListLocalDisksOutput$Disks
1981 */
1982 Disks?: Disks;
1983 }
1984 export interface ListTagsForResourceInput {
1985 /**
1986 * The Amazon Resource Name (ARN) of the resource for which you want to list tags.
1987 */
1988 ResourceARN: ResourceARN;
1989 /**
1990 * An opaque string that indicates the position at which to begin returning the list of tags.
1991 */
1992 Marker?: Marker;
1993 /**
1994 * Specifies that the list of tags returned be limited to the specified number of items.
1995 */
1996 Limit?: PositiveIntObject;
1997 }
1998 export interface ListTagsForResourceOutput {
1999 /**
2000 * he Amazon Resource Name (ARN) of the resource for which you want to list tags.
2001 */
2002 ResourceARN?: ResourceARN;
2003 /**
2004 * An opaque string that indicates the position at which to stop returning the list of tags.
2005 */
2006 Marker?: Marker;
2007 /**
2008 * An array that contains the tags for the specified resource.
2009 */
2010 Tags?: Tags;
2011 }
2012 export interface ListTapesInput {
2013 TapeARNs?: TapeARNs;
2014 /**
2015 * A string that indicates the position at which to begin the returned list of tapes.
2016 */
2017 Marker?: Marker;
2018 /**
2019 * An optional number limit for the tapes in the list returned by this call.
2020 */
2021 Limit?: PositiveIntObject;
2022 }
2023 export interface ListTapesOutput {
2024 TapeInfos?: TapeInfos;
2025 /**
2026 * A string that indicates the position at which to begin returning the next list of tapes. Use the marker in your next request to continue pagination of tapes. If there are no more tapes to list, this element does not appear in the response body.
2027 */
2028 Marker?: Marker;
2029 }
2030 export interface ListVolumeInitiatorsInput {
2031 /**
2032 * The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes for the gateway.
2033 */
2034 VolumeARN: VolumeARN;
2035 }
2036 export interface ListVolumeInitiatorsOutput {
2037 /**
2038 * The host names and port numbers of all iSCSI initiators that are connected to the gateway.
2039 */
2040 Initiators?: Initiators;
2041 }
2042 export interface ListVolumeRecoveryPointsInput {
2043 GatewayARN: GatewayARN;
2044 }
2045 export interface ListVolumeRecoveryPointsOutput {
2046 GatewayARN?: GatewayARN;
2047 /**
2048 * An array of VolumeRecoveryPointInfo objects.
2049 */
2050 VolumeRecoveryPointInfos?: VolumeRecoveryPointInfos;
2051 }
2052 export interface ListVolumesInput {
2053 GatewayARN?: GatewayARN;
2054 /**
2055 * A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.
2056 */
2057 Marker?: Marker;
2058 /**
2059 * Specifies that the list of volumes returned be limited to the specified number of items.
2060 */
2061 Limit?: PositiveIntObject;
2062 }
2063 export interface ListVolumesOutput {
2064 GatewayARN?: GatewayARN;
2065 /**
2066 * Use the marker in your next request to continue pagination of iSCSI volumes. If there are no more volumes to list, this field does not appear in the response body.
2067 */
2068 Marker?: Marker;
2069 /**
2070 * An array of VolumeInfo objects, where each object describes an iSCSI volume. If no volumes are defined for the gateway, then VolumeInfos is an empty array "[]".
2071 */
2072 VolumeInfos?: VolumeInfos;
2073 }
2074 export type LocalConsolePassword = string;
2075 export type LocationARN = string;
2076 export type Marker = string;
2077 export type MediumChangerType = string;
2078 export type MinuteOfHour = number;
2079 export interface NFSFileShareDefaults {
2080 /**
2081 * 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.
2082 */
2083 FileMode?: PermissionMode;
2084 /**
2085 * 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.
2086 */
2087 DirectoryMode?: PermissionMode;
2088 /**
2089 * The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody.
2090 */
2091 GroupId?: PermissionId;
2092 /**
2093 * The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody.
2094 */
2095 OwnerId?: PermissionId;
2096 }
2097 export interface NFSFileShareInfo {
2098 NFSFileShareDefaults?: NFSFileShareDefaults;
2099 FileShareARN?: FileShareARN;
2100 FileShareId?: FileShareId;
2101 FileShareStatus?: FileShareStatus;
2102 GatewayARN?: GatewayARN;
2103 /**
2104 * True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
2105 */
2106 KMSEncrypted?: boolean;
2107 KMSKey?: KMSKey;
2108 Path?: Path;
2109 Role?: Role;
2110 LocationARN?: LocationARN;
2111 /**
2112 * The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.
2113 */
2114 DefaultStorageClass?: StorageClass;
2115 ObjectACL?: ObjectACL;
2116 ClientList?: FileShareClientList;
2117 Squash?: Squash;
2118 /**
2119 * A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
2120 */
2121 ReadOnly?: Boolean;
2122 /**
2123 * 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, and otherwise to false. The default value is true.
2124 */
2125 GuessMIMETypeEnabled?: Boolean;
2126 /**
2127 * 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.
2128 */
2129 RequesterPays?: Boolean;
2130 /**
2131 * 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.
2132 */
2133 Tags?: Tags;
2134 }
2135 export type NFSFileShareInfoList = NFSFileShareInfo[];
2136 export interface NetworkInterface {
2137 /**
2138 * The Internet Protocol version 4 (IPv4) address of the interface.
2139 */
2140 Ipv4Address?: string;
2141 /**
2142 * The Media Access Control (MAC) address of the interface. This is currently unsupported and will not be returned in output.
2143 */
2144 MacAddress?: string;
2145 /**
2146 * The Internet Protocol version 6 (IPv6) address of the interface. Currently not supported.
2147 */
2148 Ipv6Address?: string;
2149 }
2150 export type NetworkInterfaceId = string;
2151 export type NextUpdateAvailabilityDate = string;
2152 export type NotificationId = string;
2153 export interface NotifyWhenUploadedInput {
2154 FileShareARN: FileShareARN;
2155 }
2156 export interface NotifyWhenUploadedOutput {
2157 FileShareARN?: FileShareARN;
2158 NotificationId?: NotificationId;
2159 }
2160 export type NumTapesToCreate = number;
2161 export type ObjectACL = "private"|"public-read"|"public-read-write"|"authenticated-read"|"bucket-owner-read"|"bucket-owner-full-control"|"aws-exec-read"|string;
2162 export type OrganizationalUnit = string;
2163 export type Path = string;
2164 export type PermissionId = number;
2165 export type PermissionMode = string;
2166 export type PoolId = string;
2167 export type PositiveIntObject = number;
2168 export type RecurrenceInHours = number;
2169 export interface RefreshCacheInput {
2170 /**
2171 * The Amazon Resource Name (ARN) of the file share you want to refresh.
2172 */
2173 FileShareARN: FileShareARN;
2174 /**
2175 * A comma-separated list of the paths of folders to refresh in the cache. The default is ["/"]. The default refreshes objects and folders at the root of the Amazon S3 bucket. If Recursive is set to "true", the entire S3 bucket that the file share has access to is refreshed.
2176 */
2177 FolderList?: FolderList;
2178 /**
2179 * A value that specifies whether to recursively refresh folders in the cache. The refresh includes folders that were in the cache the last time the gateway listed the folder's contents. If this value set to "true", each folder that is listed in FolderList is recursively updated. Otherwise, subfolders listed in FolderList are not refreshed. Only objects that are in folders listed directly under FolderList are found and used for the update. The default is "true".
2180 */
2181 Recursive?: Boolean;
2182 }
2183 export interface RefreshCacheOutput {
2184 FileShareARN?: FileShareARN;
2185 NotificationId?: NotificationId;
2186 }
2187 export type RegionId = string;
2188 export interface RemoveTagsFromResourceInput {
2189 /**
2190 * The Amazon Resource Name (ARN) of the resource you want to remove the tags from.
2191 */
2192 ResourceARN: ResourceARN;
2193 /**
2194 * The keys of the tags you want to remove from the specified resource. A tag is composed of a key/value pair.
2195 */
2196 TagKeys: TagKeys;
2197 }
2198 export interface RemoveTagsFromResourceOutput {
2199 /**
2200 * The Amazon Resource Name (ARN) of the resource that the tags were removed from.
2201 */
2202 ResourceARN?: ResourceARN;
2203 }
2204 export interface ResetCacheInput {
2205 GatewayARN: GatewayARN;
2206 }
2207 export interface ResetCacheOutput {
2208 GatewayARN?: GatewayARN;
2209 }
2210 export type ResourceARN = string;
2211 export interface RetrieveTapeArchiveInput {
2212 /**
2213 * The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS).
2214 */
2215 TapeARN: TapeARN;
2216 /**
2217 * The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the ListGateways operation to return a list of gateways for your account and AWS Region. You retrieve archived virtual tapes to only one gateway and the gateway must be a tape gateway.
2218 */
2219 GatewayARN: GatewayARN;
2220 }
2221 export interface RetrieveTapeArchiveOutput {
2222 /**
2223 * The Amazon Resource Name (ARN) of the retrieved virtual tape.
2224 */
2225 TapeARN?: TapeARN;
2226 }
2227 export interface RetrieveTapeRecoveryPointInput {
2228 /**
2229 * The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the recovery point.
2230 */
2231 TapeARN: TapeARN;
2232 GatewayARN: GatewayARN;
2233 }
2234 export interface RetrieveTapeRecoveryPointOutput {
2235 /**
2236 * The Amazon Resource Name (ARN) of the virtual tape for which the recovery point was retrieved.
2237 */
2238 TapeARN?: TapeARN;
2239 }
2240 export type Role = string;
2241 export interface SMBFileShareInfo {
2242 FileShareARN?: FileShareARN;
2243 FileShareId?: FileShareId;
2244 FileShareStatus?: FileShareStatus;
2245 GatewayARN?: GatewayARN;
2246 /**
2247 * True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
2248 */
2249 KMSEncrypted?: boolean;
2250 KMSKey?: KMSKey;
2251 /**
2252 * The file share path used by the SMB client to identify the mount point.
2253 */
2254 Path?: Path;
2255 Role?: Role;
2256 LocationARN?: LocationARN;
2257 /**
2258 * The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.
2259 */
2260 DefaultStorageClass?: StorageClass;
2261 ObjectACL?: ObjectACL;
2262 /**
2263 * A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
2264 */
2265 ReadOnly?: Boolean;
2266 /**
2267 * 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, and otherwise to false. The default value is true.
2268 */
2269 GuessMIMETypeEnabled?: Boolean;
2270 /**
2271 * 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.
2272 */
2273 RequesterPays?: Boolean;
2274 /**
2275 * If this value is set to "true", indicates that ACL (access control list) 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 https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.
2276 */
2277 SMBACLEnabled?: Boolean;
2278 /**
2279 * 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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
2280 */
2281 AdminUserList?: FileShareUserList;
2282 /**
2283 * 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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
2284 */
2285 ValidUserList?: FileShareUserList;
2286 /**
2287 * 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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
2288 */
2289 InvalidUserList?: FileShareUserList;
2290 /**
2291 * The Amazon Resource Name (ARN) of the storage used for the audit logs.
2292 */
2293 AuditDestinationARN?: AuditDestinationARN;
2294 Authentication?: Authentication;
2295 /**
2296 * 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.
2297 */
2298 Tags?: Tags;
2299 }
2300 export type SMBFileShareInfoList = SMBFileShareInfo[];
2301 export type SMBGuestPassword = string;
2302 export type SMBSecurityStrategy = "ClientSpecified"|"MandatorySigning"|"MandatoryEncryption"|string;
2303 export interface SetLocalConsolePasswordInput {
2304 GatewayARN: GatewayARN;
2305 /**
2306 * The password you want to set for your VM local console.
2307 */
2308 LocalConsolePassword: LocalConsolePassword;
2309 }
2310 export interface SetLocalConsolePasswordOutput {
2311 GatewayARN?: GatewayARN;
2312 }
2313 export interface SetSMBGuestPasswordInput {
2314 /**
2315 * The Amazon Resource Name (ARN) of the file gateway the SMB file share is associated with.
2316 */
2317 GatewayARN: GatewayARN;
2318 /**
2319 * The password that you want to set for your SMB Server.
2320 */
2321 Password: SMBGuestPassword;
2322 }
2323 export interface SetSMBGuestPasswordOutput {
2324 GatewayARN?: GatewayARN;
2325 }
2326 export interface ShutdownGatewayInput {
2327 GatewayARN: GatewayARN;
2328 }
2329 export interface ShutdownGatewayOutput {
2330 GatewayARN?: GatewayARN;
2331 }
2332 export type SnapshotDescription = string;
2333 export type SnapshotId = string;
2334 export type Squash = string;
2335 export interface StartAvailabilityMonitorTestInput {
2336 GatewayARN: GatewayARN;
2337 }
2338 export interface StartAvailabilityMonitorTestOutput {
2339 GatewayARN?: GatewayARN;
2340 }
2341 export interface StartGatewayInput {
2342 GatewayARN: GatewayARN;
2343 }
2344 export interface StartGatewayOutput {
2345 GatewayARN?: GatewayARN;
2346 }
2347 export type StorageClass = string;
2348 export interface StorediSCSIVolume {
2349 /**
2350 * The Amazon Resource Name (ARN) of the storage volume.
2351 */
2352 VolumeARN?: VolumeARN;
2353 /**
2354 * The unique identifier of the volume, e.g. vol-AE4B946D.
2355 */
2356 VolumeId?: VolumeId;
2357 /**
2358 * One of the VolumeType enumeration values describing the type of the volume.
2359 */
2360 VolumeType?: VolumeType;
2361 /**
2362 * One of the VolumeStatus values that indicates the state of the storage volume.
2363 */
2364 VolumeStatus?: VolumeStatus;
2365 /**
2366 * 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.
2367 */
2368 VolumeAttachmentStatus?: VolumeAttachmentStatus;
2369 /**
2370 * The size of the volume in bytes.
2371 */
2372 VolumeSizeInBytes?: long;
2373 /**
2374 * 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.
2375 */
2376 VolumeProgress?: DoubleObject;
2377 /**
2378 * The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.
2379 */
2380 VolumeDiskId?: DiskId;
2381 /**
2382 * 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.
2383 */
2384 SourceSnapshotId?: SnapshotId;
2385 /**
2386 * Indicates if when the stored volume was created, existing data on the underlying local disk was preserved. Valid Values: true, false
2387 */
2388 PreservedExistingData?: boolean;
2389 /**
2390 * An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
2391 */
2392 VolumeiSCSIAttributes?: VolumeiSCSIAttributes;
2393 /**
2394 * The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp.
2395 */
2396 CreatedDate?: CreatedDate;
2397 /**
2398 * 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.
2399 */
2400 VolumeUsedInBytes?: VolumeUsedInBytes;
2401 KMSKey?: KMSKey;
2402 /**
2403 * 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.
2404 */
2405 TargetName?: TargetName;
2406 }
2407 export type StorediSCSIVolumes = StorediSCSIVolume[];
2408 export interface Tag {
2409 /**
2410 * Tag key (String). The key can't start with aws:.
2411 */
2412 Key: TagKey;
2413 /**
2414 * Value of the tag key.
2415 */
2416 Value: TagValue;
2417 }
2418 export type TagKey = string;
2419 export type TagKeys = TagKey[];
2420 export type TagValue = string;
2421 export type Tags = Tag[];
2422 export interface Tape {
2423 /**
2424 * The Amazon Resource Name (ARN) of the virtual tape.
2425 */
2426 TapeARN?: TapeARN;
2427 /**
2428 * The barcode that identifies a specific virtual tape.
2429 */
2430 TapeBarcode?: TapeBarcode;
2431 /**
2432 * The date the virtual tape was created.
2433 */
2434 TapeCreatedDate?: Time;
2435 /**
2436 * The size, in bytes, of the virtual tape capacity.
2437 */
2438 TapeSizeInBytes?: TapeSize;
2439 /**
2440 * The current state of the virtual tape.
2441 */
2442 TapeStatus?: TapeStatus;
2443 /**
2444 * The virtual tape library (VTL) device that the virtual tape is associated with.
2445 */
2446 VTLDevice?: VTLDeviceARN;
2447 /**
2448 * For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete. Range: 0 (not started) to 100 (complete).
2449 */
2450 Progress?: DoubleObject;
2451 /**
2452 * The size, in bytes, of data stored on the virtual tape. This value is not available for tapes created prior to May 13, 2015.
2453 */
2454 TapeUsedInBytes?: TapeUsage;
2455 KMSKey?: KMSKey;
2456 /**
2457 * 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 (Glacier or Deep Archive) that corresponds to the pool. Valid values: "GLACIER", "DEEP_ARCHIVE"
2458 */
2459 PoolId?: PoolId;
2460 }
2461 export type TapeARN = string;
2462 export type TapeARNs = TapeARN[];
2463 export interface TapeArchive {
2464 /**
2465 * The Amazon Resource Name (ARN) of an archived virtual tape.
2466 */
2467 TapeARN?: TapeARN;
2468 /**
2469 * The barcode that identifies the archived virtual tape.
2470 */
2471 TapeBarcode?: TapeBarcode;
2472 /**
2473 * The date the virtual tape was created.
2474 */
2475 TapeCreatedDate?: Time;
2476 /**
2477 * The size, in bytes, of the archived virtual tape.
2478 */
2479 TapeSizeInBytes?: TapeSize;
2480 /**
2481 * The time that the archiving of the virtual tape was completed. The default time stamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
2482 */
2483 CompletionTime?: Time;
2484 /**
2485 * 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).
2486 */
2487 RetrievedTo?: GatewayARN;
2488 /**
2489 * The current state of the archived virtual tape.
2490 */
2491 TapeStatus?: TapeArchiveStatus;
2492 /**
2493 * The size, in bytes, of data stored on the virtual tape. This value is not available for tapes created prior to May 13, 2015.
2494 */
2495 TapeUsedInBytes?: TapeUsage;
2496 KMSKey?: KMSKey;
2497 /**
2498 * 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. Valid values: "GLACIER", "DEEP_ARCHIVE"
2499 */
2500 PoolId?: PoolId;
2501 }
2502 export type TapeArchiveStatus = string;
2503 export type TapeArchives = TapeArchive[];
2504 export type TapeBarcode = string;
2505 export type TapeBarcodePrefix = string;
2506 export type TapeDriveType = string;
2507 export interface TapeInfo {
2508 /**
2509 * The Amazon Resource Name (ARN) of a virtual tape.
2510 */
2511 TapeARN?: TapeARN;
2512 /**
2513 * The barcode that identifies a specific virtual tape.
2514 */
2515 TapeBarcode?: TapeBarcode;
2516 /**
2517 * The size, in bytes, of a virtual tape.
2518 */
2519 TapeSizeInBytes?: TapeSize;
2520 /**
2521 * The status of the tape.
2522 */
2523 TapeStatus?: TapeStatus;
2524 /**
2525 * The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
2526 */
2527 GatewayARN?: GatewayARN;
2528 /**
2529 * 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 (Glacier or Deep Archive) that corresponds to the pool. Valid values: "GLACIER", "DEEP_ARCHIVE"
2530 */
2531 PoolId?: PoolId;
2532 }
2533 export type TapeInfos = TapeInfo[];
2534 export interface TapeRecoveryPointInfo {
2535 /**
2536 * The Amazon Resource Name (ARN) of the virtual tape.
2537 */
2538 TapeARN?: TapeARN;
2539 /**
2540 * The time when the point-in-time view of the virtual tape was replicated for later recovery. The default time stamp format of the tape recovery point time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
2541 */
2542 TapeRecoveryPointTime?: Time;
2543 /**
2544 * The size, in bytes, of the virtual tapes to recover.
2545 */
2546 TapeSizeInBytes?: TapeSize;
2547 /**
2548 * The status of the virtual tapes.
2549 */
2550 TapeStatus?: TapeRecoveryPointStatus;
2551 }
2552 export type TapeRecoveryPointInfos = TapeRecoveryPointInfo[];
2553 export type TapeRecoveryPointStatus = string;
2554 export type TapeSize = number;
2555 export type TapeStatus = string;
2556 export type TapeUsage = number;
2557 export type Tapes = Tape[];
2558 export type TargetARN = string;
2559 export type TargetName = string;
2560 export type Time = Date;
2561 export type TimeoutInSeconds = number;
2562 export interface UpdateBandwidthRateLimitInput {
2563 GatewayARN: GatewayARN;
2564 /**
2565 * The average upload bandwidth rate limit in bits per second.
2566 */
2567 AverageUploadRateLimitInBitsPerSec?: BandwidthUploadRateLimit;
2568 /**
2569 * The average download bandwidth rate limit in bits per second.
2570 */
2571 AverageDownloadRateLimitInBitsPerSec?: BandwidthDownloadRateLimit;
2572 }
2573 export interface UpdateBandwidthRateLimitOutput {
2574 GatewayARN?: GatewayARN;
2575 }
2576 export interface UpdateChapCredentialsInput {
2577 /**
2578 * The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified VolumeARN.
2579 */
2580 TargetARN: TargetARN;
2581 /**
2582 * The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target. The secret key must be between 12 and 16 bytes when encoded in UTF-8.
2583 */
2584 SecretToAuthenticateInitiator: ChapSecret;
2585 /**
2586 * The iSCSI initiator that connects to the target.
2587 */
2588 InitiatorName: IqnName;
2589 /**
2590 * The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client). Byte constraints: Minimum bytes of 12. Maximum bytes of 16. The secret key must be between 12 and 16 bytes when encoded in UTF-8.
2591 */
2592 SecretToAuthenticateTarget?: ChapSecret;
2593 }
2594 export interface UpdateChapCredentialsOutput {
2595 /**
2596 * The Amazon Resource Name (ARN) of the target. This is the same target specified in the request.
2597 */
2598 TargetARN?: TargetARN;
2599 /**
2600 * The iSCSI initiator that connects to the target. This is the same initiator name specified in the request.
2601 */
2602 InitiatorName?: IqnName;
2603 }
2604 export interface UpdateGatewayInformationInput {
2605 GatewayARN: GatewayARN;
2606 GatewayName?: GatewayName;
2607 /**
2608 * A value that indicates the time zone of the gateway.
2609 */
2610 GatewayTimezone?: GatewayTimezone;
2611 /**
2612 * The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want to use to monitor and log events in the gateway. For more information, see What Is Amazon CloudWatch Logs?.
2613 */
2614 CloudWatchLogGroupARN?: CloudWatchLogGroupARN;
2615 }
2616 export interface UpdateGatewayInformationOutput {
2617 GatewayARN?: GatewayARN;
2618 /**
2619 * The name you configured for your gateway.
2620 */
2621 GatewayName?: string;
2622 }
2623 export interface UpdateGatewaySoftwareNowInput {
2624 GatewayARN: GatewayARN;
2625 }
2626 export interface UpdateGatewaySoftwareNowOutput {
2627 GatewayARN?: GatewayARN;
2628 }
2629 export interface UpdateMaintenanceStartTimeInput {
2630 GatewayARN: GatewayARN;
2631 /**
2632 * The hour component of the maintenance start time represented as hh, where hh is the hour (00 to 23). The hour of the day is in the time zone of the gateway.
2633 */
2634 HourOfDay: HourOfDay;
2635 /**
2636 * The minute component of the maintenance start time represented as mm, where mm is the minute (00 to 59). The minute of the hour is in the time zone of the gateway.
2637 */
2638 MinuteOfHour: MinuteOfHour;
2639 /**
2640 * The day of the week component of the maintenance start time week represented as an ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday.
2641 */
2642 DayOfWeek?: DayOfWeek;
2643 /**
2644 * The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month. This value is only available for tape and volume gateways.
2645 */
2646 DayOfMonth?: DayOfMonth;
2647 }
2648 export interface UpdateMaintenanceStartTimeOutput {
2649 GatewayARN?: GatewayARN;
2650 }
2651 export interface UpdateNFSFileShareInput {
2652 /**
2653 * The Amazon Resource Name (ARN) of the file share to be updated.
2654 */
2655 FileShareARN: FileShareARN;
2656 /**
2657 * True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
2658 */
2659 KMSEncrypted?: Boolean;
2660 /**
2661 * The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
2662 */
2663 KMSKey?: KMSKey;
2664 /**
2665 * The default values for the file share. Optional.
2666 */
2667 NFSFileShareDefaults?: NFSFileShareDefaults;
2668 /**
2669 * The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.
2670 */
2671 DefaultStorageClass?: StorageClass;
2672 /**
2673 * A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".
2674 */
2675 ObjectACL?: ObjectACL;
2676 /**
2677 * The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.
2678 */
2679 ClientList?: FileShareClientList;
2680 /**
2681 * 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.
2682 */
2683 Squash?: Squash;
2684 /**
2685 * A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
2686 */
2687 ReadOnly?: Boolean;
2688 /**
2689 * 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, and otherwise to false. The default value is true.
2690 */
2691 GuessMIMETypeEnabled?: Boolean;
2692 /**
2693 * 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.
2694 */
2695 RequesterPays?: Boolean;
2696 }
2697 export interface UpdateNFSFileShareOutput {
2698 /**
2699 * The Amazon Resource Name (ARN) of the updated file share.
2700 */
2701 FileShareARN?: FileShareARN;
2702 }
2703 export interface UpdateSMBFileShareInput {
2704 /**
2705 * The Amazon Resource Name (ARN) of the SMB file share that you want to update.
2706 */
2707 FileShareARN: FileShareARN;
2708 /**
2709 * True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
2710 */
2711 KMSEncrypted?: Boolean;
2712 /**
2713 * The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
2714 */
2715 KMSKey?: KMSKey;
2716 /**
2717 * The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.
2718 */
2719 DefaultStorageClass?: StorageClass;
2720 /**
2721 * A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".
2722 */
2723 ObjectACL?: ObjectACL;
2724 /**
2725 * A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
2726 */
2727 ReadOnly?: Boolean;
2728 /**
2729 * 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, and otherwise to false. The default value is true.
2730 */
2731 GuessMIMETypeEnabled?: Boolean;
2732 /**
2733 * 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.
2734 */
2735 RequesterPays?: Boolean;
2736 /**
2737 * Set this value to "true to enable ACL (access control list) on the SMB file share. Set it to "false" to map file and directory permissions to the POSIX permissions. For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.htmlin the Storage Gateway User Guide.
2738 */
2739 SMBACLEnabled?: Boolean;
2740 /**
2741 * A list of users in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
2742 */
2743 AdminUserList?: FileShareUserList;
2744 /**
2745 * 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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
2746 */
2747 ValidUserList?: FileShareUserList;
2748 /**
2749 * 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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
2750 */
2751 InvalidUserList?: FileShareUserList;
2752 /**
2753 * The Amazon Resource Name (ARN) of the storage used for the audit logs.
2754 */
2755 AuditDestinationARN?: AuditDestinationARN;
2756 }
2757 export interface UpdateSMBFileShareOutput {
2758 /**
2759 * The Amazon Resource Name (ARN) of the updated SMB file share.
2760 */
2761 FileShareARN?: FileShareARN;
2762 }
2763 export interface UpdateSMBSecurityStrategyInput {
2764 GatewayARN: GatewayARN;
2765 /**
2766 * Specifies the type of security strategy. ClientSpecified: if you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. MandatorySigning: if you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer. MandatoryEncryption: if you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.
2767 */
2768 SMBSecurityStrategy: SMBSecurityStrategy;
2769 }
2770 export interface UpdateSMBSecurityStrategyOutput {
2771 GatewayARN?: GatewayARN;
2772 }
2773 export interface UpdateSnapshotScheduleInput {
2774 /**
2775 * The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
2776 */
2777 VolumeARN: VolumeARN;
2778 /**
2779 * The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.
2780 */
2781 StartAt: HourOfDay;
2782 /**
2783 * Frequency of snapshots. Specify the number of hours between snapshots.
2784 */
2785 RecurrenceInHours: RecurrenceInHours;
2786 /**
2787 * Optional description of the snapshot that overwrites the existing description.
2788 */
2789 Description?: Description;
2790 /**
2791 * A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair. Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
2792 */
2793 Tags?: Tags;
2794 }
2795 export interface UpdateSnapshotScheduleOutput {
2796 /**
2797 * The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
2798 */
2799 VolumeARN?: VolumeARN;
2800 }
2801 export interface UpdateVTLDeviceTypeInput {
2802 /**
2803 * The Amazon Resource Name (ARN) of the medium changer you want to select.
2804 */
2805 VTLDeviceARN: VTLDeviceARN;
2806 /**
2807 * The type of medium changer you want to select. Valid Values: "STK-L700", "AWS-Gateway-VTL"
2808 */
2809 DeviceType: DeviceType;
2810 }
2811 export interface UpdateVTLDeviceTypeOutput {
2812 /**
2813 * The Amazon Resource Name (ARN) of the medium changer you have selected.
2814 */
2815 VTLDeviceARN?: VTLDeviceARN;
2816 }
2817 export interface VTLDevice {
2818 /**
2819 * Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer).
2820 */
2821 VTLDeviceARN?: VTLDeviceARN;
2822 /**
2823 * Specifies the type of device that the VTL device emulates.
2824 */
2825 VTLDeviceType?: VTLDeviceType;
2826 /**
2827 * Specifies the vendor of the device that the VTL device object emulates.
2828 */
2829 VTLDeviceVendor?: VTLDeviceVendor;
2830 /**
2831 * Specifies the model number of device that the VTL device emulates.
2832 */
2833 VTLDeviceProductIdentifier?: VTLDeviceProductIdentifier;
2834 /**
2835 * A list of iSCSI information about a VTL device.
2836 */
2837 DeviceiSCSIAttributes?: DeviceiSCSIAttributes;
2838 }
2839 export type VTLDeviceARN = string;
2840 export type VTLDeviceARNs = VTLDeviceARN[];
2841 export type VTLDeviceProductIdentifier = string;
2842 export type VTLDeviceType = string;
2843 export type VTLDeviceVendor = string;
2844 export type VTLDevices = VTLDevice[];
2845 export type VolumeARN = string;
2846 export type VolumeARNs = VolumeARN[];
2847 export type VolumeAttachmentStatus = string;
2848 export type VolumeId = string;
2849 export interface VolumeInfo {
2850 /**
2851 * 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 (-).
2852 */
2853 VolumeARN?: VolumeARN;
2854 /**
2855 * 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 (-).
2856 */
2857 VolumeId?: VolumeId;
2858 GatewayARN?: GatewayARN;
2859 /**
2860 * 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 (-).
2861 */
2862 GatewayId?: GatewayId;
2863 /**
2864 * One of the VolumeType enumeration values describing the type of the volume.
2865 */
2866 VolumeType?: VolumeType;
2867 /**
2868 * The size of the volume in bytes. Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
2869 */
2870 VolumeSizeInBytes?: long;
2871 /**
2872 * One of the VolumeStatus values that indicates the state of the storage volume.
2873 */
2874 VolumeAttachmentStatus?: VolumeAttachmentStatus;
2875 }
2876 export type VolumeInfos = VolumeInfo[];
2877 export interface VolumeRecoveryPointInfo {
2878 /**
2879 * The Amazon Resource Name (ARN) of the volume target.
2880 */
2881 VolumeARN?: VolumeARN;
2882 /**
2883 * The size of the volume in bytes.
2884 */
2885 VolumeSizeInBytes?: long;
2886 /**
2887 * 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.
2888 */
2889 VolumeUsageInBytes?: long;
2890 /**
2891 * The time the recovery point was taken.
2892 */
2893 VolumeRecoveryPointTime?: string;
2894 }
2895 export type VolumeRecoveryPointInfos = VolumeRecoveryPointInfo[];
2896 export type VolumeStatus = string;
2897 export type VolumeType = string;
2898 export type VolumeUsedInBytes = number;
2899 export interface VolumeiSCSIAttributes {
2900 /**
2901 * The Amazon Resource Name (ARN) of the volume target.
2902 */
2903 TargetARN?: TargetARN;
2904 /**
2905 * The network interface identifier.
2906 */
2907 NetworkInterfaceId?: NetworkInterfaceId;
2908 /**
2909 * The port used to communicate with iSCSI targets.
2910 */
2911 NetworkInterfacePort?: integer;
2912 /**
2913 * The logical disk number.
2914 */
2915 LunNumber?: PositiveIntObject;
2916 /**
2917 * Indicates whether mutual CHAP is enabled for the iSCSI target.
2918 */
2919 ChapEnabled?: boolean;
2920 }
2921 export type double = number;
2922 export type integer = number;
2923 export type long = number;
2924 /**
2925 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2926 */
2927 export type apiVersion = "2013-06-30"|"latest"|string;
2928 export interface ClientApiVersions {
2929 /**
2930 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2931 */
2932 apiVersion?: apiVersion;
2933 }
2934 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
2935 /**
2936 * Contains interfaces for use with the StorageGateway client.
2937 */
2938 export import Types = StorageGateway;
2939}
2940export = StorageGateway;
2941
\No newline at end of file