UNPKG

187 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 region 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 region 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 10 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 10 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 * 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.
56 */
57 attachVolume(params: StorageGateway.Types.AttachVolumeInput, callback?: (err: AWSError, data: StorageGateway.Types.AttachVolumeOutput) => void): Request<StorageGateway.Types.AttachVolumeOutput, AWSError>;
58 /**
59 * 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.
60 */
61 attachVolume(callback?: (err: AWSError, data: StorageGateway.Types.AttachVolumeOutput) => void): Request<StorageGateway.Types.AttachVolumeOutput, AWSError>;
62 /**
63 * 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.
64 */
65 cancelArchival(params: StorageGateway.Types.CancelArchivalInput, callback?: (err: AWSError, data: StorageGateway.Types.CancelArchivalOutput) => void): Request<StorageGateway.Types.CancelArchivalOutput, AWSError>;
66 /**
67 * 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.
68 */
69 cancelArchival(callback?: (err: AWSError, data: StorageGateway.Types.CancelArchivalOutput) => void): Request<StorageGateway.Types.CancelArchivalOutput, AWSError>;
70 /**
71 * 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.
72 */
73 cancelRetrieval(params: StorageGateway.Types.CancelRetrievalInput, callback?: (err: AWSError, data: StorageGateway.Types.CancelRetrievalOutput) => void): Request<StorageGateway.Types.CancelRetrievalOutput, AWSError>;
74 /**
75 * 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.
76 */
77 cancelRetrieval(callback?: (err: AWSError, data: StorageGateway.Types.CancelRetrievalOutput) => void): Request<StorageGateway.Types.CancelRetrievalOutput, AWSError>;
78 /**
79 * 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.
80 */
81 createCachediSCSIVolume(params: StorageGateway.Types.CreateCachediSCSIVolumeInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateCachediSCSIVolumeOutput) => void): Request<StorageGateway.Types.CreateCachediSCSIVolumeOutput, AWSError>;
82 /**
83 * 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.
84 */
85 createCachediSCSIVolume(callback?: (err: AWSError, data: StorageGateway.Types.CreateCachediSCSIVolumeOutput) => void): Request<StorageGateway.Types.CreateCachediSCSIVolumeOutput, AWSError>;
86 /**
87 * 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 region you are creating your file gateway in. If AWS STS is not activated in the 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.
88 */
89 createNFSFileShare(params: StorageGateway.Types.CreateNFSFileShareInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateNFSFileShareOutput) => void): Request<StorageGateway.Types.CreateNFSFileShareOutput, AWSError>;
90 /**
91 * 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 region you are creating your file gateway in. If AWS STS is not activated in the 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.
92 */
93 createNFSFileShare(callback?: (err: AWSError, data: StorageGateway.Types.CreateNFSFileShareOutput) => void): Request<StorageGateway.Types.CreateNFSFileShareOutput, AWSError>;
94 /**
95 * 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.
96 */
97 createSMBFileShare(params: StorageGateway.Types.CreateSMBFileShareInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateSMBFileShareOutput) => void): Request<StorageGateway.Types.CreateSMBFileShareOutput, AWSError>;
98 /**
99 * 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.
100 */
101 createSMBFileShare(callback?: (err: AWSError, data: StorageGateway.Types.CreateSMBFileShareOutput) => void): Request<StorageGateway.Types.CreateSMBFileShareOutput, AWSError>;
102 /**
103 * 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.
104 */
105 createSnapshot(params: StorageGateway.Types.CreateSnapshotInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateSnapshotOutput) => void): Request<StorageGateway.Types.CreateSnapshotOutput, AWSError>;
106 /**
107 * 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.
108 */
109 createSnapshot(callback?: (err: AWSError, data: StorageGateway.Types.CreateSnapshotOutput) => void): Request<StorageGateway.Types.CreateSnapshotOutput, AWSError>;
110 /**
111 * 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.
112 */
113 createSnapshotFromVolumeRecoveryPoint(params: StorageGateway.Types.CreateSnapshotFromVolumeRecoveryPointInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateSnapshotFromVolumeRecoveryPointOutput) => void): Request<StorageGateway.Types.CreateSnapshotFromVolumeRecoveryPointOutput, AWSError>;
114 /**
115 * 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.
116 */
117 createSnapshotFromVolumeRecoveryPoint(callback?: (err: AWSError, data: StorageGateway.Types.CreateSnapshotFromVolumeRecoveryPointOutput) => void): Request<StorageGateway.Types.CreateSnapshotFromVolumeRecoveryPointOutput, AWSError>;
118 /**
119 * 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.
120 */
121 createStorediSCSIVolume(params: StorageGateway.Types.CreateStorediSCSIVolumeInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateStorediSCSIVolumeOutput) => void): Request<StorageGateway.Types.CreateStorediSCSIVolumeOutput, AWSError>;
122 /**
123 * 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.
124 */
125 createStorediSCSIVolume(callback?: (err: AWSError, data: StorageGateway.Types.CreateStorediSCSIVolumeOutput) => void): Request<StorageGateway.Types.CreateStorediSCSIVolumeOutput, AWSError>;
126 /**
127 * 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.
128 */
129 createTapeWithBarcode(params: StorageGateway.Types.CreateTapeWithBarcodeInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateTapeWithBarcodeOutput) => void): Request<StorageGateway.Types.CreateTapeWithBarcodeOutput, AWSError>;
130 /**
131 * 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.
132 */
133 createTapeWithBarcode(callback?: (err: AWSError, data: StorageGateway.Types.CreateTapeWithBarcodeOutput) => void): Request<StorageGateway.Types.CreateTapeWithBarcodeOutput, AWSError>;
134 /**
135 * 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.
136 */
137 createTapes(params: StorageGateway.Types.CreateTapesInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateTapesOutput) => void): Request<StorageGateway.Types.CreateTapesOutput, AWSError>;
138 /**
139 * 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.
140 */
141 createTapes(callback?: (err: AWSError, data: StorageGateway.Types.CreateTapesOutput) => void): Request<StorageGateway.Types.CreateTapesOutput, AWSError>;
142 /**
143 * 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.
144 */
145 deleteBandwidthRateLimit(params: StorageGateway.Types.DeleteBandwidthRateLimitInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteBandwidthRateLimitOutput) => void): Request<StorageGateway.Types.DeleteBandwidthRateLimitOutput, AWSError>;
146 /**
147 * 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.
148 */
149 deleteBandwidthRateLimit(callback?: (err: AWSError, data: StorageGateway.Types.DeleteBandwidthRateLimitOutput) => void): Request<StorageGateway.Types.DeleteBandwidthRateLimitOutput, AWSError>;
150 /**
151 * Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.
152 */
153 deleteChapCredentials(params: StorageGateway.Types.DeleteChapCredentialsInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteChapCredentialsOutput) => void): Request<StorageGateway.Types.DeleteChapCredentialsOutput, AWSError>;
154 /**
155 * Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.
156 */
157 deleteChapCredentials(callback?: (err: AWSError, data: StorageGateway.Types.DeleteChapCredentialsOutput) => void): Request<StorageGateway.Types.DeleteChapCredentialsOutput, AWSError>;
158 /**
159 * Deletes a file share from a file gateway. This operation is only supported for file gateways.
160 */
161 deleteFileShare(params: StorageGateway.Types.DeleteFileShareInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteFileShareOutput) => void): Request<StorageGateway.Types.DeleteFileShareOutput, AWSError>;
162 /**
163 * Deletes a file share from a file gateway. This operation is only supported for file gateways.
164 */
165 deleteFileShare(callback?: (err: AWSError, data: StorageGateway.Types.DeleteFileShareOutput) => void): Request<StorageGateway.Types.DeleteFileShareOutput, AWSError>;
166 /**
167 * 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.
168 */
169 deleteGateway(params: StorageGateway.Types.DeleteGatewayInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteGatewayOutput) => void): Request<StorageGateway.Types.DeleteGatewayOutput, AWSError>;
170 /**
171 * 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.
172 */
173 deleteGateway(callback?: (err: AWSError, data: StorageGateway.Types.DeleteGatewayOutput) => void): Request<StorageGateway.Types.DeleteGatewayOutput, AWSError>;
174 /**
175 * 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.
176 */
177 deleteSnapshotSchedule(params: StorageGateway.Types.DeleteSnapshotScheduleInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteSnapshotScheduleOutput) => void): Request<StorageGateway.Types.DeleteSnapshotScheduleOutput, AWSError>;
178 /**
179 * 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.
180 */
181 deleteSnapshotSchedule(callback?: (err: AWSError, data: StorageGateway.Types.DeleteSnapshotScheduleOutput) => void): Request<StorageGateway.Types.DeleteSnapshotScheduleOutput, AWSError>;
182 /**
183 * Deletes the specified virtual tape. This operation is only supported in the tape gateway type.
184 */
185 deleteTape(params: StorageGateway.Types.DeleteTapeInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteTapeOutput) => void): Request<StorageGateway.Types.DeleteTapeOutput, AWSError>;
186 /**
187 * Deletes the specified virtual tape. This operation is only supported in the tape gateway type.
188 */
189 deleteTape(callback?: (err: AWSError, data: StorageGateway.Types.DeleteTapeOutput) => void): Request<StorageGateway.Types.DeleteTapeOutput, AWSError>;
190 /**
191 * Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.
192 */
193 deleteTapeArchive(params: StorageGateway.Types.DeleteTapeArchiveInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteTapeArchiveOutput) => void): Request<StorageGateway.Types.DeleteTapeArchiveOutput, AWSError>;
194 /**
195 * Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.
196 */
197 deleteTapeArchive(callback?: (err: AWSError, data: StorageGateway.Types.DeleteTapeArchiveOutput) => void): Request<StorageGateway.Types.DeleteTapeArchiveOutput, AWSError>;
198 /**
199 * 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.
200 */
201 deleteVolume(params: StorageGateway.Types.DeleteVolumeInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteVolumeOutput) => void): Request<StorageGateway.Types.DeleteVolumeOutput, AWSError>;
202 /**
203 * 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.
204 */
205 deleteVolume(callback?: (err: AWSError, data: StorageGateway.Types.DeleteVolumeOutput) => void): Request<StorageGateway.Types.DeleteVolumeOutput, AWSError>;
206 /**
207 * 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 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.
208 */
209 describeBandwidthRateLimit(params: StorageGateway.Types.DescribeBandwidthRateLimitInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeBandwidthRateLimitOutput) => void): Request<StorageGateway.Types.DescribeBandwidthRateLimitOutput, AWSError>;
210 /**
211 * 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 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.
212 */
213 describeBandwidthRateLimit(callback?: (err: AWSError, data: StorageGateway.Types.DescribeBandwidthRateLimitOutput) => void): Request<StorageGateway.Types.DescribeBandwidthRateLimitOutput, AWSError>;
214 /**
215 * 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.
216 */
217 describeCache(params: StorageGateway.Types.DescribeCacheInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeCacheOutput) => void): Request<StorageGateway.Types.DescribeCacheOutput, AWSError>;
218 /**
219 * 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.
220 */
221 describeCache(callback?: (err: AWSError, data: StorageGateway.Types.DescribeCacheOutput) => void): Request<StorageGateway.Types.DescribeCacheOutput, AWSError>;
222 /**
223 * 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).
224 */
225 describeCachediSCSIVolumes(params: StorageGateway.Types.DescribeCachediSCSIVolumesInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeCachediSCSIVolumesOutput) => void): Request<StorageGateway.Types.DescribeCachediSCSIVolumesOutput, AWSError>;
226 /**
227 * 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).
228 */
229 describeCachediSCSIVolumes(callback?: (err: AWSError, data: StorageGateway.Types.DescribeCachediSCSIVolumesOutput) => void): Request<StorageGateway.Types.DescribeCachediSCSIVolumesOutput, AWSError>;
230 /**
231 * Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.
232 */
233 describeChapCredentials(params: StorageGateway.Types.DescribeChapCredentialsInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeChapCredentialsOutput) => void): Request<StorageGateway.Types.DescribeChapCredentialsOutput, AWSError>;
234 /**
235 * Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.
236 */
237 describeChapCredentials(callback?: (err: AWSError, data: StorageGateway.Types.DescribeChapCredentialsOutput) => void): Request<StorageGateway.Types.DescribeChapCredentialsOutput, AWSError>;
238 /**
239 * 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.
240 */
241 describeGatewayInformation(params: StorageGateway.Types.DescribeGatewayInformationInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeGatewayInformationOutput) => void): Request<StorageGateway.Types.DescribeGatewayInformationOutput, AWSError>;
242 /**
243 * 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.
244 */
245 describeGatewayInformation(callback?: (err: AWSError, data: StorageGateway.Types.DescribeGatewayInformationOutput) => void): Request<StorageGateway.Types.DescribeGatewayInformationOutput, AWSError>;
246 /**
247 * 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.
248 */
249 describeMaintenanceStartTime(params: StorageGateway.Types.DescribeMaintenanceStartTimeInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeMaintenanceStartTimeOutput) => void): Request<StorageGateway.Types.DescribeMaintenanceStartTimeOutput, AWSError>;
250 /**
251 * 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.
252 */
253 describeMaintenanceStartTime(callback?: (err: AWSError, data: StorageGateway.Types.DescribeMaintenanceStartTimeOutput) => void): Request<StorageGateway.Types.DescribeMaintenanceStartTimeOutput, AWSError>;
254 /**
255 * 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.
256 */
257 describeNFSFileShares(params: StorageGateway.Types.DescribeNFSFileSharesInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeNFSFileSharesOutput) => void): Request<StorageGateway.Types.DescribeNFSFileSharesOutput, AWSError>;
258 /**
259 * 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.
260 */
261 describeNFSFileShares(callback?: (err: AWSError, data: StorageGateway.Types.DescribeNFSFileSharesOutput) => void): Request<StorageGateway.Types.DescribeNFSFileSharesOutput, AWSError>;
262 /**
263 * 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.
264 */
265 describeSMBFileShares(params: StorageGateway.Types.DescribeSMBFileSharesInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeSMBFileSharesOutput) => void): Request<StorageGateway.Types.DescribeSMBFileSharesOutput, AWSError>;
266 /**
267 * 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.
268 */
269 describeSMBFileShares(callback?: (err: AWSError, data: StorageGateway.Types.DescribeSMBFileSharesOutput) => void): Request<StorageGateway.Types.DescribeSMBFileSharesOutput, AWSError>;
270 /**
271 * Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.
272 */
273 describeSMBSettings(params: StorageGateway.Types.DescribeSMBSettingsInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeSMBSettingsOutput) => void): Request<StorageGateway.Types.DescribeSMBSettingsOutput, AWSError>;
274 /**
275 * Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.
276 */
277 describeSMBSettings(callback?: (err: AWSError, data: StorageGateway.Types.DescribeSMBSettingsOutput) => void): Request<StorageGateway.Types.DescribeSMBSettingsOutput, AWSError>;
278 /**
279 * 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.
280 */
281 describeSnapshotSchedule(params: StorageGateway.Types.DescribeSnapshotScheduleInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeSnapshotScheduleOutput) => void): Request<StorageGateway.Types.DescribeSnapshotScheduleOutput, AWSError>;
282 /**
283 * 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.
284 */
285 describeSnapshotSchedule(callback?: (err: AWSError, data: StorageGateway.Types.DescribeSnapshotScheduleOutput) => void): Request<StorageGateway.Types.DescribeSnapshotScheduleOutput, AWSError>;
286 /**
287 * 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.
288 */
289 describeStorediSCSIVolumes(params: StorageGateway.Types.DescribeStorediSCSIVolumesInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeStorediSCSIVolumesOutput) => void): Request<StorageGateway.Types.DescribeStorediSCSIVolumesOutput, AWSError>;
290 /**
291 * 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.
292 */
293 describeStorediSCSIVolumes(callback?: (err: AWSError, data: StorageGateway.Types.DescribeStorediSCSIVolumesOutput) => void): Request<StorageGateway.Types.DescribeStorediSCSIVolumesOutput, AWSError>;
294 /**
295 * 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.
296 */
297 describeTapeArchives(params: StorageGateway.Types.DescribeTapeArchivesInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeTapeArchivesOutput) => void): Request<StorageGateway.Types.DescribeTapeArchivesOutput, AWSError>;
298 /**
299 * 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.
300 */
301 describeTapeArchives(callback?: (err: AWSError, data: StorageGateway.Types.DescribeTapeArchivesOutput) => void): Request<StorageGateway.Types.DescribeTapeArchivesOutput, AWSError>;
302 /**
303 * 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.
304 */
305 describeTapeRecoveryPoints(params: StorageGateway.Types.DescribeTapeRecoveryPointsInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeTapeRecoveryPointsOutput) => void): Request<StorageGateway.Types.DescribeTapeRecoveryPointsOutput, AWSError>;
306 /**
307 * 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.
308 */
309 describeTapeRecoveryPoints(callback?: (err: AWSError, data: StorageGateway.Types.DescribeTapeRecoveryPointsOutput) => void): Request<StorageGateway.Types.DescribeTapeRecoveryPointsOutput, AWSError>;
310 /**
311 * 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.
312 */
313 describeTapes(params: StorageGateway.Types.DescribeTapesInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeTapesOutput) => void): Request<StorageGateway.Types.DescribeTapesOutput, AWSError>;
314 /**
315 * 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.
316 */
317 describeTapes(callback?: (err: AWSError, data: StorageGateway.Types.DescribeTapesOutput) => void): Request<StorageGateway.Types.DescribeTapesOutput, AWSError>;
318 /**
319 * 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.
320 */
321 describeUploadBuffer(params: StorageGateway.Types.DescribeUploadBufferInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeUploadBufferOutput) => void): Request<StorageGateway.Types.DescribeUploadBufferOutput, AWSError>;
322 /**
323 * 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.
324 */
325 describeUploadBuffer(callback?: (err: AWSError, data: StorageGateway.Types.DescribeUploadBufferOutput) => void): Request<StorageGateway.Types.DescribeUploadBufferOutput, AWSError>;
326 /**
327 * 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.
328 */
329 describeVTLDevices(params: StorageGateway.Types.DescribeVTLDevicesInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeVTLDevicesOutput) => void): Request<StorageGateway.Types.DescribeVTLDevicesOutput, AWSError>;
330 /**
331 * 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.
332 */
333 describeVTLDevices(callback?: (err: AWSError, data: StorageGateway.Types.DescribeVTLDevicesOutput) => void): Request<StorageGateway.Types.DescribeVTLDevicesOutput, AWSError>;
334 /**
335 * 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.
336 */
337 describeWorkingStorage(params: StorageGateway.Types.DescribeWorkingStorageInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeWorkingStorageOutput) => void): Request<StorageGateway.Types.DescribeWorkingStorageOutput, AWSError>;
338 /**
339 * 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.
340 */
341 describeWorkingStorage(callback?: (err: AWSError, data: StorageGateway.Types.DescribeWorkingStorageOutput) => void): Request<StorageGateway.Types.DescribeWorkingStorageOutput, AWSError>;
342 /**
343 * 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.
344 */
345 detachVolume(params: StorageGateway.Types.DetachVolumeInput, callback?: (err: AWSError, data: StorageGateway.Types.DetachVolumeOutput) => void): Request<StorageGateway.Types.DetachVolumeOutput, AWSError>;
346 /**
347 * 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.
348 */
349 detachVolume(callback?: (err: AWSError, data: StorageGateway.Types.DetachVolumeOutput) => void): Request<StorageGateway.Types.DetachVolumeOutput, AWSError>;
350 /**
351 * 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.
352 */
353 disableGateway(params: StorageGateway.Types.DisableGatewayInput, callback?: (err: AWSError, data: StorageGateway.Types.DisableGatewayOutput) => void): Request<StorageGateway.Types.DisableGatewayOutput, AWSError>;
354 /**
355 * 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.
356 */
357 disableGateway(callback?: (err: AWSError, data: StorageGateway.Types.DisableGatewayOutput) => void): Request<StorageGateway.Types.DisableGatewayOutput, AWSError>;
358 /**
359 * Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.
360 */
361 joinDomain(params: StorageGateway.Types.JoinDomainInput, callback?: (err: AWSError, data: StorageGateway.Types.JoinDomainOutput) => void): Request<StorageGateway.Types.JoinDomainOutput, AWSError>;
362 /**
363 * Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.
364 */
365 joinDomain(callback?: (err: AWSError, data: StorageGateway.Types.JoinDomainOutput) => void): Request<StorageGateway.Types.JoinDomainOutput, AWSError>;
366 /**
367 * 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.
368 */
369 listFileShares(params: StorageGateway.Types.ListFileSharesInput, callback?: (err: AWSError, data: StorageGateway.Types.ListFileSharesOutput) => void): Request<StorageGateway.Types.ListFileSharesOutput, AWSError>;
370 /**
371 * 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.
372 */
373 listFileShares(callback?: (err: AWSError, data: StorageGateway.Types.ListFileSharesOutput) => void): Request<StorageGateway.Types.ListFileSharesOutput, AWSError>;
374 /**
375 * Lists gateways owned by an AWS account in a 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.
376 */
377 listGateways(params: StorageGateway.Types.ListGatewaysInput, callback?: (err: AWSError, data: StorageGateway.Types.ListGatewaysOutput) => void): Request<StorageGateway.Types.ListGatewaysOutput, AWSError>;
378 /**
379 * Lists gateways owned by an AWS account in a 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.
380 */
381 listGateways(callback?: (err: AWSError, data: StorageGateway.Types.ListGatewaysOutput) => void): Request<StorageGateway.Types.ListGatewaysOutput, AWSError>;
382 /**
383 * 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).
384 */
385 listLocalDisks(params: StorageGateway.Types.ListLocalDisksInput, callback?: (err: AWSError, data: StorageGateway.Types.ListLocalDisksOutput) => void): Request<StorageGateway.Types.ListLocalDisksOutput, AWSError>;
386 /**
387 * 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).
388 */
389 listLocalDisks(callback?: (err: AWSError, data: StorageGateway.Types.ListLocalDisksOutput) => void): Request<StorageGateway.Types.ListLocalDisksOutput, AWSError>;
390 /**
391 * Lists the tags that have been added to the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway type.
392 */
393 listTagsForResource(params: StorageGateway.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: StorageGateway.Types.ListTagsForResourceOutput) => void): Request<StorageGateway.Types.ListTagsForResourceOutput, AWSError>;
394 /**
395 * Lists the tags that have been added to the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway type.
396 */
397 listTagsForResource(callback?: (err: AWSError, data: StorageGateway.Types.ListTagsForResourceOutput) => void): Request<StorageGateway.Types.ListTagsForResourceOutput, AWSError>;
398 /**
399 * 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.
400 */
401 listTapes(params: StorageGateway.Types.ListTapesInput, callback?: (err: AWSError, data: StorageGateway.Types.ListTapesOutput) => void): Request<StorageGateway.Types.ListTapesOutput, AWSError>;
402 /**
403 * 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.
404 */
405 listTapes(callback?: (err: AWSError, data: StorageGateway.Types.ListTapesOutput) => void): Request<StorageGateway.Types.ListTapesOutput, AWSError>;
406 /**
407 * 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.
408 */
409 listVolumeInitiators(params: StorageGateway.Types.ListVolumeInitiatorsInput, callback?: (err: AWSError, data: StorageGateway.Types.ListVolumeInitiatorsOutput) => void): Request<StorageGateway.Types.ListVolumeInitiatorsOutput, AWSError>;
410 /**
411 * 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.
412 */
413 listVolumeInitiators(callback?: (err: AWSError, data: StorageGateway.Types.ListVolumeInitiatorsOutput) => void): Request<StorageGateway.Types.ListVolumeInitiatorsOutput, AWSError>;
414 /**
415 * 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.
416 */
417 listVolumeRecoveryPoints(params: StorageGateway.Types.ListVolumeRecoveryPointsInput, callback?: (err: AWSError, data: StorageGateway.Types.ListVolumeRecoveryPointsOutput) => void): Request<StorageGateway.Types.ListVolumeRecoveryPointsOutput, AWSError>;
418 /**
419 * 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.
420 */
421 listVolumeRecoveryPoints(callback?: (err: AWSError, data: StorageGateway.Types.ListVolumeRecoveryPointsOutput) => void): Request<StorageGateway.Types.ListVolumeRecoveryPointsOutput, AWSError>;
422 /**
423 * 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.
424 */
425 listVolumes(params: StorageGateway.Types.ListVolumesInput, callback?: (err: AWSError, data: StorageGateway.Types.ListVolumesOutput) => void): Request<StorageGateway.Types.ListVolumesOutput, AWSError>;
426 /**
427 * 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.
428 */
429 listVolumes(callback?: (err: AWSError, data: StorageGateway.Types.ListVolumesOutput) => void): Request<StorageGateway.Types.ListVolumesOutput, AWSError>;
430 /**
431 * Sends you notification through CloudWatch Events when all files written to your NFS 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 NFS 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).
432 */
433 notifyWhenUploaded(params: StorageGateway.Types.NotifyWhenUploadedInput, callback?: (err: AWSError, data: StorageGateway.Types.NotifyWhenUploadedOutput) => void): Request<StorageGateway.Types.NotifyWhenUploadedOutput, AWSError>;
434 /**
435 * Sends you notification through CloudWatch Events when all files written to your NFS 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 NFS 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).
436 */
437 notifyWhenUploaded(callback?: (err: AWSError, data: StorageGateway.Types.NotifyWhenUploadedOutput) => void): Request<StorageGateway.Types.NotifyWhenUploadedOutput, AWSError>;
438 /**
439 * 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.
440 */
441 refreshCache(params: StorageGateway.Types.RefreshCacheInput, callback?: (err: AWSError, data: StorageGateway.Types.RefreshCacheOutput) => void): Request<StorageGateway.Types.RefreshCacheOutput, AWSError>;
442 /**
443 * 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.
444 */
445 refreshCache(callback?: (err: AWSError, data: StorageGateway.Types.RefreshCacheOutput) => void): Request<StorageGateway.Types.RefreshCacheOutput, AWSError>;
446 /**
447 * Removes one or more tags from the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway types.
448 */
449 removeTagsFromResource(params: StorageGateway.Types.RemoveTagsFromResourceInput, callback?: (err: AWSError, data: StorageGateway.Types.RemoveTagsFromResourceOutput) => void): Request<StorageGateway.Types.RemoveTagsFromResourceOutput, AWSError>;
450 /**
451 * Removes one or more tags from the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway types.
452 */
453 removeTagsFromResource(callback?: (err: AWSError, data: StorageGateway.Types.RemoveTagsFromResourceOutput) => void): Request<StorageGateway.Types.RemoveTagsFromResourceOutput, AWSError>;
454 /**
455 * 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.
456 */
457 resetCache(params: StorageGateway.Types.ResetCacheInput, callback?: (err: AWSError, data: StorageGateway.Types.ResetCacheOutput) => void): Request<StorageGateway.Types.ResetCacheOutput, AWSError>;
458 /**
459 * 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.
460 */
461 resetCache(callback?: (err: AWSError, data: StorageGateway.Types.ResetCacheOutput) => void): Request<StorageGateway.Types.ResetCacheOutput, AWSError>;
462 /**
463 * 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.
464 */
465 retrieveTapeArchive(params: StorageGateway.Types.RetrieveTapeArchiveInput, callback?: (err: AWSError, data: StorageGateway.Types.RetrieveTapeArchiveOutput) => void): Request<StorageGateway.Types.RetrieveTapeArchiveOutput, AWSError>;
466 /**
467 * 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.
468 */
469 retrieveTapeArchive(callback?: (err: AWSError, data: StorageGateway.Types.RetrieveTapeArchiveOutput) => void): Request<StorageGateway.Types.RetrieveTapeArchiveOutput, AWSError>;
470 /**
471 * 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.
472 */
473 retrieveTapeRecoveryPoint(params: StorageGateway.Types.RetrieveTapeRecoveryPointInput, callback?: (err: AWSError, data: StorageGateway.Types.RetrieveTapeRecoveryPointOutput) => void): Request<StorageGateway.Types.RetrieveTapeRecoveryPointOutput, AWSError>;
474 /**
475 * 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.
476 */
477 retrieveTapeRecoveryPoint(callback?: (err: AWSError, data: StorageGateway.Types.RetrieveTapeRecoveryPointOutput) => void): Request<StorageGateway.Types.RetrieveTapeRecoveryPointOutput, AWSError>;
478 /**
479 * 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.
480 */
481 setLocalConsolePassword(params: StorageGateway.Types.SetLocalConsolePasswordInput, callback?: (err: AWSError, data: StorageGateway.Types.SetLocalConsolePasswordOutput) => void): Request<StorageGateway.Types.SetLocalConsolePasswordOutput, AWSError>;
482 /**
483 * 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.
484 */
485 setLocalConsolePassword(callback?: (err: AWSError, data: StorageGateway.Types.SetLocalConsolePasswordOutput) => void): Request<StorageGateway.Types.SetLocalConsolePasswordOutput, AWSError>;
486 /**
487 * 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.
488 */
489 setSMBGuestPassword(params: StorageGateway.Types.SetSMBGuestPasswordInput, callback?: (err: AWSError, data: StorageGateway.Types.SetSMBGuestPasswordOutput) => void): Request<StorageGateway.Types.SetSMBGuestPasswordOutput, AWSError>;
490 /**
491 * 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.
492 */
493 setSMBGuestPassword(callback?: (err: AWSError, data: StorageGateway.Types.SetSMBGuestPasswordOutput) => void): Request<StorageGateway.Types.SetSMBGuestPasswordOutput, AWSError>;
494 /**
495 * 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.
496 */
497 shutdownGateway(params: StorageGateway.Types.ShutdownGatewayInput, callback?: (err: AWSError, data: StorageGateway.Types.ShutdownGatewayOutput) => void): Request<StorageGateway.Types.ShutdownGatewayOutput, AWSError>;
498 /**
499 * 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.
500 */
501 shutdownGateway(callback?: (err: AWSError, data: StorageGateway.Types.ShutdownGatewayOutput) => void): Request<StorageGateway.Types.ShutdownGatewayOutput, AWSError>;
502 /**
503 * 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.
504 */
505 startGateway(params: StorageGateway.Types.StartGatewayInput, callback?: (err: AWSError, data: StorageGateway.Types.StartGatewayOutput) => void): Request<StorageGateway.Types.StartGatewayOutput, AWSError>;
506 /**
507 * 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.
508 */
509 startGateway(callback?: (err: AWSError, data: StorageGateway.Types.StartGatewayOutput) => void): Request<StorageGateway.Types.StartGatewayOutput, AWSError>;
510 /**
511 * 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. 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.
512 */
513 updateBandwidthRateLimit(params: StorageGateway.Types.UpdateBandwidthRateLimitInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateBandwidthRateLimitOutput) => void): Request<StorageGateway.Types.UpdateBandwidthRateLimitOutput, AWSError>;
514 /**
515 * 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. 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.
516 */
517 updateBandwidthRateLimit(callback?: (err: AWSError, data: StorageGateway.Types.UpdateBandwidthRateLimitOutput) => void): Request<StorageGateway.Types.UpdateBandwidthRateLimitOutput, AWSError>;
518 /**
519 * 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. When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.
520 */
521 updateChapCredentials(params: StorageGateway.Types.UpdateChapCredentialsInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateChapCredentialsOutput) => void): Request<StorageGateway.Types.UpdateChapCredentialsOutput, AWSError>;
522 /**
523 * 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. When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.
524 */
525 updateChapCredentials(callback?: (err: AWSError, data: StorageGateway.Types.UpdateChapCredentialsOutput) => void): Request<StorageGateway.Types.UpdateChapCredentialsOutput, AWSError>;
526 /**
527 * 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.
528 */
529 updateGatewayInformation(params: StorageGateway.Types.UpdateGatewayInformationInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateGatewayInformationOutput) => void): Request<StorageGateway.Types.UpdateGatewayInformationOutput, AWSError>;
530 /**
531 * 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.
532 */
533 updateGatewayInformation(callback?: (err: AWSError, data: StorageGateway.Types.UpdateGatewayInformationOutput) => void): Request<StorageGateway.Types.UpdateGatewayInformationOutput, AWSError>;
534 /**
535 * 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.
536 */
537 updateGatewaySoftwareNow(params: StorageGateway.Types.UpdateGatewaySoftwareNowInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateGatewaySoftwareNowOutput) => void): Request<StorageGateway.Types.UpdateGatewaySoftwareNowOutput, AWSError>;
538 /**
539 * 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.
540 */
541 updateGatewaySoftwareNow(callback?: (err: AWSError, data: StorageGateway.Types.UpdateGatewaySoftwareNowOutput) => void): Request<StorageGateway.Types.UpdateGatewaySoftwareNowOutput, AWSError>;
542 /**
543 * 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.
544 */
545 updateMaintenanceStartTime(params: StorageGateway.Types.UpdateMaintenanceStartTimeInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateMaintenanceStartTimeOutput) => void): Request<StorageGateway.Types.UpdateMaintenanceStartTimeOutput, AWSError>;
546 /**
547 * 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.
548 */
549 updateMaintenanceStartTime(callback?: (err: AWSError, data: StorageGateway.Types.UpdateMaintenanceStartTimeOutput) => void): Request<StorageGateway.Types.UpdateMaintenanceStartTimeOutput, AWSError>;
550 /**
551 * 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.
552 */
553 updateNFSFileShare(params: StorageGateway.Types.UpdateNFSFileShareInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateNFSFileShareOutput) => void): Request<StorageGateway.Types.UpdateNFSFileShareOutput, AWSError>;
554 /**
555 * 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.
556 */
557 updateNFSFileShare(callback?: (err: AWSError, data: StorageGateway.Types.UpdateNFSFileShareOutput) => void): Request<StorageGateway.Types.UpdateNFSFileShareOutput, AWSError>;
558 /**
559 * 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.
560 */
561 updateSMBFileShare(params: StorageGateway.Types.UpdateSMBFileShareInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateSMBFileShareOutput) => void): Request<StorageGateway.Types.UpdateSMBFileShareOutput, AWSError>;
562 /**
563 * 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.
564 */
565 updateSMBFileShare(callback?: (err: AWSError, data: StorageGateway.Types.UpdateSMBFileShareOutput) => void): Request<StorageGateway.Types.UpdateSMBFileShareOutput, AWSError>;
566 /**
567 * 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.
568 */
569 updateSnapshotSchedule(params: StorageGateway.Types.UpdateSnapshotScheduleInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateSnapshotScheduleOutput) => void): Request<StorageGateway.Types.UpdateSnapshotScheduleOutput, AWSError>;
570 /**
571 * 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.
572 */
573 updateSnapshotSchedule(callback?: (err: AWSError, data: StorageGateway.Types.UpdateSnapshotScheduleOutput) => void): Request<StorageGateway.Types.UpdateSnapshotScheduleOutput, AWSError>;
574 /**
575 * 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.
576 */
577 updateVTLDeviceType(params: StorageGateway.Types.UpdateVTLDeviceTypeInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateVTLDeviceTypeOutput) => void): Request<StorageGateway.Types.UpdateVTLDeviceTypeOutput, AWSError>;
578 /**
579 * 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.
580 */
581 updateVTLDeviceType(callback?: (err: AWSError, data: StorageGateway.Types.UpdateVTLDeviceTypeOutput) => void): Request<StorageGateway.Types.UpdateVTLDeviceTypeOutput, AWSError>;
582}
583declare namespace StorageGateway {
584 export interface ActivateGatewayInput {
585 /**
586 * 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.
587 */
588 ActivationKey: ActivationKey;
589 /**
590 * The name you configured for your gateway.
591 */
592 GatewayName: GatewayName;
593 /**
594 * 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.
595 */
596 GatewayTimezone: GatewayTimezone;
597 /**
598 * A value that indicates the region where you want to store your data. The gateway region specified must be the same region as the region in your Host header in the request. For more information about available 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.
599 */
600 GatewayRegion: RegionId;
601 /**
602 * 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"
603 */
604 GatewayType?: GatewayType;
605 /**
606 * The value that indicates the type of tape drive to use for tape gateway. This field is optional. Valid Values: "IBM-ULT3580-TD5"
607 */
608 TapeDriveType?: TapeDriveType;
609 /**
610 * 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"
611 */
612 MediumChangerType?: MediumChangerType;
613 /**
614 * A list of up to ten (10) tags assigned to the gateway may be specified. Every 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.
615 */
616 Tags?: Tags;
617 }
618 export interface ActivateGatewayOutput {
619 GatewayARN?: GatewayARN;
620 }
621 export type ActivationKey = string;
622 export interface AddCacheInput {
623 GatewayARN: GatewayARN;
624 /**
625 * 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.
626 */
627 DiskIds: DiskIds;
628 }
629 export interface AddCacheOutput {
630 GatewayARN?: GatewayARN;
631 }
632 export interface AddTagsToResourceInput {
633 /**
634 * The Amazon Resource Name (ARN) of the resource you want to add tags to.
635 */
636 ResourceARN: ResourceARN;
637 /**
638 * 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.
639 */
640 Tags: Tags;
641 }
642 export interface AddTagsToResourceOutput {
643 /**
644 * The Amazon Resource Name (ARN) of the resource you want to add tags to.
645 */
646 ResourceARN?: ResourceARN;
647 }
648 export interface AddUploadBufferInput {
649 GatewayARN: GatewayARN;
650 /**
651 * 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.
652 */
653 DiskIds: DiskIds;
654 }
655 export interface AddUploadBufferOutput {
656 GatewayARN?: GatewayARN;
657 }
658 export interface AddWorkingStorageInput {
659 GatewayARN: GatewayARN;
660 /**
661 * 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.
662 */
663 DiskIds: DiskIds;
664 }
665 export interface AddWorkingStorageOutput {
666 GatewayARN?: GatewayARN;
667 }
668 export interface AttachVolumeInput {
669 /**
670 * The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to.
671 */
672 GatewayARN: GatewayARN;
673 /**
674 * 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.
675 */
676 TargetName?: TargetName;
677 /**
678 * The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.
679 */
680 VolumeARN: VolumeARN;
681 /**
682 * 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.
683 */
684 NetworkInterfaceId: NetworkInterfaceId;
685 /**
686 * 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.
687 */
688 DiskId?: DiskId;
689 }
690 export interface AttachVolumeOutput {
691 /**
692 * The Amazon Resource Name (ARN) of the volume that was attached to the gateway.
693 */
694 VolumeARN?: VolumeARN;
695 /**
696 * 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.
697 */
698 TargetARN?: TargetARN;
699 }
700 export type Authentication = string;
701 export type BandwidthDownloadRateLimit = number;
702 export type BandwidthType = string;
703 export type BandwidthUploadRateLimit = number;
704 export type Boolean = boolean;
705 export interface CachediSCSIVolume {
706 /**
707 * The Amazon Resource Name (ARN) of the storage volume.
708 */
709 VolumeARN?: VolumeARN;
710 /**
711 * The unique identifier of the volume, e.g. vol-AE4B946D.
712 */
713 VolumeId?: VolumeId;
714 /**
715 * One of the VolumeType enumeration values that describes the type of the volume.
716 */
717 VolumeType?: VolumeType;
718 /**
719 * One of the VolumeStatus values that indicates the state of the storage volume.
720 */
721 VolumeStatus?: VolumeStatus;
722 /**
723 * 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.
724 */
725 VolumeAttachmentStatus?: VolumeAttachmentStatus;
726 /**
727 * The size, in bytes, of the volume capacity.
728 */
729 VolumeSizeInBytes?: long;
730 /**
731 * 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.
732 */
733 VolumeProgress?: DoubleObject;
734 /**
735 * 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.
736 */
737 SourceSnapshotId?: SnapshotId;
738 /**
739 * An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
740 */
741 VolumeiSCSIAttributes?: VolumeiSCSIAttributes;
742 /**
743 * The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp.
744 */
745 CreatedDate?: CreatedDate;
746 /**
747 * 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.
748 */
749 VolumeUsedInBytes?: VolumeUsedInBytes;
750 KMSKey?: KMSKey;
751 /**
752 * 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.
753 */
754 TargetName?: TargetName;
755 }
756 export type CachediSCSIVolumes = CachediSCSIVolume[];
757 export interface CancelArchivalInput {
758 GatewayARN: GatewayARN;
759 /**
760 * The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving for.
761 */
762 TapeARN: TapeARN;
763 }
764 export interface CancelArchivalOutput {
765 /**
766 * The Amazon Resource Name (ARN) of the virtual tape for which archiving was canceled.
767 */
768 TapeARN?: TapeARN;
769 }
770 export interface CancelRetrievalInput {
771 GatewayARN: GatewayARN;
772 /**
773 * The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.
774 */
775 TapeARN: TapeARN;
776 }
777 export interface CancelRetrievalOutput {
778 /**
779 * The Amazon Resource Name (ARN) of the virtual tape for which retrieval was canceled.
780 */
781 TapeARN?: TapeARN;
782 }
783 export type ChapCredentials = ChapInfo[];
784 export interface ChapInfo {
785 /**
786 * The Amazon Resource Name (ARN) of the volume. Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
787 */
788 TargetARN?: TargetARN;
789 /**
790 * The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.
791 */
792 SecretToAuthenticateInitiator?: ChapSecret;
793 /**
794 * The iSCSI initiator that connects to the target.
795 */
796 InitiatorName?: IqnName;
797 /**
798 * The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
799 */
800 SecretToAuthenticateTarget?: ChapSecret;
801 }
802 export type ChapSecret = string;
803 export type ClientToken = string;
804 export interface CreateCachediSCSIVolumeInput {
805 GatewayARN: GatewayARN;
806 /**
807 * The size of the volume in bytes.
808 */
809 VolumeSizeInBytes: long;
810 /**
811 * 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.
812 */
813 SnapshotId?: SnapshotId;
814 /**
815 * 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.
816 */
817 TargetName: TargetName;
818 /**
819 * 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.
820 */
821 SourceVolumeARN?: VolumeARN;
822 /**
823 * 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.
824 */
825 NetworkInterfaceId: NetworkInterfaceId;
826 /**
827 * 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.
828 */
829 ClientToken: ClientToken;
830 /**
831 * 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.
832 */
833 KMSEncrypted?: Boolean;
834 /**
835 * 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.
836 */
837 KMSKey?: KMSKey;
838 }
839 export interface CreateCachediSCSIVolumeOutput {
840 /**
841 * The Amazon Resource Name (ARN) of the configured volume.
842 */
843 VolumeARN?: VolumeARN;
844 /**
845 * The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target.
846 */
847 TargetARN?: TargetARN;
848 }
849 export interface CreateNFSFileShareInput {
850 /**
851 * A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
852 */
853 ClientToken: ClientToken;
854 /**
855 * File share default values. Optional.
856 */
857 NFSFileShareDefaults?: NFSFileShareDefaults;
858 /**
859 * The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
860 */
861 GatewayARN: GatewayARN;
862 /**
863 * 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.
864 */
865 KMSEncrypted?: Boolean;
866 /**
867 * 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.
868 */
869 KMSKey?: KMSKey;
870 /**
871 * The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
872 */
873 Role: Role;
874 /**
875 * The ARN of the backed storage used for storing file data.
876 */
877 LocationARN: LocationARN;
878 /**
879 * 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.
880 */
881 DefaultStorageClass?: StorageClass;
882 /**
883 * 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".
884 */
885 ObjectACL?: ObjectACL;
886 /**
887 * The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.
888 */
889 ClientList?: FileShareClientList;
890 /**
891 * 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.
892 */
893 Squash?: Squash;
894 /**
895 * 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.
896 */
897 ReadOnly?: Boolean;
898 /**
899 * 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.
900 */
901 GuessMIMETypeEnabled?: Boolean;
902 /**
903 * A value that sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into. The default value is private.
904 */
905 RequesterPays?: Boolean;
906 /**
907 * A list of up to ten (10) tags can be assigned to the NFS file share. Every 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.
908 */
909 Tags?: Tags;
910 }
911 export interface CreateNFSFileShareOutput {
912 /**
913 * The Amazon Resource Name (ARN) of the newly created file share.
914 */
915 FileShareARN?: FileShareARN;
916 }
917 export interface CreateSMBFileShareInput {
918 /**
919 * A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
920 */
921 ClientToken: ClientToken;
922 /**
923 * The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
924 */
925 GatewayARN: GatewayARN;
926 /**
927 * 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.
928 */
929 KMSEncrypted?: Boolean;
930 /**
931 * 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.
932 */
933 KMSKey?: KMSKey;
934 /**
935 * The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
936 */
937 Role: Role;
938 /**
939 * The ARN of the backed storage used for storing file data.
940 */
941 LocationARN: LocationARN;
942 /**
943 * 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.
944 */
945 DefaultStorageClass?: StorageClass;
946 /**
947 * 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".
948 */
949 ObjectACL?: ObjectACL;
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 the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into. The default value is private.
960 */
961 RequesterPays?: Boolean;
962 /**
963 * 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.
964 */
965 ValidUserList?: FileShareUserList;
966 /**
967 * 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.
968 */
969 InvalidUserList?: FileShareUserList;
970 /**
971 * The authentication method that users use to access the file share. Valid values are ActiveDirectory or GuestAccess. The default is ActiveDirectory.
972 */
973 Authentication?: Authentication;
974 /**
975 * A list of up to ten (10) tags can be assigned to the NFS file share. Every 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.
976 */
977 Tags?: Tags;
978 }
979 export interface CreateSMBFileShareOutput {
980 /**
981 * The Amazon Resource Name (ARN) of the newly created file share.
982 */
983 FileShareARN?: FileShareARN;
984 }
985 export interface CreateSnapshotFromVolumeRecoveryPointInput {
986 /**
987 * The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
988 */
989 VolumeARN: VolumeARN;
990 /**
991 * 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
992 */
993 SnapshotDescription: SnapshotDescription;
994 }
995 export interface CreateSnapshotFromVolumeRecoveryPointOutput {
996 /**
997 * The ID of the snapshot.
998 */
999 SnapshotId?: SnapshotId;
1000 /**
1001 * The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
1002 */
1003 VolumeARN?: VolumeARN;
1004 /**
1005 * The time the volume was created from the recovery point.
1006 */
1007 VolumeRecoveryPointTime?: string;
1008 }
1009 export interface CreateSnapshotInput {
1010 /**
1011 * The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
1012 */
1013 VolumeARN: VolumeARN;
1014 /**
1015 * 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
1016 */
1017 SnapshotDescription: SnapshotDescription;
1018 }
1019 export interface CreateSnapshotOutput {
1020 /**
1021 * The Amazon Resource Name (ARN) of the volume of which the snapshot was taken.
1022 */
1023 VolumeARN?: VolumeARN;
1024 /**
1025 * 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).
1026 */
1027 SnapshotId?: SnapshotId;
1028 }
1029 export interface CreateStorediSCSIVolumeInput {
1030 GatewayARN: GatewayARN;
1031 /**
1032 * The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.
1033 */
1034 DiskId: DiskId;
1035 /**
1036 * 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.
1037 */
1038 SnapshotId?: SnapshotId;
1039 /**
1040 * 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
1041 */
1042 PreserveExistingData: boolean;
1043 /**
1044 * 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.
1045 */
1046 TargetName: TargetName;
1047 /**
1048 * 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.
1049 */
1050 NetworkInterfaceId: NetworkInterfaceId;
1051 /**
1052 * 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.
1053 */
1054 KMSEncrypted?: Boolean;
1055 /**
1056 * 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.
1057 */
1058 KMSKey?: KMSKey;
1059 }
1060 export interface CreateStorediSCSIVolumeOutput {
1061 /**
1062 * The Amazon Resource Name (ARN) of the configured volume.
1063 */
1064 VolumeARN?: VolumeARN;
1065 /**
1066 * The size of the volume in bytes.
1067 */
1068 VolumeSizeInBytes?: long;
1069 /**
1070 * The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target.
1071 */
1072 TargetARN?: TargetARN;
1073 }
1074 export interface CreateTapeWithBarcodeInput {
1075 /**
1076 * 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 region.
1077 */
1078 GatewayARN: GatewayARN;
1079 /**
1080 * The size, in bytes, of the virtual tape that you want to create. The size must be aligned by gigabyte (1024*1024*1024 byte).
1081 */
1082 TapeSizeInBytes: TapeSize;
1083 /**
1084 * The barcode that you want to assign to the tape. Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.
1085 */
1086 TapeBarcode: TapeBarcode;
1087 /**
1088 * 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.
1089 */
1090 KMSEncrypted?: Boolean;
1091 /**
1092 * 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.
1093 */
1094 KMSKey?: KMSKey;
1095 }
1096 export interface CreateTapeWithBarcodeOutput {
1097 /**
1098 * A unique Amazon Resource Name (ARN) that represents the virtual tape that was created.
1099 */
1100 TapeARN?: TapeARN;
1101 }
1102 export interface CreateTapesInput {
1103 /**
1104 * 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 region.
1105 */
1106 GatewayARN: GatewayARN;
1107 /**
1108 * The size, in bytes, of the virtual tapes that you want to create. The size must be aligned by gigabyte (1024*1024*1024 byte).
1109 */
1110 TapeSizeInBytes: TapeSize;
1111 /**
1112 * 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.
1113 */
1114 ClientToken: ClientToken;
1115 /**
1116 * The number of virtual tapes that you want to create.
1117 */
1118 NumTapesToCreate: NumTapesToCreate;
1119 /**
1120 * 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.
1121 */
1122 TapeBarcodePrefix: TapeBarcodePrefix;
1123 /**
1124 * 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.
1125 */
1126 KMSEncrypted?: Boolean;
1127 /**
1128 * 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.
1129 */
1130 KMSKey?: KMSKey;
1131 }
1132 export interface CreateTapesOutput {
1133 /**
1134 * A list of unique Amazon Resource Names (ARNs) that represents the virtual tapes that were created.
1135 */
1136 TapeARNs?: TapeARNs;
1137 }
1138 export type CreatedDate = Date;
1139 export type DayOfWeek = number;
1140 export interface DeleteBandwidthRateLimitInput {
1141 GatewayARN: GatewayARN;
1142 /**
1143 * One of the BandwidthType values that indicates the gateway bandwidth rate limit to delete. Valid Values: Upload, Download, All.
1144 */
1145 BandwidthType: BandwidthType;
1146 }
1147 export interface DeleteBandwidthRateLimitOutput {
1148 GatewayARN?: GatewayARN;
1149 }
1150 export interface DeleteChapCredentialsInput {
1151 /**
1152 * The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
1153 */
1154 TargetARN: TargetARN;
1155 /**
1156 * The iSCSI initiator that connects to the target.
1157 */
1158 InitiatorName: IqnName;
1159 }
1160 export interface DeleteChapCredentialsOutput {
1161 /**
1162 * The Amazon Resource Name (ARN) of the target.
1163 */
1164 TargetARN?: TargetARN;
1165 /**
1166 * The iSCSI initiator that connects to the target.
1167 */
1168 InitiatorName?: IqnName;
1169 }
1170 export interface DeleteFileShareInput {
1171 /**
1172 * The Amazon Resource Name (ARN) of the file share to be deleted.
1173 */
1174 FileShareARN: FileShareARN;
1175 /**
1176 * 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.
1177 */
1178 ForceDelete?: boolean;
1179 }
1180 export interface DeleteFileShareOutput {
1181 /**
1182 * The Amazon Resource Name (ARN) of the deleted file share.
1183 */
1184 FileShareARN?: FileShareARN;
1185 }
1186 export interface DeleteGatewayInput {
1187 GatewayARN: GatewayARN;
1188 }
1189 export interface DeleteGatewayOutput {
1190 GatewayARN?: GatewayARN;
1191 }
1192 export interface DeleteSnapshotScheduleInput {
1193 /**
1194 * The volume which snapshot schedule to delete.
1195 */
1196 VolumeARN: VolumeARN;
1197 }
1198 export interface DeleteSnapshotScheduleOutput {
1199 /**
1200 * The volume which snapshot schedule was deleted.
1201 */
1202 VolumeARN?: VolumeARN;
1203 }
1204 export interface DeleteTapeArchiveInput {
1205 /**
1206 * The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS).
1207 */
1208 TapeARN: TapeARN;
1209 }
1210 export interface DeleteTapeArchiveOutput {
1211 /**
1212 * The Amazon Resource Name (ARN) of the virtual tape that was deleted from the virtual tape shelf (VTS).
1213 */
1214 TapeARN?: TapeARN;
1215 }
1216 export interface DeleteTapeInput {
1217 /**
1218 * 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 region.
1219 */
1220 GatewayARN: GatewayARN;
1221 /**
1222 * The Amazon Resource Name (ARN) of the virtual tape to delete.
1223 */
1224 TapeARN: TapeARN;
1225 }
1226 export interface DeleteTapeOutput {
1227 /**
1228 * The Amazon Resource Name (ARN) of the deleted virtual tape.
1229 */
1230 TapeARN?: TapeARN;
1231 }
1232 export interface DeleteVolumeInput {
1233 /**
1234 * The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
1235 */
1236 VolumeARN: VolumeARN;
1237 }
1238 export interface DeleteVolumeOutput {
1239 /**
1240 * The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the request.
1241 */
1242 VolumeARN?: VolumeARN;
1243 }
1244 export interface DescribeBandwidthRateLimitInput {
1245 GatewayARN: GatewayARN;
1246 }
1247 export interface DescribeBandwidthRateLimitOutput {
1248 GatewayARN?: GatewayARN;
1249 /**
1250 * 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.
1251 */
1252 AverageUploadRateLimitInBitsPerSec?: BandwidthUploadRateLimit;
1253 /**
1254 * 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.
1255 */
1256 AverageDownloadRateLimitInBitsPerSec?: BandwidthDownloadRateLimit;
1257 }
1258 export interface DescribeCacheInput {
1259 GatewayARN: GatewayARN;
1260 }
1261 export interface DescribeCacheOutput {
1262 GatewayARN?: GatewayARN;
1263 /**
1264 * 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.
1265 */
1266 DiskIds?: DiskIds;
1267 /**
1268 * The amount of cache in bytes allocated to the a gateway.
1269 */
1270 CacheAllocatedInBytes?: long;
1271 /**
1272 * 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.
1273 */
1274 CacheUsedPercentage?: double;
1275 /**
1276 * 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.
1277 */
1278 CacheDirtyPercentage?: double;
1279 /**
1280 * 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.
1281 */
1282 CacheHitPercentage?: double;
1283 /**
1284 *
1285 */
1286 CacheMissPercentage?: double;
1287 }
1288 export interface DescribeCachediSCSIVolumesInput {
1289 /**
1290 * 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.
1291 */
1292 VolumeARNs: VolumeARNs;
1293 }
1294 export interface DescribeCachediSCSIVolumesOutput {
1295 /**
1296 * An array of objects where each object contains metadata about one cached volume.
1297 */
1298 CachediSCSIVolumes?: CachediSCSIVolumes;
1299 }
1300 export interface DescribeChapCredentialsInput {
1301 /**
1302 * The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
1303 */
1304 TargetARN: TargetARN;
1305 }
1306 export interface DescribeChapCredentialsOutput {
1307 /**
1308 * 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.
1309 */
1310 ChapCredentials?: ChapCredentials;
1311 }
1312 export interface DescribeGatewayInformationInput {
1313 GatewayARN: GatewayARN;
1314 }
1315 export interface DescribeGatewayInformationOutput {
1316 GatewayARN?: GatewayARN;
1317 /**
1318 * 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.
1319 */
1320 GatewayId?: GatewayId;
1321 /**
1322 * The name you configured for your gateway.
1323 */
1324 GatewayName?: string;
1325 /**
1326 * A value that indicates the time zone configured for the gateway.
1327 */
1328 GatewayTimezone?: GatewayTimezone;
1329 /**
1330 * A value that indicates the operating state of the gateway.
1331 */
1332 GatewayState?: GatewayState;
1333 /**
1334 * A NetworkInterface array that contains descriptions of the gateway network interfaces.
1335 */
1336 GatewayNetworkInterfaces?: GatewayNetworkInterfaces;
1337 /**
1338 * The type of the gateway.
1339 */
1340 GatewayType?: GatewayType;
1341 /**
1342 * 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.
1343 */
1344 NextUpdateAvailabilityDate?: NextUpdateAvailabilityDate;
1345 /**
1346 * 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.
1347 */
1348 LastSoftwareUpdate?: LastSoftwareUpdate;
1349 /**
1350 * A list of up to ten (10) tags assigned to the gateway are returned, sorted alphabetically by key name. Every tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API.
1351 */
1352 Tags?: Tags;
1353 }
1354 export interface DescribeMaintenanceStartTimeInput {
1355 GatewayARN: GatewayARN;
1356 }
1357 export interface DescribeMaintenanceStartTimeOutput {
1358 GatewayARN?: GatewayARN;
1359 /**
1360 * 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.
1361 */
1362 HourOfDay?: HourOfDay;
1363 /**
1364 * 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.
1365 */
1366 MinuteOfHour?: MinuteOfHour;
1367 /**
1368 * 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.
1369 */
1370 DayOfWeek?: DayOfWeek;
1371 /**
1372 * 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.
1373 */
1374 Timezone?: GatewayTimezone;
1375 }
1376 export interface DescribeNFSFileSharesInput {
1377 /**
1378 * An array containing the Amazon Resource Name (ARN) of each file share to be described.
1379 */
1380 FileShareARNList: FileShareARNList;
1381 }
1382 export interface DescribeNFSFileSharesOutput {
1383 /**
1384 * An array containing a description for each requested file share.
1385 */
1386 NFSFileShareInfoList?: NFSFileShareInfoList;
1387 }
1388 export interface DescribeSMBFileSharesInput {
1389 /**
1390 * An array containing the Amazon Resource Name (ARN) of each file share to be described.
1391 */
1392 FileShareARNList: FileShareARNList;
1393 }
1394 export interface DescribeSMBFileSharesOutput {
1395 /**
1396 * An array containing a description for each requested file share.
1397 */
1398 SMBFileShareInfoList?: SMBFileShareInfoList;
1399 }
1400 export interface DescribeSMBSettingsInput {
1401 GatewayARN: GatewayARN;
1402 }
1403 export interface DescribeSMBSettingsOutput {
1404 GatewayARN?: GatewayARN;
1405 /**
1406 * The name of the domain that the gateway is joined to.
1407 */
1408 DomainName?: DomainName;
1409 /**
1410 * This value is true if a password for the guest user “smbguest” is set, and otherwise false.
1411 */
1412 SMBGuestPasswordSet?: Boolean;
1413 }
1414 export interface DescribeSnapshotScheduleInput {
1415 /**
1416 * The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
1417 */
1418 VolumeARN: VolumeARN;
1419 }
1420 export interface DescribeSnapshotScheduleOutput {
1421 /**
1422 * The Amazon Resource Name (ARN) of the volume that was specified in the request.
1423 */
1424 VolumeARN?: VolumeARN;
1425 /**
1426 * 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.
1427 */
1428 StartAt?: HourOfDay;
1429 /**
1430 * The number of hours between snapshots.
1431 */
1432 RecurrenceInHours?: RecurrenceInHours;
1433 /**
1434 * The snapshot description.
1435 */
1436 Description?: Description;
1437 /**
1438 * A value that indicates the time zone of the gateway.
1439 */
1440 Timezone?: GatewayTimezone;
1441 }
1442 export interface DescribeStorediSCSIVolumesInput {
1443 /**
1444 * 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.
1445 */
1446 VolumeARNs: VolumeARNs;
1447 }
1448 export interface DescribeStorediSCSIVolumesOutput {
1449 /**
1450 * 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.
1451 */
1452 StorediSCSIVolumes?: StorediSCSIVolumes;
1453 }
1454 export interface DescribeTapeArchivesInput {
1455 /**
1456 * Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.
1457 */
1458 TapeARNs?: TapeARNs;
1459 /**
1460 * An opaque string that indicates the position at which to begin describing virtual tapes.
1461 */
1462 Marker?: Marker;
1463 /**
1464 * Specifies that the number of virtual tapes descried be limited to the specified number.
1465 */
1466 Limit?: PositiveIntObject;
1467 }
1468 export interface DescribeTapeArchivesOutput {
1469 /**
1470 * 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.
1471 */
1472 TapeArchives?: TapeArchives;
1473 /**
1474 * 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.
1475 */
1476 Marker?: Marker;
1477 }
1478 export interface DescribeTapeRecoveryPointsInput {
1479 GatewayARN: GatewayARN;
1480 /**
1481 * An opaque string that indicates the position at which to begin describing the virtual tape recovery points.
1482 */
1483 Marker?: Marker;
1484 /**
1485 * Specifies that the number of virtual tape recovery points that are described be limited to the specified number.
1486 */
1487 Limit?: PositiveIntObject;
1488 }
1489 export interface DescribeTapeRecoveryPointsOutput {
1490 GatewayARN?: GatewayARN;
1491 /**
1492 * An array of TapeRecoveryPointInfos that are available for the specified gateway.
1493 */
1494 TapeRecoveryPointInfos?: TapeRecoveryPointInfos;
1495 /**
1496 * 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.
1497 */
1498 Marker?: Marker;
1499 }
1500 export interface DescribeTapesInput {
1501 GatewayARN: GatewayARN;
1502 /**
1503 * 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.
1504 */
1505 TapeARNs?: TapeARNs;
1506 /**
1507 * 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.
1508 */
1509 Marker?: Marker;
1510 /**
1511 * 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.
1512 */
1513 Limit?: PositiveIntObject;
1514 }
1515 export interface DescribeTapesOutput {
1516 /**
1517 * An array of virtual tape descriptions.
1518 */
1519 Tapes?: Tapes;
1520 /**
1521 * 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.
1522 */
1523 Marker?: Marker;
1524 }
1525 export interface DescribeUploadBufferInput {
1526 GatewayARN: GatewayARN;
1527 }
1528 export interface DescribeUploadBufferOutput {
1529 GatewayARN?: GatewayARN;
1530 /**
1531 * 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.
1532 */
1533 DiskIds?: DiskIds;
1534 /**
1535 * The total number of bytes being used in the gateway's upload buffer.
1536 */
1537 UploadBufferUsedInBytes?: long;
1538 /**
1539 * The total number of bytes allocated in the gateway's as upload buffer.
1540 */
1541 UploadBufferAllocatedInBytes?: long;
1542 }
1543 export interface DescribeVTLDevicesInput {
1544 GatewayARN: GatewayARN;
1545 /**
1546 * 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.
1547 */
1548 VTLDeviceARNs?: VTLDeviceARNs;
1549 /**
1550 * An opaque string that indicates the position at which to begin describing the VTL devices.
1551 */
1552 Marker?: Marker;
1553 /**
1554 * Specifies that the number of VTL devices described be limited to the specified number.
1555 */
1556 Limit?: PositiveIntObject;
1557 }
1558 export interface DescribeVTLDevicesOutput {
1559 GatewayARN?: GatewayARN;
1560 /**
1561 * An array of VTL device objects composed of the Amazon Resource Name(ARN) of the VTL devices.
1562 */
1563 VTLDevices?: VTLDevices;
1564 /**
1565 * 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.
1566 */
1567 Marker?: Marker;
1568 }
1569 export interface DescribeWorkingStorageInput {
1570 GatewayARN: GatewayARN;
1571 }
1572 export interface DescribeWorkingStorageOutput {
1573 GatewayARN?: GatewayARN;
1574 /**
1575 * 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.
1576 */
1577 DiskIds?: DiskIds;
1578 /**
1579 * The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0.
1580 */
1581 WorkingStorageUsedInBytes?: long;
1582 /**
1583 * The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0.
1584 */
1585 WorkingStorageAllocatedInBytes?: long;
1586 }
1587 export type Description = string;
1588 export interface DetachVolumeInput {
1589 /**
1590 * The Amazon Resource Name (ARN) of the volume to detach from the gateway.
1591 */
1592 VolumeARN: VolumeARN;
1593 /**
1594 * 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.
1595 */
1596 ForceDetach?: Boolean;
1597 }
1598 export interface DetachVolumeOutput {
1599 /**
1600 * The Amazon Resource Name (ARN) of the volume that was detached.
1601 */
1602 VolumeARN?: VolumeARN;
1603 }
1604 export type DeviceType = string;
1605 export interface DeviceiSCSIAttributes {
1606 /**
1607 * Specifies the unique Amazon Resource Name (ARN) that encodes the iSCSI qualified name(iqn) of a tape drive or media changer target.
1608 */
1609 TargetARN?: TargetARN;
1610 /**
1611 * The network interface identifier of the VTL device.
1612 */
1613 NetworkInterfaceId?: NetworkInterfaceId;
1614 /**
1615 * The port used to communicate with iSCSI VTL device targets.
1616 */
1617 NetworkInterfacePort?: integer;
1618 /**
1619 * Indicates whether mutual CHAP is enabled for the iSCSI target.
1620 */
1621 ChapEnabled?: boolean;
1622 }
1623 export interface DisableGatewayInput {
1624 GatewayARN: GatewayARN;
1625 }
1626 export interface DisableGatewayOutput {
1627 /**
1628 * The unique Amazon Resource Name (ARN) of the disabled gateway.
1629 */
1630 GatewayARN?: GatewayARN;
1631 }
1632 export interface Disk {
1633 /**
1634 * The unique device ID or other distinguishing data that identifies a local disk.
1635 */
1636 DiskId?: DiskId;
1637 /**
1638 * The path of a local disk in the gateway virtual machine (VM).
1639 */
1640 DiskPath?: string;
1641 /**
1642 * The device node of a local disk as assigned by the virtualization environment.
1643 */
1644 DiskNode?: string;
1645 /**
1646 * A value that represents the status of a local disk.
1647 */
1648 DiskStatus?: string;
1649 /**
1650 * The local disk size in bytes.
1651 */
1652 DiskSizeInBytes?: long;
1653 DiskAllocationType?: DiskAllocationType;
1654 /**
1655 * 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.
1656 */
1657 DiskAllocationResource?: string;
1658 DiskAttributeList?: DiskAttributeList;
1659 }
1660 export type DiskAllocationType = string;
1661 export type DiskAttribute = string;
1662 export type DiskAttributeList = DiskAttribute[];
1663 export type DiskId = string;
1664 export type DiskIds = DiskId[];
1665 export type Disks = Disk[];
1666 export type DomainName = string;
1667 export type DomainUserName = string;
1668 export type DomainUserPassword = string;
1669 export type DoubleObject = number;
1670 export type FileShareARN = string;
1671 export type FileShareARNList = FileShareARN[];
1672 export type FileShareClientList = IPV4AddressCIDR[];
1673 export type FileShareId = string;
1674 export interface FileShareInfo {
1675 FileShareType?: FileShareType;
1676 FileShareARN?: FileShareARN;
1677 FileShareId?: FileShareId;
1678 FileShareStatus?: FileShareStatus;
1679 GatewayARN?: GatewayARN;
1680 }
1681 export type FileShareInfoList = FileShareInfo[];
1682 export type FileShareStatus = string;
1683 export type FileShareType = "NFS"|"SMB"|string;
1684 export type FileShareUser = string;
1685 export type FileShareUserList = FileShareUser[];
1686 export type Folder = string;
1687 export type FolderList = Folder[];
1688 export type GatewayARN = string;
1689 export type GatewayId = string;
1690 export interface GatewayInfo {
1691 /**
1692 * 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.
1693 */
1694 GatewayId?: GatewayId;
1695 /**
1696 * The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
1697 */
1698 GatewayARN?: GatewayARN;
1699 /**
1700 * The type of the gateway.
1701 */
1702 GatewayType?: GatewayType;
1703 /**
1704 * The state of the gateway. Valid Values: DISABLED or ACTIVE
1705 */
1706 GatewayOperationalState?: GatewayOperationalState;
1707 /**
1708 * The name of the gateway.
1709 */
1710 GatewayName?: string;
1711 }
1712 export type GatewayName = string;
1713 export type GatewayNetworkInterfaces = NetworkInterface[];
1714 export type GatewayOperationalState = string;
1715 export type GatewayState = string;
1716 export type GatewayTimezone = string;
1717 export type GatewayType = string;
1718 export type Gateways = GatewayInfo[];
1719 export type Host = string;
1720 export type Hosts = Host[];
1721 export type HourOfDay = number;
1722 export type IPV4AddressCIDR = string;
1723 export type Initiator = string;
1724 export type Initiators = Initiator[];
1725 export type IqnName = string;
1726 export interface JoinDomainInput {
1727 /**
1728 * The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
1729 */
1730 GatewayARN: GatewayARN;
1731 /**
1732 * The name of the domain that you want the gateway to join.
1733 */
1734 DomainName: DomainName;
1735 /**
1736 * The organizational unit (OU) is a container with 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.
1737 */
1738 OrganizationalUnit?: OrganizationalUnit;
1739 /**
1740 * 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.
1741 */
1742 DomainControllers?: Hosts;
1743 /**
1744 * Sets the user name of user who has permission to add the gateway to the Active Directory domain.
1745 */
1746 UserName: DomainUserName;
1747 /**
1748 * Sets the password of the user who has permission to add the gateway to the Active Directory domain.
1749 */
1750 Password: DomainUserPassword;
1751 }
1752 export interface JoinDomainOutput {
1753 /**
1754 * The unique Amazon Resource Name (ARN) of the gateway that joined the domain.
1755 */
1756 GatewayARN?: GatewayARN;
1757 }
1758 export type KMSKey = string;
1759 export type LastSoftwareUpdate = string;
1760 export interface ListFileSharesInput {
1761 /**
1762 * 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.
1763 */
1764 GatewayARN?: GatewayARN;
1765 /**
1766 * The maximum number of file shares to return in the response. The value must be an integer with a value greater than zero. Optional.
1767 */
1768 Limit?: PositiveIntObject;
1769 /**
1770 * 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.
1771 */
1772 Marker?: Marker;
1773 }
1774 export interface ListFileSharesOutput {
1775 /**
1776 * If the request includes Marker, the response returns that value in this field.
1777 */
1778 Marker?: Marker;
1779 /**
1780 * 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.
1781 */
1782 NextMarker?: Marker;
1783 /**
1784 * An array of information about the file gateway's file shares.
1785 */
1786 FileShareInfoList?: FileShareInfoList;
1787 }
1788 export interface ListGatewaysInput {
1789 /**
1790 * An opaque string that indicates the position at which to begin the returned list of gateways.
1791 */
1792 Marker?: Marker;
1793 /**
1794 * Specifies that the list of gateways returned be limited to the specified number of items.
1795 */
1796 Limit?: PositiveIntObject;
1797 }
1798 export interface ListGatewaysOutput {
1799 /**
1800 * An array of GatewayInfo objects.
1801 */
1802 Gateways?: Gateways;
1803 /**
1804 * 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.
1805 */
1806 Marker?: Marker;
1807 }
1808 export interface ListLocalDisksInput {
1809 GatewayARN: GatewayARN;
1810 }
1811 export interface ListLocalDisksOutput {
1812 GatewayARN?: GatewayARN;
1813 /**
1814 * A JSON object containing the following fields: ListLocalDisksOutput$Disks
1815 */
1816 Disks?: Disks;
1817 }
1818 export interface ListTagsForResourceInput {
1819 /**
1820 * The Amazon Resource Name (ARN) of the resource for which you want to list tags.
1821 */
1822 ResourceARN: ResourceARN;
1823 /**
1824 * An opaque string that indicates the position at which to begin returning the list of tags.
1825 */
1826 Marker?: Marker;
1827 /**
1828 * Specifies that the list of tags returned be limited to the specified number of items.
1829 */
1830 Limit?: PositiveIntObject;
1831 }
1832 export interface ListTagsForResourceOutput {
1833 /**
1834 * he Amazon Resource Name (ARN) of the resource for which you want to list tags.
1835 */
1836 ResourceARN?: ResourceARN;
1837 /**
1838 * An opaque string that indicates the position at which to stop returning the list of tags.
1839 */
1840 Marker?: Marker;
1841 /**
1842 * An array that contains the tags for the specified resource.
1843 */
1844 Tags?: Tags;
1845 }
1846 export interface ListTapesInput {
1847 TapeARNs?: TapeARNs;
1848 /**
1849 * A string that indicates the position at which to begin the returned list of tapes.
1850 */
1851 Marker?: Marker;
1852 /**
1853 * An optional number limit for the tapes in the list returned by this call.
1854 */
1855 Limit?: PositiveIntObject;
1856 }
1857 export interface ListTapesOutput {
1858 TapeInfos?: TapeInfos;
1859 /**
1860 * 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.
1861 */
1862 Marker?: Marker;
1863 }
1864 export interface ListVolumeInitiatorsInput {
1865 /**
1866 * The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes for the gateway.
1867 */
1868 VolumeARN: VolumeARN;
1869 }
1870 export interface ListVolumeInitiatorsOutput {
1871 /**
1872 * The host names and port numbers of all iSCSI initiators that are connected to the gateway.
1873 */
1874 Initiators?: Initiators;
1875 }
1876 export interface ListVolumeRecoveryPointsInput {
1877 GatewayARN: GatewayARN;
1878 }
1879 export interface ListVolumeRecoveryPointsOutput {
1880 GatewayARN?: GatewayARN;
1881 /**
1882 * An array of VolumeRecoveryPointInfo objects.
1883 */
1884 VolumeRecoveryPointInfos?: VolumeRecoveryPointInfos;
1885 }
1886 export interface ListVolumesInput {
1887 GatewayARN?: GatewayARN;
1888 /**
1889 * 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.
1890 */
1891 Marker?: Marker;
1892 /**
1893 * Specifies that the list of volumes returned be limited to the specified number of items.
1894 */
1895 Limit?: PositiveIntObject;
1896 }
1897 export interface ListVolumesOutput {
1898 GatewayARN?: GatewayARN;
1899 /**
1900 * 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.
1901 */
1902 Marker?: Marker;
1903 /**
1904 * 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 "[]".
1905 */
1906 VolumeInfos?: VolumeInfos;
1907 }
1908 export type LocalConsolePassword = string;
1909 export type LocationARN = string;
1910 export type Marker = string;
1911 export type MediumChangerType = string;
1912 export type MinuteOfHour = number;
1913 export interface NFSFileShareDefaults {
1914 /**
1915 * 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.
1916 */
1917 FileMode?: PermissionMode;
1918 /**
1919 * 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.
1920 */
1921 DirectoryMode?: PermissionMode;
1922 /**
1923 * The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody.
1924 */
1925 GroupId?: PermissionId;
1926 /**
1927 * The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody.
1928 */
1929 OwnerId?: PermissionId;
1930 }
1931 export interface NFSFileShareInfo {
1932 NFSFileShareDefaults?: NFSFileShareDefaults;
1933 FileShareARN?: FileShareARN;
1934 FileShareId?: FileShareId;
1935 FileShareStatus?: FileShareStatus;
1936 GatewayARN?: GatewayARN;
1937 /**
1938 * 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.
1939 */
1940 KMSEncrypted?: boolean;
1941 KMSKey?: KMSKey;
1942 Path?: Path;
1943 Role?: Role;
1944 LocationARN?: LocationARN;
1945 /**
1946 * 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.
1947 */
1948 DefaultStorageClass?: StorageClass;
1949 ObjectACL?: ObjectACL;
1950 ClientList?: FileShareClientList;
1951 Squash?: Squash;
1952 /**
1953 * 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.
1954 */
1955 ReadOnly?: Boolean;
1956 /**
1957 * 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.
1958 */
1959 GuessMIMETypeEnabled?: Boolean;
1960 /**
1961 * A value that sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into. The default value is private.
1962 */
1963 RequesterPays?: Boolean;
1964 /**
1965 * A list of up to ten (10) tags assigned to the NFS file share are returned, sorted alphabetically by key name. Every tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API.
1966 */
1967 Tags?: Tags;
1968 }
1969 export type NFSFileShareInfoList = NFSFileShareInfo[];
1970 export interface NetworkInterface {
1971 /**
1972 * The Internet Protocol version 4 (IPv4) address of the interface.
1973 */
1974 Ipv4Address?: string;
1975 /**
1976 * The Media Access Control (MAC) address of the interface. This is currently unsupported and will not be returned in output.
1977 */
1978 MacAddress?: string;
1979 /**
1980 * The Internet Protocol version 6 (IPv6) address of the interface. Currently not supported.
1981 */
1982 Ipv6Address?: string;
1983 }
1984 export type NetworkInterfaceId = string;
1985 export type NextUpdateAvailabilityDate = string;
1986 export type NotificationId = string;
1987 export interface NotifyWhenUploadedInput {
1988 FileShareARN: FileShareARN;
1989 }
1990 export interface NotifyWhenUploadedOutput {
1991 FileShareARN?: FileShareARN;
1992 NotificationId?: NotificationId;
1993 }
1994 export type NumTapesToCreate = number;
1995 export type ObjectACL = "private"|"public-read"|"public-read-write"|"authenticated-read"|"bucket-owner-read"|"bucket-owner-full-control"|"aws-exec-read"|string;
1996 export type OrganizationalUnit = string;
1997 export type Path = string;
1998 export type PermissionId = number;
1999 export type PermissionMode = string;
2000 export type PositiveIntObject = number;
2001 export type RecurrenceInHours = number;
2002 export interface RefreshCacheInput {
2003 /**
2004 * The Amazon Resource Name (ARN) of the file share you want to refresh.
2005 */
2006 FileShareARN: FileShareARN;
2007 /**
2008 * 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.
2009 */
2010 FolderList?: FolderList;
2011 /**
2012 * 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".
2013 */
2014 Recursive?: Boolean;
2015 }
2016 export interface RefreshCacheOutput {
2017 FileShareARN?: FileShareARN;
2018 NotificationId?: NotificationId;
2019 }
2020 export type RegionId = string;
2021 export interface RemoveTagsFromResourceInput {
2022 /**
2023 * The Amazon Resource Name (ARN) of the resource you want to remove the tags from.
2024 */
2025 ResourceARN: ResourceARN;
2026 /**
2027 * The keys of the tags you want to remove from the specified resource. A tag is composed of a key/value pair.
2028 */
2029 TagKeys: TagKeys;
2030 }
2031 export interface RemoveTagsFromResourceOutput {
2032 /**
2033 * The Amazon Resource Name (ARN) of the resource that the tags were removed from.
2034 */
2035 ResourceARN?: ResourceARN;
2036 }
2037 export interface ResetCacheInput {
2038 GatewayARN: GatewayARN;
2039 }
2040 export interface ResetCacheOutput {
2041 GatewayARN?: GatewayARN;
2042 }
2043 export type ResourceARN = string;
2044 export interface RetrieveTapeArchiveInput {
2045 /**
2046 * The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS).
2047 */
2048 TapeARN: TapeARN;
2049 /**
2050 * 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 region. You retrieve archived virtual tapes to only one gateway and the gateway must be a tape gateway.
2051 */
2052 GatewayARN: GatewayARN;
2053 }
2054 export interface RetrieveTapeArchiveOutput {
2055 /**
2056 * The Amazon Resource Name (ARN) of the retrieved virtual tape.
2057 */
2058 TapeARN?: TapeARN;
2059 }
2060 export interface RetrieveTapeRecoveryPointInput {
2061 /**
2062 * The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the recovery point.
2063 */
2064 TapeARN: TapeARN;
2065 GatewayARN: GatewayARN;
2066 }
2067 export interface RetrieveTapeRecoveryPointOutput {
2068 /**
2069 * The Amazon Resource Name (ARN) of the virtual tape for which the recovery point was retrieved.
2070 */
2071 TapeARN?: TapeARN;
2072 }
2073 export type Role = string;
2074 export interface SMBFileShareInfo {
2075 FileShareARN?: FileShareARN;
2076 FileShareId?: FileShareId;
2077 FileShareStatus?: FileShareStatus;
2078 GatewayARN?: GatewayARN;
2079 /**
2080 * 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.
2081 */
2082 KMSEncrypted?: boolean;
2083 KMSKey?: KMSKey;
2084 /**
2085 * The file share path used by the SMB client to identify the mount point.
2086 */
2087 Path?: Path;
2088 Role?: Role;
2089 LocationARN?: LocationARN;
2090 /**
2091 * 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.
2092 */
2093 DefaultStorageClass?: StorageClass;
2094 ObjectACL?: ObjectACL;
2095 /**
2096 * 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.
2097 */
2098 ReadOnly?: Boolean;
2099 /**
2100 * 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.
2101 */
2102 GuessMIMETypeEnabled?: Boolean;
2103 /**
2104 * A value that sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into. The default value is private.
2105 */
2106 RequesterPays?: Boolean;
2107 /**
2108 * 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.
2109 */
2110 ValidUserList?: FileShareUserList;
2111 /**
2112 * 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.
2113 */
2114 InvalidUserList?: FileShareUserList;
2115 Authentication?: Authentication;
2116 /**
2117 * A list of up to ten (10) tags assigned to the SMB file share are returned, sorted alphabetically by key name. Every tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API.
2118 */
2119 Tags?: Tags;
2120 }
2121 export type SMBFileShareInfoList = SMBFileShareInfo[];
2122 export type SMBGuestPassword = string;
2123 export interface SetLocalConsolePasswordInput {
2124 GatewayARN: GatewayARN;
2125 /**
2126 * The password you want to set for your VM local console.
2127 */
2128 LocalConsolePassword: LocalConsolePassword;
2129 }
2130 export interface SetLocalConsolePasswordOutput {
2131 GatewayARN?: GatewayARN;
2132 }
2133 export interface SetSMBGuestPasswordInput {
2134 /**
2135 * The Amazon Resource Name (ARN) of the file gateway the SMB file share is associated with.
2136 */
2137 GatewayARN: GatewayARN;
2138 /**
2139 * The password that you want to set for your SMB Server.
2140 */
2141 Password: SMBGuestPassword;
2142 }
2143 export interface SetSMBGuestPasswordOutput {
2144 GatewayARN?: GatewayARN;
2145 }
2146 export interface ShutdownGatewayInput {
2147 GatewayARN: GatewayARN;
2148 }
2149 export interface ShutdownGatewayOutput {
2150 GatewayARN?: GatewayARN;
2151 }
2152 export type SnapshotDescription = string;
2153 export type SnapshotId = string;
2154 export type Squash = string;
2155 export interface StartGatewayInput {
2156 GatewayARN: GatewayARN;
2157 }
2158 export interface StartGatewayOutput {
2159 GatewayARN?: GatewayARN;
2160 }
2161 export type StorageClass = string;
2162 export interface StorediSCSIVolume {
2163 /**
2164 * The Amazon Resource Name (ARN) of the storage volume.
2165 */
2166 VolumeARN?: VolumeARN;
2167 /**
2168 * The unique identifier of the volume, e.g. vol-AE4B946D.
2169 */
2170 VolumeId?: VolumeId;
2171 /**
2172 * One of the VolumeType enumeration values describing the type of the volume.
2173 */
2174 VolumeType?: VolumeType;
2175 /**
2176 * One of the VolumeStatus values that indicates the state of the storage volume.
2177 */
2178 VolumeStatus?: VolumeStatus;
2179 /**
2180 * 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.
2181 */
2182 VolumeAttachmentStatus?: VolumeAttachmentStatus;
2183 /**
2184 * The size of the volume in bytes.
2185 */
2186 VolumeSizeInBytes?: long;
2187 /**
2188 * 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.
2189 */
2190 VolumeProgress?: DoubleObject;
2191 /**
2192 * The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.
2193 */
2194 VolumeDiskId?: DiskId;
2195 /**
2196 * 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.
2197 */
2198 SourceSnapshotId?: SnapshotId;
2199 /**
2200 * Indicates if when the stored volume was created, existing data on the underlying local disk was preserved. Valid Values: true, false
2201 */
2202 PreservedExistingData?: boolean;
2203 /**
2204 * An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
2205 */
2206 VolumeiSCSIAttributes?: VolumeiSCSIAttributes;
2207 /**
2208 * The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp.
2209 */
2210 CreatedDate?: CreatedDate;
2211 /**
2212 * 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.
2213 */
2214 VolumeUsedInBytes?: VolumeUsedInBytes;
2215 KMSKey?: KMSKey;
2216 /**
2217 * 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.
2218 */
2219 TargetName?: TargetName;
2220 }
2221 export type StorediSCSIVolumes = StorediSCSIVolume[];
2222 export interface Tag {
2223 /**
2224 * Tag key (String). The key can't start with aws:.
2225 */
2226 Key: TagKey;
2227 /**
2228 * Value of the tag key.
2229 */
2230 Value: TagValue;
2231 }
2232 export type TagKey = string;
2233 export type TagKeys = TagKey[];
2234 export type TagValue = string;
2235 export type Tags = Tag[];
2236 export interface Tape {
2237 /**
2238 * The Amazon Resource Name (ARN) of the virtual tape.
2239 */
2240 TapeARN?: TapeARN;
2241 /**
2242 * The barcode that identifies a specific virtual tape.
2243 */
2244 TapeBarcode?: TapeBarcode;
2245 /**
2246 * The date the virtual tape was created.
2247 */
2248 TapeCreatedDate?: Time;
2249 /**
2250 * The size, in bytes, of the virtual tape capacity.
2251 */
2252 TapeSizeInBytes?: TapeSize;
2253 /**
2254 * The current state of the virtual tape.
2255 */
2256 TapeStatus?: TapeStatus;
2257 /**
2258 * The virtual tape library (VTL) device that the virtual tape is associated with.
2259 */
2260 VTLDevice?: VTLDeviceARN;
2261 /**
2262 * For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete. Range: 0 (not started) to 100 (complete).
2263 */
2264 Progress?: DoubleObject;
2265 /**
2266 * The size, in bytes, of data stored on the virtual tape. This value is not available for tapes created prior to May 13, 2015.
2267 */
2268 TapeUsedInBytes?: TapeUsage;
2269 KMSKey?: KMSKey;
2270 }
2271 export type TapeARN = string;
2272 export type TapeARNs = TapeARN[];
2273 export interface TapeArchive {
2274 /**
2275 * The Amazon Resource Name (ARN) of an archived virtual tape.
2276 */
2277 TapeARN?: TapeARN;
2278 /**
2279 * The barcode that identifies the archived virtual tape.
2280 */
2281 TapeBarcode?: TapeBarcode;
2282 /**
2283 * The date the virtual tape was created.
2284 */
2285 TapeCreatedDate?: Time;
2286 /**
2287 * The size, in bytes, of the archived virtual tape.
2288 */
2289 TapeSizeInBytes?: TapeSize;
2290 /**
2291 * 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.
2292 */
2293 CompletionTime?: Time;
2294 /**
2295 * 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).
2296 */
2297 RetrievedTo?: GatewayARN;
2298 /**
2299 * The current state of the archived virtual tape.
2300 */
2301 TapeStatus?: TapeArchiveStatus;
2302 /**
2303 * The size, in bytes, of data stored on the virtual tape. This value is not available for tapes created prior to May 13, 2015.
2304 */
2305 TapeUsedInBytes?: TapeUsage;
2306 KMSKey?: KMSKey;
2307 }
2308 export type TapeArchiveStatus = string;
2309 export type TapeArchives = TapeArchive[];
2310 export type TapeBarcode = string;
2311 export type TapeBarcodePrefix = string;
2312 export type TapeDriveType = string;
2313 export interface TapeInfo {
2314 /**
2315 * The Amazon Resource Name (ARN) of a virtual tape.
2316 */
2317 TapeARN?: TapeARN;
2318 /**
2319 * The barcode that identifies a specific virtual tape.
2320 */
2321 TapeBarcode?: TapeBarcode;
2322 /**
2323 * The size, in bytes, of a virtual tape.
2324 */
2325 TapeSizeInBytes?: TapeSize;
2326 /**
2327 * The status of the tape.
2328 */
2329 TapeStatus?: TapeStatus;
2330 /**
2331 * The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
2332 */
2333 GatewayARN?: GatewayARN;
2334 }
2335 export type TapeInfos = TapeInfo[];
2336 export interface TapeRecoveryPointInfo {
2337 /**
2338 * The Amazon Resource Name (ARN) of the virtual tape.
2339 */
2340 TapeARN?: TapeARN;
2341 /**
2342 * 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.
2343 */
2344 TapeRecoveryPointTime?: Time;
2345 /**
2346 * The size, in bytes, of the virtual tapes to recover.
2347 */
2348 TapeSizeInBytes?: TapeSize;
2349 /**
2350 * The status of the virtual tapes.
2351 */
2352 TapeStatus?: TapeRecoveryPointStatus;
2353 }
2354 export type TapeRecoveryPointInfos = TapeRecoveryPointInfo[];
2355 export type TapeRecoveryPointStatus = string;
2356 export type TapeSize = number;
2357 export type TapeStatus = string;
2358 export type TapeUsage = number;
2359 export type Tapes = Tape[];
2360 export type TargetARN = string;
2361 export type TargetName = string;
2362 export type Time = Date;
2363 export interface UpdateBandwidthRateLimitInput {
2364 GatewayARN: GatewayARN;
2365 /**
2366 * The average upload bandwidth rate limit in bits per second.
2367 */
2368 AverageUploadRateLimitInBitsPerSec?: BandwidthUploadRateLimit;
2369 /**
2370 * The average download bandwidth rate limit in bits per second.
2371 */
2372 AverageDownloadRateLimitInBitsPerSec?: BandwidthDownloadRateLimit;
2373 }
2374 export interface UpdateBandwidthRateLimitOutput {
2375 GatewayARN?: GatewayARN;
2376 }
2377 export interface UpdateChapCredentialsInput {
2378 /**
2379 * The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified VolumeARN.
2380 */
2381 TargetARN: TargetARN;
2382 /**
2383 * 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.
2384 */
2385 SecretToAuthenticateInitiator: ChapSecret;
2386 /**
2387 * The iSCSI initiator that connects to the target.
2388 */
2389 InitiatorName: IqnName;
2390 /**
2391 * 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.
2392 */
2393 SecretToAuthenticateTarget?: ChapSecret;
2394 }
2395 export interface UpdateChapCredentialsOutput {
2396 /**
2397 * The Amazon Resource Name (ARN) of the target. This is the same target specified in the request.
2398 */
2399 TargetARN?: TargetARN;
2400 /**
2401 * The iSCSI initiator that connects to the target. This is the same initiator name specified in the request.
2402 */
2403 InitiatorName?: IqnName;
2404 }
2405 export interface UpdateGatewayInformationInput {
2406 GatewayARN: GatewayARN;
2407 GatewayName?: GatewayName;
2408 /**
2409 * A value that indicates the time zone of the gateway.
2410 */
2411 GatewayTimezone?: GatewayTimezone;
2412 }
2413 export interface UpdateGatewayInformationOutput {
2414 GatewayARN?: GatewayARN;
2415 /**
2416 * The name you configured for your gateway.
2417 */
2418 GatewayName?: string;
2419 }
2420 export interface UpdateGatewaySoftwareNowInput {
2421 GatewayARN: GatewayARN;
2422 }
2423 export interface UpdateGatewaySoftwareNowOutput {
2424 GatewayARN?: GatewayARN;
2425 }
2426 export interface UpdateMaintenanceStartTimeInput {
2427 GatewayARN: GatewayARN;
2428 /**
2429 * 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.
2430 */
2431 HourOfDay: HourOfDay;
2432 /**
2433 * 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.
2434 */
2435 MinuteOfHour: MinuteOfHour;
2436 /**
2437 * The maintenance start time day of the week represented as an ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday.
2438 */
2439 DayOfWeek: DayOfWeek;
2440 }
2441 export interface UpdateMaintenanceStartTimeOutput {
2442 GatewayARN?: GatewayARN;
2443 }
2444 export interface UpdateNFSFileShareInput {
2445 /**
2446 * The Amazon Resource Name (ARN) of the file share to be updated.
2447 */
2448 FileShareARN: FileShareARN;
2449 /**
2450 * 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.
2451 */
2452 KMSEncrypted?: Boolean;
2453 /**
2454 * 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.
2455 */
2456 KMSKey?: KMSKey;
2457 /**
2458 * The default values for the file share. Optional.
2459 */
2460 NFSFileShareDefaults?: NFSFileShareDefaults;
2461 /**
2462 * 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.
2463 */
2464 DefaultStorageClass?: StorageClass;
2465 /**
2466 * 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".
2467 */
2468 ObjectACL?: ObjectACL;
2469 /**
2470 * The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.
2471 */
2472 ClientList?: FileShareClientList;
2473 /**
2474 * 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.
2475 */
2476 Squash?: Squash;
2477 /**
2478 * 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.
2479 */
2480 ReadOnly?: Boolean;
2481 /**
2482 * 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.
2483 */
2484 GuessMIMETypeEnabled?: Boolean;
2485 /**
2486 * A value that sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into. The default value is private.
2487 */
2488 RequesterPays?: Boolean;
2489 }
2490 export interface UpdateNFSFileShareOutput {
2491 /**
2492 * The Amazon Resource Name (ARN) of the updated file share.
2493 */
2494 FileShareARN?: FileShareARN;
2495 }
2496 export interface UpdateSMBFileShareInput {
2497 /**
2498 * The Amazon Resource Name (ARN) of the SMB file share that you want to update.
2499 */
2500 FileShareARN: FileShareARN;
2501 /**
2502 * 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.
2503 */
2504 KMSEncrypted?: Boolean;
2505 /**
2506 * 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.
2507 */
2508 KMSKey?: KMSKey;
2509 /**
2510 * 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.
2511 */
2512 DefaultStorageClass?: StorageClass;
2513 /**
2514 * 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".
2515 */
2516 ObjectACL?: ObjectACL;
2517 /**
2518 * 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.
2519 */
2520 ReadOnly?: Boolean;
2521 /**
2522 * 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.
2523 */
2524 GuessMIMETypeEnabled?: Boolean;
2525 /**
2526 * A value that sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into. The default value is private.
2527 */
2528 RequesterPays?: Boolean;
2529 /**
2530 * 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.
2531 */
2532 ValidUserList?: FileShareUserList;
2533 /**
2534 * 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.
2535 */
2536 InvalidUserList?: FileShareUserList;
2537 }
2538 export interface UpdateSMBFileShareOutput {
2539 /**
2540 * The Amazon Resource Name (ARN) of the updated SMB file share.
2541 */
2542 FileShareARN?: FileShareARN;
2543 }
2544 export interface UpdateSnapshotScheduleInput {
2545 /**
2546 * The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
2547 */
2548 VolumeARN: VolumeARN;
2549 /**
2550 * 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.
2551 */
2552 StartAt: HourOfDay;
2553 /**
2554 * Frequency of snapshots. Specify the number of hours between snapshots.
2555 */
2556 RecurrenceInHours: RecurrenceInHours;
2557 /**
2558 * Optional description of the snapshot that overwrites the existing description.
2559 */
2560 Description?: Description;
2561 }
2562 export interface UpdateSnapshotScheduleOutput {
2563 /**
2564 * The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
2565 */
2566 VolumeARN?: VolumeARN;
2567 }
2568 export interface UpdateVTLDeviceTypeInput {
2569 /**
2570 * The Amazon Resource Name (ARN) of the medium changer you want to select.
2571 */
2572 VTLDeviceARN: VTLDeviceARN;
2573 /**
2574 * The type of medium changer you want to select. Valid Values: "STK-L700", "AWS-Gateway-VTL"
2575 */
2576 DeviceType: DeviceType;
2577 }
2578 export interface UpdateVTLDeviceTypeOutput {
2579 /**
2580 * The Amazon Resource Name (ARN) of the medium changer you have selected.
2581 */
2582 VTLDeviceARN?: VTLDeviceARN;
2583 }
2584 export interface VTLDevice {
2585 /**
2586 * Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer).
2587 */
2588 VTLDeviceARN?: VTLDeviceARN;
2589 /**
2590 * Specifies the type of device that the VTL device emulates.
2591 */
2592 VTLDeviceType?: VTLDeviceType;
2593 /**
2594 * Specifies the vendor of the device that the VTL device object emulates.
2595 */
2596 VTLDeviceVendor?: VTLDeviceVendor;
2597 /**
2598 * Specifies the model number of device that the VTL device emulates.
2599 */
2600 VTLDeviceProductIdentifier?: VTLDeviceProductIdentifier;
2601 /**
2602 * A list of iSCSI information about a VTL device.
2603 */
2604 DeviceiSCSIAttributes?: DeviceiSCSIAttributes;
2605 }
2606 export type VTLDeviceARN = string;
2607 export type VTLDeviceARNs = VTLDeviceARN[];
2608 export type VTLDeviceProductIdentifier = string;
2609 export type VTLDeviceType = string;
2610 export type VTLDeviceVendor = string;
2611 export type VTLDevices = VTLDevice[];
2612 export type VolumeARN = string;
2613 export type VolumeARNs = VolumeARN[];
2614 export type VolumeAttachmentStatus = string;
2615 export type VolumeId = string;
2616 export interface VolumeInfo {
2617 /**
2618 * 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 (-).
2619 */
2620 VolumeARN?: VolumeARN;
2621 /**
2622 * 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 (-).
2623 */
2624 VolumeId?: VolumeId;
2625 GatewayARN?: GatewayARN;
2626 /**
2627 * 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 (-).
2628 */
2629 GatewayId?: GatewayId;
2630 /**
2631 * One of the VolumeType enumeration values describing the type of the volume.
2632 */
2633 VolumeType?: VolumeType;
2634 /**
2635 * The size of the volume in bytes. Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
2636 */
2637 VolumeSizeInBytes?: long;
2638 /**
2639 * One of the VolumeStatus values that indicates the state of the storage volume.
2640 */
2641 VolumeAttachmentStatus?: VolumeAttachmentStatus;
2642 }
2643 export type VolumeInfos = VolumeInfo[];
2644 export interface VolumeRecoveryPointInfo {
2645 /**
2646 * The Amazon Resource Name (ARN) of the volume target.
2647 */
2648 VolumeARN?: VolumeARN;
2649 /**
2650 * The size of the volume in bytes.
2651 */
2652 VolumeSizeInBytes?: long;
2653 /**
2654 * 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.
2655 */
2656 VolumeUsageInBytes?: long;
2657 /**
2658 * The time the recovery point was taken.
2659 */
2660 VolumeRecoveryPointTime?: string;
2661 }
2662 export type VolumeRecoveryPointInfos = VolumeRecoveryPointInfo[];
2663 export type VolumeStatus = string;
2664 export type VolumeType = string;
2665 export type VolumeUsedInBytes = number;
2666 export interface VolumeiSCSIAttributes {
2667 /**
2668 * The Amazon Resource Name (ARN) of the volume target.
2669 */
2670 TargetARN?: TargetARN;
2671 /**
2672 * The network interface identifier.
2673 */
2674 NetworkInterfaceId?: NetworkInterfaceId;
2675 /**
2676 * The port used to communicate with iSCSI targets.
2677 */
2678 NetworkInterfacePort?: integer;
2679 /**
2680 * The logical disk number.
2681 */
2682 LunNumber?: PositiveIntObject;
2683 /**
2684 * Indicates whether mutual CHAP is enabled for the iSCSI target.
2685 */
2686 ChapEnabled?: boolean;
2687 }
2688 export type double = number;
2689 export type integer = number;
2690 export type long = number;
2691 /**
2692 * 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.
2693 */
2694 export type apiVersion = "2013-06-30"|"latest"|string;
2695 export interface ClientApiVersions {
2696 /**
2697 * 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.
2698 */
2699 apiVersion?: apiVersion;
2700 }
2701 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
2702 /**
2703 * Contains interfaces for use with the StorageGateway client.
2704 */
2705 export import Types = StorageGateway;
2706}
2707export = StorageGateway;
2708
\No newline at end of file