storagegateway.d.ts (119918B)
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config'; 7 interface Blob {} 8 declare 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. For more information, see Activate the AWS Storage Gateway. In the activation process, you specify information such as the you want to use for storing snapshots, 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. For more information, see Activate the AWS Storage Gateway. In the activation process, you specify information such as the you want to use for storing snapshots, 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 cached-volume gateway. This operation is supported only for the gateway-cached volume architecture (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 cached-volume gateway. This operation is supported only for the gateway-cached volume architecture (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 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 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 both the gateway-stored and gateway-cached volume architectures. 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 both the gateway-stored and gateway-cached volume architectures. 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 supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes 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 supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes 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 * Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. 56 */ 57 cancelArchival(params: StorageGateway.Types.CancelArchivalInput, callback?: (err: AWSError, data: StorageGateway.Types.CancelArchivalOutput) => void): Request<StorageGateway.Types.CancelArchivalOutput, AWSError>; 58 /** 59 * Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. 60 */ 61 cancelArchival(callback?: (err: AWSError, data: StorageGateway.Types.CancelArchivalOutput) => void): Request<StorageGateway.Types.CancelArchivalOutput, AWSError>; 62 /** 63 * 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. 64 */ 65 cancelRetrieval(params: StorageGateway.Types.CancelRetrievalInput, callback?: (err: AWSError, data: StorageGateway.Types.CancelRetrievalOutput) => void): Request<StorageGateway.Types.CancelRetrievalOutput, AWSError>; 66 /** 67 * 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. 68 */ 69 cancelRetrieval(callback?: (err: AWSError, data: StorageGateway.Types.CancelRetrievalOutput) => void): Request<StorageGateway.Types.CancelRetrievalOutput, AWSError>; 70 /** 71 * Creates a cached volume on a specified cached gateway. This operation is supported only for the gateway-cached volume architecture. 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, AWS Storage Gateway creates the volume and returns information about it 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. 72 */ 73 createCachediSCSIVolume(params: StorageGateway.Types.CreateCachediSCSIVolumeInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateCachediSCSIVolumeOutput) => void): Request<StorageGateway.Types.CreateCachediSCSIVolumeOutput, AWSError>; 74 /** 75 * Creates a cached volume on a specified cached gateway. This operation is supported only for the gateway-cached volume architecture. 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, AWS Storage Gateway creates the volume and returns information about it 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. 76 */ 77 createCachediSCSIVolume(callback?: (err: AWSError, data: StorageGateway.Types.CreateCachediSCSIVolumeOutput) => void): Request<StorageGateway.Types.CreateCachediSCSIVolumeOutput, AWSError>; 78 /** 79 * 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 Working With Snapshots in the AWS Storage Gateway Console. 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. 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. 80 */ 81 createSnapshot(params: StorageGateway.Types.CreateSnapshotInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateSnapshotOutput) => void): Request<StorageGateway.Types.CreateSnapshotOutput, AWSError>; 82 /** 83 * 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 Working With Snapshots in the AWS Storage Gateway Console. 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. 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. 84 */ 85 createSnapshot(callback?: (err: AWSError, data: StorageGateway.Types.CreateSnapshotOutput) => void): Request<StorageGateway.Types.CreateSnapshotOutput, AWSError>; 86 /** 87 * Initiates a snapshot of a gateway from a volume recovery point. This operation is supported only for the gateway-cached volume architecture. 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 gateway-cached volumes, 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 AWS Storage Gateway takes a snapshot of the specified volume, the snapshot and its description appear 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. To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference. 88 */ 89 createSnapshotFromVolumeRecoveryPoint(params: StorageGateway.Types.CreateSnapshotFromVolumeRecoveryPointInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateSnapshotFromVolumeRecoveryPointOutput) => void): Request<StorageGateway.Types.CreateSnapshotFromVolumeRecoveryPointOutput, AWSError>; 90 /** 91 * Initiates a snapshot of a gateway from a volume recovery point. This operation is supported only for the gateway-cached volume architecture. 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 gateway-cached volumes, 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 AWS Storage Gateway takes a snapshot of the specified volume, the snapshot and its description appear 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. To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference. 92 */ 93 createSnapshotFromVolumeRecoveryPoint(callback?: (err: AWSError, data: StorageGateway.Types.CreateSnapshotFromVolumeRecoveryPointOutput) => void): Request<StorageGateway.Types.CreateSnapshotFromVolumeRecoveryPointOutput, AWSError>; 94 /** 95 * Creates a volume on a specified gateway. This operation is supported only for the gateway-stored volume architecture. 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, AWS Storage 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. 96 */ 97 createStorediSCSIVolume(params: StorageGateway.Types.CreateStorediSCSIVolumeInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateStorediSCSIVolumeOutput) => void): Request<StorageGateway.Types.CreateStorediSCSIVolumeOutput, AWSError>; 98 /** 99 * Creates a volume on a specified gateway. This operation is supported only for the gateway-stored volume architecture. 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, AWS Storage 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. 100 */ 101 createStorediSCSIVolume(callback?: (err: AWSError, data: StorageGateway.Types.CreateStorediSCSIVolumeOutput) => void): Request<StorageGateway.Types.CreateStorediSCSIVolumeOutput, AWSError>; 102 /** 103 * Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. 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. 104 */ 105 createTapeWithBarcode(params: StorageGateway.Types.CreateTapeWithBarcodeInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateTapeWithBarcodeOutput) => void): Request<StorageGateway.Types.CreateTapeWithBarcodeOutput, AWSError>; 106 /** 107 * Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. 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. 108 */ 109 createTapeWithBarcode(callback?: (err: AWSError, data: StorageGateway.Types.CreateTapeWithBarcodeOutput) => void): Request<StorageGateway.Types.CreateTapeWithBarcodeOutput, AWSError>; 110 /** 111 * Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. 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. 112 */ 113 createTapes(params: StorageGateway.Types.CreateTapesInput, callback?: (err: AWSError, data: StorageGateway.Types.CreateTapesOutput) => void): Request<StorageGateway.Types.CreateTapesOutput, AWSError>; 114 /** 115 * Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. 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. 116 */ 117 createTapes(callback?: (err: AWSError, data: StorageGateway.Types.CreateTapesOutput) => void): Request<StorageGateway.Types.CreateTapesOutput, AWSError>; 118 /** 119 * 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. 120 */ 121 deleteBandwidthRateLimit(params: StorageGateway.Types.DeleteBandwidthRateLimitInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteBandwidthRateLimitOutput) => void): Request<StorageGateway.Types.DeleteBandwidthRateLimitOutput, AWSError>; 122 /** 123 * 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. 124 */ 125 deleteBandwidthRateLimit(callback?: (err: AWSError, data: StorageGateway.Types.DeleteBandwidthRateLimitOutput) => void): Request<StorageGateway.Types.DeleteBandwidthRateLimitOutput, AWSError>; 126 /** 127 * Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair. 128 */ 129 deleteChapCredentials(params: StorageGateway.Types.DeleteChapCredentialsInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteChapCredentialsOutput) => void): Request<StorageGateway.Types.DeleteChapCredentialsOutput, AWSError>; 130 /** 131 * Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair. 132 */ 133 deleteChapCredentials(callback?: (err: AWSError, data: StorageGateway.Types.DeleteChapCredentialsOutput) => void): Request<StorageGateway.Types.DeleteChapCredentialsOutput, AWSError>; 134 /** 135 * 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. 136 */ 137 deleteGateway(params: StorageGateway.Types.DeleteGatewayInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteGatewayOutput) => void): Request<StorageGateway.Types.DeleteGatewayOutput, AWSError>; 138 /** 139 * 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. 140 */ 141 deleteGateway(callback?: (err: AWSError, data: StorageGateway.Types.DeleteGatewayOutput) => void): Request<StorageGateway.Types.DeleteGatewayOutput, AWSError>; 142 /** 143 * 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). To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference. 144 */ 145 deleteSnapshotSchedule(params: StorageGateway.Types.DeleteSnapshotScheduleInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteSnapshotScheduleOutput) => void): Request<StorageGateway.Types.DeleteSnapshotScheduleOutput, AWSError>; 146 /** 147 * 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). To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference. 148 */ 149 deleteSnapshotSchedule(callback?: (err: AWSError, data: StorageGateway.Types.DeleteSnapshotScheduleOutput) => void): Request<StorageGateway.Types.DeleteSnapshotScheduleOutput, AWSError>; 150 /** 151 * Deletes the specified virtual tape. 152 */ 153 deleteTape(params: StorageGateway.Types.DeleteTapeInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteTapeOutput) => void): Request<StorageGateway.Types.DeleteTapeOutput, AWSError>; 154 /** 155 * Deletes the specified virtual tape. 156 */ 157 deleteTape(callback?: (err: AWSError, data: StorageGateway.Types.DeleteTapeOutput) => void): Request<StorageGateway.Types.DeleteTapeOutput, AWSError>; 158 /** 159 * Deletes the specified virtual tape from the virtual tape shelf (VTS). 160 */ 161 deleteTapeArchive(params: StorageGateway.Types.DeleteTapeArchiveInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteTapeArchiveOutput) => void): Request<StorageGateway.Types.DeleteTapeArchiveOutput, AWSError>; 162 /** 163 * Deletes the specified virtual tape from the virtual tape shelf (VTS). 164 */ 165 deleteTapeArchive(callback?: (err: AWSError, data: StorageGateway.Types.DeleteTapeArchiveOutput) => void): Request<StorageGateway.Types.DeleteTapeArchiveOutput, AWSError>; 166 /** 167 * Deletes the specified gateway volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. For gateway-stored volumes, 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 gateway 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. 168 */ 169 deleteVolume(params: StorageGateway.Types.DeleteVolumeInput, callback?: (err: AWSError, data: StorageGateway.Types.DeleteVolumeOutput) => void): Request<StorageGateway.Types.DeleteVolumeOutput, AWSError>; 170 /** 171 * Deletes the specified gateway volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. For gateway-stored volumes, 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 gateway 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. 172 */ 173 deleteVolume(callback?: (err: AWSError, data: StorageGateway.Types.DeleteVolumeOutput) => void): Request<StorageGateway.Types.DeleteVolumeOutput, AWSError>; 174 /** 175 * 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. 176 */ 177 describeBandwidthRateLimit(params: StorageGateway.Types.DescribeBandwidthRateLimitInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeBandwidthRateLimitOutput) => void): Request<StorageGateway.Types.DescribeBandwidthRateLimitOutput, AWSError>; 178 /** 179 * 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. 180 */ 181 describeBandwidthRateLimit(callback?: (err: AWSError, data: StorageGateway.Types.DescribeBandwidthRateLimitOutput) => void): Request<StorageGateway.Types.DescribeBandwidthRateLimitOutput, AWSError>; 182 /** 183 * Returns information about the cache of a gateway. This operation is supported only for the gateway-cached volume architecture. The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used. 184 */ 185 describeCache(params: StorageGateway.Types.DescribeCacheInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeCacheOutput) => void): Request<StorageGateway.Types.DescribeCacheOutput, AWSError>; 186 /** 187 * Returns information about the cache of a gateway. This operation is supported only for the gateway-cached volume architecture. The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used. 188 */ 189 describeCache(callback?: (err: AWSError, data: StorageGateway.Types.DescribeCacheOutput) => void): Request<StorageGateway.Types.DescribeCacheOutput, AWSError>; 190 /** 191 * Returns a description of the gateway volumes specified in the request. This operation is supported only for the gateway-cached volume architecture. 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). 192 */ 193 describeCachediSCSIVolumes(params: StorageGateway.Types.DescribeCachediSCSIVolumesInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeCachediSCSIVolumesOutput) => void): Request<StorageGateway.Types.DescribeCachediSCSIVolumesOutput, AWSError>; 194 /** 195 * Returns a description of the gateway volumes specified in the request. This operation is supported only for the gateway-cached volume architecture. 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). 196 */ 197 describeCachediSCSIVolumes(callback?: (err: AWSError, data: StorageGateway.Types.DescribeCachediSCSIVolumesOutput) => void): Request<StorageGateway.Types.DescribeCachediSCSIVolumesOutput, AWSError>; 198 /** 199 * Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. 200 */ 201 describeChapCredentials(params: StorageGateway.Types.DescribeChapCredentialsInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeChapCredentialsOutput) => void): Request<StorageGateway.Types.DescribeChapCredentialsOutput, AWSError>; 202 /** 203 * Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. 204 */ 205 describeChapCredentials(callback?: (err: AWSError, data: StorageGateway.Types.DescribeChapCredentialsOutput) => void): Request<StorageGateway.Types.DescribeChapCredentialsOutput, AWSError>; 206 /** 207 * 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. 208 */ 209 describeGatewayInformation(params: StorageGateway.Types.DescribeGatewayInformationInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeGatewayInformationOutput) => void): Request<StorageGateway.Types.DescribeGatewayInformationOutput, AWSError>; 210 /** 211 * 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. 212 */ 213 describeGatewayInformation(callback?: (err: AWSError, data: StorageGateway.Types.DescribeGatewayInformationOutput) => void): Request<StorageGateway.Types.DescribeGatewayInformationOutput, AWSError>; 214 /** 215 * 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. 216 */ 217 describeMaintenanceStartTime(params: StorageGateway.Types.DescribeMaintenanceStartTimeInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeMaintenanceStartTimeOutput) => void): Request<StorageGateway.Types.DescribeMaintenanceStartTimeOutput, AWSError>; 218 /** 219 * 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. 220 */ 221 describeMaintenanceStartTime(callback?: (err: AWSError, data: StorageGateway.Types.DescribeMaintenanceStartTimeOutput) => void): Request<StorageGateway.Types.DescribeMaintenanceStartTimeOutput, AWSError>; 222 /** 223 * Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. 224 */ 225 describeSnapshotSchedule(params: StorageGateway.Types.DescribeSnapshotScheduleInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeSnapshotScheduleOutput) => void): Request<StorageGateway.Types.DescribeSnapshotScheduleOutput, AWSError>; 226 /** 227 * Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. 228 */ 229 describeSnapshotSchedule(callback?: (err: AWSError, data: StorageGateway.Types.DescribeSnapshotScheduleOutput) => void): Request<StorageGateway.Types.DescribeSnapshotScheduleOutput, AWSError>; 230 /** 231 * 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. 232 */ 233 describeStorediSCSIVolumes(params: StorageGateway.Types.DescribeStorediSCSIVolumesInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeStorediSCSIVolumesOutput) => void): Request<StorageGateway.Types.DescribeStorediSCSIVolumesOutput, AWSError>; 234 /** 235 * 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. 236 */ 237 describeStorediSCSIVolumes(callback?: (err: AWSError, data: StorageGateway.Types.DescribeStorediSCSIVolumesOutput) => void): Request<StorageGateway.Types.DescribeStorediSCSIVolumesOutput, AWSError>; 238 /** 239 * Returns a description of specified virtual tapes in the virtual tape shelf (VTS). 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. 240 */ 241 describeTapeArchives(params: StorageGateway.Types.DescribeTapeArchivesInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeTapeArchivesOutput) => void): Request<StorageGateway.Types.DescribeTapeArchivesOutput, AWSError>; 242 /** 243 * Returns a description of specified virtual tapes in the virtual tape shelf (VTS). 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. 244 */ 245 describeTapeArchives(callback?: (err: AWSError, data: StorageGateway.Types.DescribeTapeArchivesOutput) => void): Request<StorageGateway.Types.DescribeTapeArchivesOutput, AWSError>; 246 /** 247 * Returns a list of virtual tape recovery points that are available for the specified gateway-VTL. 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. 248 */ 249 describeTapeRecoveryPoints(params: StorageGateway.Types.DescribeTapeRecoveryPointsInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeTapeRecoveryPointsOutput) => void): Request<StorageGateway.Types.DescribeTapeRecoveryPointsOutput, AWSError>; 250 /** 251 * Returns a list of virtual tape recovery points that are available for the specified gateway-VTL. 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. 252 */ 253 describeTapeRecoveryPoints(callback?: (err: AWSError, data: StorageGateway.Types.DescribeTapeRecoveryPointsOutput) => void): Request<StorageGateway.Types.DescribeTapeRecoveryPointsOutput, AWSError>; 254 /** 255 * 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. 256 */ 257 describeTapes(params: StorageGateway.Types.DescribeTapesInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeTapesOutput) => void): Request<StorageGateway.Types.DescribeTapesOutput, AWSError>; 258 /** 259 * 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. 260 */ 261 describeTapes(callback?: (err: AWSError, data: StorageGateway.Types.DescribeTapesOutput) => void): Request<StorageGateway.Types.DescribeTapesOutput, AWSError>; 262 /** 263 * Returns information about the upload buffer of a gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures. The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used. 264 */ 265 describeUploadBuffer(params: StorageGateway.Types.DescribeUploadBufferInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeUploadBufferOutput) => void): Request<StorageGateway.Types.DescribeUploadBufferOutput, AWSError>; 266 /** 267 * Returns information about the upload buffer of a gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures. The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used. 268 */ 269 describeUploadBuffer(callback?: (err: AWSError, data: StorageGateway.Types.DescribeUploadBufferOutput) => void): Request<StorageGateway.Types.DescribeUploadBufferOutput, AWSError>; 270 /** 271 * Returns a description of virtual tape library (VTL) devices for the specified gateway. In the response, AWS Storage Gateway returns VTL device information. The list of VTL devices must be from one gateway. 272 */ 273 describeVTLDevices(params: StorageGateway.Types.DescribeVTLDevicesInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeVTLDevicesOutput) => void): Request<StorageGateway.Types.DescribeVTLDevicesOutput, AWSError>; 274 /** 275 * Returns a description of virtual tape library (VTL) devices for the specified gateway. In the response, AWS Storage Gateway returns VTL device information. The list of VTL devices must be from one gateway. 276 */ 277 describeVTLDevices(callback?: (err: AWSError, data: StorageGateway.Types.DescribeVTLDevicesOutput) => void): Request<StorageGateway.Types.DescribeVTLDevicesOutput, AWSError>; 278 /** 279 * Returns information about the working storage of a gateway. This operation is supported only for the gateway-stored volume architecture. 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. 280 */ 281 describeWorkingStorage(params: StorageGateway.Types.DescribeWorkingStorageInput, callback?: (err: AWSError, data: StorageGateway.Types.DescribeWorkingStorageOutput) => void): Request<StorageGateway.Types.DescribeWorkingStorageOutput, AWSError>; 282 /** 283 * Returns information about the working storage of a gateway. This operation is supported only for the gateway-stored volume architecture. 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. 284 */ 285 describeWorkingStorage(callback?: (err: AWSError, data: StorageGateway.Types.DescribeWorkingStorageOutput) => void): Request<StorageGateway.Types.DescribeWorkingStorageOutput, AWSError>; 286 /** 287 * Disables a 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 gateway-VTL that is not reachable or not functioning. Once a gateway is disabled it cannot be enabled. 288 */ 289 disableGateway(params: StorageGateway.Types.DisableGatewayInput, callback?: (err: AWSError, data: StorageGateway.Types.DisableGatewayOutput) => void): Request<StorageGateway.Types.DisableGatewayOutput, AWSError>; 290 /** 291 * Disables a 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 gateway-VTL that is not reachable or not functioning. Once a gateway is disabled it cannot be enabled. 292 */ 293 disableGateway(callback?: (err: AWSError, data: StorageGateway.Types.DisableGatewayOutput) => void): Request<StorageGateway.Types.DisableGatewayOutput, AWSError>; 294 /** 295 * 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. 296 */ 297 listGateways(params: StorageGateway.Types.ListGatewaysInput, callback?: (err: AWSError, data: StorageGateway.Types.ListGatewaysOutput) => void): Request<StorageGateway.Types.ListGatewaysOutput, AWSError>; 298 /** 299 * 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. 300 */ 301 listGateways(callback?: (err: AWSError, data: StorageGateway.Types.ListGatewaysOutput) => void): Request<StorageGateway.Types.ListGatewaysOutput, AWSError>; 302 /** 303 * 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). 304 */ 305 listLocalDisks(params: StorageGateway.Types.ListLocalDisksInput, callback?: (err: AWSError, data: StorageGateway.Types.ListLocalDisksOutput) => void): Request<StorageGateway.Types.ListLocalDisksOutput, AWSError>; 306 /** 307 * 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). 308 */ 309 listLocalDisks(callback?: (err: AWSError, data: StorageGateway.Types.ListLocalDisksOutput) => void): Request<StorageGateway.Types.ListLocalDisksOutput, AWSError>; 310 /** 311 * Lists the tags that have been added to the specified resource. 312 */ 313 listTagsForResource(params: StorageGateway.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: StorageGateway.Types.ListTagsForResourceOutput) => void): Request<StorageGateway.Types.ListTagsForResourceOutput, AWSError>; 314 /** 315 * Lists the tags that have been added to the specified resource. 316 */ 317 listTagsForResource(callback?: (err: AWSError, data: StorageGateway.Types.ListTagsForResourceOutput) => void): Request<StorageGateway.Types.ListTagsForResourceOutput, AWSError>; 318 /** 319 * 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. 320 */ 321 listTapes(params: StorageGateway.Types.ListTapesInput, callback?: (err: AWSError, data: StorageGateway.Types.ListTapesOutput) => void): Request<StorageGateway.Types.ListTapesOutput, AWSError>; 322 /** 323 * 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. 324 */ 325 listTapes(callback?: (err: AWSError, data: StorageGateway.Types.ListTapesOutput) => void): Request<StorageGateway.Types.ListTapesOutput, AWSError>; 326 /** 327 * Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. 328 */ 329 listVolumeInitiators(params: StorageGateway.Types.ListVolumeInitiatorsInput, callback?: (err: AWSError, data: StorageGateway.Types.ListVolumeInitiatorsOutput) => void): Request<StorageGateway.Types.ListVolumeInitiatorsOutput, AWSError>; 330 /** 331 * Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. 332 */ 333 listVolumeInitiators(callback?: (err: AWSError, data: StorageGateway.Types.ListVolumeInitiatorsOutput) => void): Request<StorageGateway.Types.ListVolumeInitiatorsOutput, AWSError>; 334 /** 335 * Lists the recovery points for a specified gateway. This operation is supported only for the gateway-cached volume architecture. Each gateway-cached 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. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation. 336 */ 337 listVolumeRecoveryPoints(params: StorageGateway.Types.ListVolumeRecoveryPointsInput, callback?: (err: AWSError, data: StorageGateway.Types.ListVolumeRecoveryPointsOutput) => void): Request<StorageGateway.Types.ListVolumeRecoveryPointsOutput, AWSError>; 338 /** 339 * Lists the recovery points for a specified gateway. This operation is supported only for the gateway-cached volume architecture. Each gateway-cached 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. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation. 340 */ 341 listVolumeRecoveryPoints(callback?: (err: AWSError, data: StorageGateway.Types.ListVolumeRecoveryPointsOutput) => void): Request<StorageGateway.Types.ListVolumeRecoveryPointsOutput, AWSError>; 342 /** 343 * 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 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. 344 */ 345 listVolumes(params: StorageGateway.Types.ListVolumesInput, callback?: (err: AWSError, data: StorageGateway.Types.ListVolumesOutput) => void): Request<StorageGateway.Types.ListVolumesOutput, AWSError>; 346 /** 347 * 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 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. 348 */ 349 listVolumes(callback?: (err: AWSError, data: StorageGateway.Types.ListVolumesOutput) => void): Request<StorageGateway.Types.ListVolumesOutput, AWSError>; 350 /** 351 * Removes one or more tags from the specified resource. 352 */ 353 removeTagsFromResource(params: StorageGateway.Types.RemoveTagsFromResourceInput, callback?: (err: AWSError, data: StorageGateway.Types.RemoveTagsFromResourceOutput) => void): Request<StorageGateway.Types.RemoveTagsFromResourceOutput, AWSError>; 354 /** 355 * Removes one or more tags from the specified resource. 356 */ 357 removeTagsFromResource(callback?: (err: AWSError, data: StorageGateway.Types.RemoveTagsFromResourceOutput) => void): Request<StorageGateway.Types.RemoveTagsFromResourceOutput, AWSError>; 358 /** 359 * 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. 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. 360 */ 361 resetCache(params: StorageGateway.Types.ResetCacheInput, callback?: (err: AWSError, data: StorageGateway.Types.ResetCacheOutput) => void): Request<StorageGateway.Types.ResetCacheOutput, AWSError>; 362 /** 363 * 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. 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. 364 */ 365 resetCache(callback?: (err: AWSError, data: StorageGateway.Types.ResetCacheOutput) => void): Request<StorageGateway.Types.ResetCacheOutput, AWSError>; 366 /** 367 * Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a gateway-VTL. 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. 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. 368 */ 369 retrieveTapeArchive(params: StorageGateway.Types.RetrieveTapeArchiveInput, callback?: (err: AWSError, data: StorageGateway.Types.RetrieveTapeArchiveOutput) => void): Request<StorageGateway.Types.RetrieveTapeArchiveOutput, AWSError>; 370 /** 371 * Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a gateway-VTL. 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. 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. 372 */ 373 retrieveTapeArchive(callback?: (err: AWSError, data: StorageGateway.Types.RetrieveTapeArchiveOutput) => void): Request<StorageGateway.Types.RetrieveTapeArchiveOutput, AWSError>; 374 /** 375 * Retrieves the recovery point for the specified virtual tape. 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 gateway-VTL. There is no charge for retrieving recovery points. 376 */ 377 retrieveTapeRecoveryPoint(params: StorageGateway.Types.RetrieveTapeRecoveryPointInput, callback?: (err: AWSError, data: StorageGateway.Types.RetrieveTapeRecoveryPointOutput) => void): Request<StorageGateway.Types.RetrieveTapeRecoveryPointOutput, AWSError>; 378 /** 379 * Retrieves the recovery point for the specified virtual tape. 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 gateway-VTL. There is no charge for retrieving recovery points. 380 */ 381 retrieveTapeRecoveryPoint(callback?: (err: AWSError, data: StorageGateway.Types.RetrieveTapeRecoveryPointOutput) => void): Request<StorageGateway.Types.RetrieveTapeRecoveryPointOutput, AWSError>; 382 /** 383 * 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. 384 */ 385 setLocalConsolePassword(params: StorageGateway.Types.SetLocalConsolePasswordInput, callback?: (err: AWSError, data: StorageGateway.Types.SetLocalConsolePasswordOutput) => void): Request<StorageGateway.Types.SetLocalConsolePasswordOutput, AWSError>; 386 /** 387 * 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. 388 */ 389 setLocalConsolePassword(callback?: (err: AWSError, data: StorageGateway.Types.SetLocalConsolePasswordOutput) => void): Request<StorageGateway.Types.SetLocalConsolePasswordOutput, AWSError>; 390 /** 391 * 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 storage gateway's virtual machine (VM) and not the 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. 392 */ 393 shutdownGateway(params: StorageGateway.Types.ShutdownGatewayInput, callback?: (err: AWSError, data: StorageGateway.Types.ShutdownGatewayOutput) => void): Request<StorageGateway.Types.ShutdownGatewayOutput, AWSError>; 394 /** 395 * 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 storage gateway's virtual machine (VM) and not the 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. 396 */ 397 shutdownGateway(callback?: (err: AWSError, data: StorageGateway.Types.ShutdownGatewayOutput) => void): Request<StorageGateway.Types.ShutdownGatewayOutput, AWSError>; 398 /** 399 * 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. 400 */ 401 startGateway(params: StorageGateway.Types.StartGatewayInput, callback?: (err: AWSError, data: StorageGateway.Types.StartGatewayOutput) => void): Request<StorageGateway.Types.StartGatewayOutput, AWSError>; 402 /** 403 * 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. 404 */ 405 startGateway(callback?: (err: AWSError, data: StorageGateway.Types.StartGatewayOutput) => void): Request<StorageGateway.Types.StartGatewayOutput, AWSError>; 406 /** 407 * 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. 408 */ 409 updateBandwidthRateLimit(params: StorageGateway.Types.UpdateBandwidthRateLimitInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateBandwidthRateLimitOutput) => void): Request<StorageGateway.Types.UpdateBandwidthRateLimitOutput, AWSError>; 410 /** 411 * 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. 412 */ 413 updateBandwidthRateLimit(callback?: (err: AWSError, data: StorageGateway.Types.UpdateBandwidthRateLimitOutput) => void): Request<StorageGateway.Types.UpdateBandwidthRateLimitOutput, AWSError>; 414 /** 415 * 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. 416 */ 417 updateChapCredentials(params: StorageGateway.Types.UpdateChapCredentialsInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateChapCredentialsOutput) => void): Request<StorageGateway.Types.UpdateChapCredentialsOutput, AWSError>; 418 /** 419 * 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. 420 */ 421 updateChapCredentials(callback?: (err: AWSError, data: StorageGateway.Types.UpdateChapCredentialsOutput) => void): Request<StorageGateway.Types.UpdateChapCredentialsOutput, AWSError>; 422 /** 423 * 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. 424 */ 425 updateGatewayInformation(params: StorageGateway.Types.UpdateGatewayInformationInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateGatewayInformationOutput) => void): Request<StorageGateway.Types.UpdateGatewayInformationOutput, AWSError>; 426 /** 427 * 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. 428 */ 429 updateGatewayInformation(callback?: (err: AWSError, data: StorageGateway.Types.UpdateGatewayInformationOutput) => void): Request<StorageGateway.Types.UpdateGatewayInformationOutput, AWSError>; 430 /** 431 * 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. 432 */ 433 updateGatewaySoftwareNow(params: StorageGateway.Types.UpdateGatewaySoftwareNowInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateGatewaySoftwareNowOutput) => void): Request<StorageGateway.Types.UpdateGatewaySoftwareNowOutput, AWSError>; 434 /** 435 * 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. 436 */ 437 updateGatewaySoftwareNow(callback?: (err: AWSError, data: StorageGateway.Types.UpdateGatewaySoftwareNowOutput) => void): Request<StorageGateway.Types.UpdateGatewaySoftwareNowOutput, AWSError>; 438 /** 439 * 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. 440 */ 441 updateMaintenanceStartTime(params: StorageGateway.Types.UpdateMaintenanceStartTimeInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateMaintenanceStartTimeOutput) => void): Request<StorageGateway.Types.UpdateMaintenanceStartTimeOutput, AWSError>; 442 /** 443 * 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. 444 */ 445 updateMaintenanceStartTime(callback?: (err: AWSError, data: StorageGateway.Types.UpdateMaintenanceStartTimeOutput) => void): Request<StorageGateway.Types.UpdateMaintenanceStartTimeOutput, AWSError>; 446 /** 447 * Updates a snapshot schedule configured for a gateway volume. 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. 448 */ 449 updateSnapshotSchedule(params: StorageGateway.Types.UpdateSnapshotScheduleInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateSnapshotScheduleOutput) => void): Request<StorageGateway.Types.UpdateSnapshotScheduleOutput, AWSError>; 450 /** 451 * Updates a snapshot schedule configured for a gateway volume. 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. 452 */ 453 updateSnapshotSchedule(callback?: (err: AWSError, data: StorageGateway.Types.UpdateSnapshotScheduleOutput) => void): Request<StorageGateway.Types.UpdateSnapshotScheduleOutput, AWSError>; 454 /** 455 * Updates the type of medium changer in a gateway-VTL. When you activate a gateway-VTL, you select a medium changer type for the gateway-VTL. This operation enables you to select a different type of medium changer after a gateway-VTL is activated. 456 */ 457 updateVTLDeviceType(params: StorageGateway.Types.UpdateVTLDeviceTypeInput, callback?: (err: AWSError, data: StorageGateway.Types.UpdateVTLDeviceTypeOutput) => void): Request<StorageGateway.Types.UpdateVTLDeviceTypeOutput, AWSError>; 458 /** 459 * Updates the type of medium changer in a gateway-VTL. When you activate a gateway-VTL, you select a medium changer type for the gateway-VTL. This operation enables you to select a different type of medium changer after a gateway-VTL is activated. 460 */ 461 updateVTLDeviceType(callback?: (err: AWSError, data: StorageGateway.Types.UpdateVTLDeviceTypeOutput) => void): Request<StorageGateway.Types.UpdateVTLDeviceTypeOutput, AWSError>; 462 } 463 declare namespace StorageGateway.Types { 464 export interface ActivateGatewayInput { 465 /** 466 * 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. 467 */ 468 ActivationKey: ActivationKey; 469 /** 470 * The name you configured for your gateway. 471 */ 472 GatewayName: GatewayName; 473 /** 474 * A value that indicates the time zone you want to set for the gateway. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule. 475 */ 476 GatewayTimezone: GatewayTimezone; 477 /** 478 * A value that indicates the region where you want to store the snapshot backups. 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: "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "sa-east-1" 479 */ 480 GatewayRegion: RegionId; 481 /** 482 * 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 STORED. 483 */ 484 GatewayType?: GatewayType; 485 /** 486 * The value that indicates the type of tape drive to use for gateway-VTL. This field is optional. Valid Values: "IBM-ULT3580-TD5" 487 */ 488 TapeDriveType?: TapeDriveType; 489 /** 490 * The value that indicates the type of medium changer to use for gateway-VTL. This field is optional. Valid Values: "STK-L700", "AWS-Gateway-VTL" 491 */ 492 MediumChangerType?: MediumChangerType; 493 } 494 export interface ActivateGatewayOutput { 495 GatewayARN?: GatewayARN; 496 } 497 export type ActivationKey = string; 498 export interface AddCacheInput { 499 GatewayARN: GatewayARN; 500 DiskIds: DiskIds; 501 } 502 export interface AddCacheOutput { 503 GatewayARN?: GatewayARN; 504 } 505 export interface AddTagsToResourceInput { 506 /** 507 * The Amazon Resource Name (ARN) of the resource you want to add tags to. 508 */ 509 ResourceARN: ResourceARN; 510 /** 511 * 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: + - = . _ : / @. 512 */ 513 Tags: Tags; 514 } 515 export interface AddTagsToResourceOutput { 516 /** 517 * The Amazon Resource Name (ARN) of the resource you want to add tags to. 518 */ 519 ResourceARN?: ResourceARN; 520 } 521 export interface AddUploadBufferInput { 522 GatewayARN: GatewayARN; 523 DiskIds: DiskIds; 524 } 525 export interface AddUploadBufferOutput { 526 GatewayARN?: GatewayARN; 527 } 528 export interface AddWorkingStorageInput { 529 GatewayARN: GatewayARN; 530 /** 531 * 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. 532 */ 533 DiskIds: DiskIds; 534 } 535 export interface AddWorkingStorageOutput { 536 GatewayARN?: GatewayARN; 537 } 538 export type BandwidthDownloadRateLimit = number; 539 export type BandwidthType = string; 540 export type BandwidthUploadRateLimit = number; 541 export interface CachediSCSIVolume { 542 VolumeARN?: VolumeARN; 543 VolumeId?: VolumeId; 544 VolumeType?: VolumeType; 545 VolumeStatus?: VolumeStatus; 546 VolumeSizeInBytes?: long; 547 VolumeProgress?: DoubleObject; 548 SourceSnapshotId?: SnapshotId; 549 VolumeiSCSIAttributes?: VolumeiSCSIAttributes; 550 } 551 export type CachediSCSIVolumes = CachediSCSIVolume[]; 552 export interface CancelArchivalInput { 553 GatewayARN: GatewayARN; 554 /** 555 * The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving for. 556 */ 557 TapeARN: TapeARN; 558 } 559 export interface CancelArchivalOutput { 560 /** 561 * The Amazon Resource Name (ARN) of the virtual tape for which archiving was canceled. 562 */ 563 TapeARN?: TapeARN; 564 } 565 export interface CancelRetrievalInput { 566 GatewayARN: GatewayARN; 567 /** 568 * The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for. 569 */ 570 TapeARN: TapeARN; 571 } 572 export interface CancelRetrievalOutput { 573 /** 574 * The Amazon Resource Name (ARN) of the virtual tape for which retrieval was canceled. 575 */ 576 TapeARN?: TapeARN; 577 } 578 export type ChapCredentials = ChapInfo[]; 579 export interface ChapInfo { 580 /** 581 * The Amazon Resource Name (ARN) of the volume. Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-). 582 */ 583 TargetARN?: TargetARN; 584 /** 585 * The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target. 586 */ 587 SecretToAuthenticateInitiator?: ChapSecret; 588 /** 589 * The iSCSI initiator that connects to the target. 590 */ 591 InitiatorName?: IqnName; 592 /** 593 * The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client). 594 */ 595 SecretToAuthenticateTarget?: ChapSecret; 596 } 597 export type ChapSecret = string; 598 export type ClientToken = string; 599 export interface CreateCachediSCSIVolumeInput { 600 GatewayARN: GatewayARN; 601 VolumeSizeInBytes: long; 602 SnapshotId?: SnapshotId; 603 TargetName: TargetName; 604 NetworkInterfaceId: NetworkInterfaceId; 605 ClientToken: ClientToken; 606 } 607 export interface CreateCachediSCSIVolumeOutput { 608 VolumeARN?: VolumeARN; 609 TargetARN?: TargetARN; 610 } 611 export interface CreateSnapshotFromVolumeRecoveryPointInput { 612 VolumeARN: VolumeARN; 613 SnapshotDescription: SnapshotDescription; 614 } 615 export interface CreateSnapshotFromVolumeRecoveryPointOutput { 616 SnapshotId?: SnapshotId; 617 VolumeARN?: VolumeARN; 618 VolumeRecoveryPointTime?: string; 619 } 620 export interface CreateSnapshotInput { 621 /** 622 * The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes. 623 */ 624 VolumeARN: VolumeARN; 625 /** 626 * 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 627 */ 628 SnapshotDescription: SnapshotDescription; 629 } 630 export interface CreateSnapshotOutput { 631 /** 632 * The Amazon Resource Name (ARN) of the volume of which the snapshot was taken. 633 */ 634 VolumeARN?: VolumeARN; 635 /** 636 * 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). 637 */ 638 SnapshotId?: SnapshotId; 639 } 640 export interface CreateStorediSCSIVolumeInput { 641 GatewayARN: GatewayARN; 642 /** 643 * The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway. 644 */ 645 DiskId: DiskId; 646 /** 647 * 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. 648 */ 649 SnapshotId?: SnapshotId; 650 /** 651 * 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 652 */ 653 PreserveExistingData: boolean; 654 /** 655 * The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes of a gateway. 656 */ 657 TargetName: TargetName; 658 /** 659 * 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. 660 */ 661 NetworkInterfaceId: NetworkInterfaceId; 662 } 663 export interface CreateStorediSCSIVolumeOutput { 664 /** 665 * The Amazon Resource Name (ARN) of the configured volume. 666 */ 667 VolumeARN?: VolumeARN; 668 /** 669 * The size of the volume in bytes. 670 */ 671 VolumeSizeInBytes?: long; 672 /** 673 * he Amazon Resource Name (ARN) of the volume target that includes the iSCSI name that initiators can use to connect to the target. 674 */ 675 TargetARN?: TargetARN; 676 } 677 export interface CreateTapeWithBarcodeInput { 678 /** 679 * 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. 680 */ 681 GatewayARN: GatewayARN; 682 /** 683 * The size, in bytes, of the virtual tape that you want to create. The size must be aligned by gigabyte (1024*1024*1024 byte). 684 */ 685 TapeSizeInBytes: TapeSize; 686 /** 687 * The barcode that you want to assign to the tape. 688 */ 689 TapeBarcode: TapeBarcode; 690 } 691 export interface CreateTapeWithBarcodeOutput { 692 /** 693 * A unique Amazon Resource Name (ARN) that represents the virtual tape that was created. 694 */ 695 TapeARN?: TapeARN; 696 } 697 export interface CreateTapesInput { 698 /** 699 * 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. 700 */ 701 GatewayARN: GatewayARN; 702 /** 703 * The size, in bytes, of the virtual tapes that you want to create. The size must be aligned by gigabyte (1024*1024*1024 byte). 704 */ 705 TapeSizeInBytes: TapeSize; 706 /** 707 * 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. 708 */ 709 ClientToken: ClientToken; 710 /** 711 * The number of virtual tapes that you want to create. 712 */ 713 NumTapesToCreate: NumTapesToCreate; 714 /** 715 * 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. 716 */ 717 TapeBarcodePrefix: TapeBarcodePrefix; 718 } 719 export interface CreateTapesOutput { 720 /** 721 * A list of unique Amazon Resource Names (ARNs) that represents the virtual tapes that were created. 722 */ 723 TapeARNs?: TapeARNs; 724 } 725 export type DayOfWeek = number; 726 export interface DeleteBandwidthRateLimitInput { 727 GatewayARN: GatewayARN; 728 BandwidthType: BandwidthType; 729 } 730 export interface DeleteBandwidthRateLimitOutput { 731 GatewayARN?: GatewayARN; 732 } 733 export interface DeleteChapCredentialsInput { 734 /** 735 * The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN. 736 */ 737 TargetARN: TargetARN; 738 /** 739 * The iSCSI initiator that connects to the target. 740 */ 741 InitiatorName: IqnName; 742 } 743 export interface DeleteChapCredentialsOutput { 744 /** 745 * The Amazon Resource Name (ARN) of the target. 746 */ 747 TargetARN?: TargetARN; 748 /** 749 * The iSCSI initiator that connects to the target. 750 */ 751 InitiatorName?: IqnName; 752 } 753 export interface DeleteGatewayInput { 754 GatewayARN: GatewayARN; 755 } 756 export interface DeleteGatewayOutput { 757 GatewayARN?: GatewayARN; 758 } 759 export interface DeleteSnapshotScheduleInput { 760 VolumeARN: VolumeARN; 761 } 762 export interface DeleteSnapshotScheduleOutput { 763 VolumeARN?: VolumeARN; 764 } 765 export interface DeleteTapeArchiveInput { 766 /** 767 * The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS). 768 */ 769 TapeARN: TapeARN; 770 } 771 export interface DeleteTapeArchiveOutput { 772 /** 773 * The Amazon Resource Name (ARN) of the virtual tape that was deleted from the virtual tape shelf (VTS). 774 */ 775 TapeARN?: TapeARN; 776 } 777 export interface DeleteTapeInput { 778 /** 779 * 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. 780 */ 781 GatewayARN: GatewayARN; 782 /** 783 * The Amazon Resource Name (ARN) of the virtual tape to delete. 784 */ 785 TapeARN: TapeARN; 786 } 787 export interface DeleteTapeOutput { 788 /** 789 * The Amazon Resource Name (ARN) of the deleted virtual tape. 790 */ 791 TapeARN?: TapeARN; 792 } 793 export interface DeleteVolumeInput { 794 /** 795 * The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes. 796 */ 797 VolumeARN: VolumeARN; 798 } 799 export interface DeleteVolumeOutput { 800 /** 801 * The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the request. 802 */ 803 VolumeARN?: VolumeARN; 804 } 805 export interface DescribeBandwidthRateLimitInput { 806 GatewayARN: GatewayARN; 807 } 808 export interface DescribeBandwidthRateLimitOutput { 809 GatewayARN?: GatewayARN; 810 /** 811 * 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. 812 */ 813 AverageUploadRateLimitInBitsPerSec?: BandwidthUploadRateLimit; 814 /** 815 * 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. 816 */ 817 AverageDownloadRateLimitInBitsPerSec?: BandwidthDownloadRateLimit; 818 } 819 export interface DescribeCacheInput { 820 GatewayARN: GatewayARN; 821 } 822 export interface DescribeCacheOutput { 823 GatewayARN?: GatewayARN; 824 DiskIds?: DiskIds; 825 CacheAllocatedInBytes?: long; 826 CacheUsedPercentage?: double; 827 CacheDirtyPercentage?: double; 828 CacheHitPercentage?: double; 829 CacheMissPercentage?: double; 830 } 831 export interface DescribeCachediSCSIVolumesInput { 832 VolumeARNs: VolumeARNs; 833 } 834 export interface DescribeCachediSCSIVolumesOutput { 835 /** 836 * An array of objects where each object contains metadata about one cached volume. 837 */ 838 CachediSCSIVolumes?: CachediSCSIVolumes; 839 } 840 export interface DescribeChapCredentialsInput { 841 /** 842 * The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN. 843 */ 844 TargetARN: TargetARN; 845 } 846 export interface DescribeChapCredentialsOutput { 847 /** 848 * 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. 849 */ 850 ChapCredentials?: ChapCredentials; 851 } 852 export interface DescribeGatewayInformationInput { 853 GatewayARN: GatewayARN; 854 } 855 export interface DescribeGatewayInformationOutput { 856 GatewayARN?: GatewayARN; 857 /** 858 * 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. 859 */ 860 GatewayId?: GatewayId; 861 /** 862 * The name you configured for your gateway. 863 */ 864 GatewayName?: string; 865 /** 866 * A value that indicates the time zone configured for the gateway. 867 */ 868 GatewayTimezone?: GatewayTimezone; 869 /** 870 * A value that indicates the operating state of the gateway. 871 */ 872 GatewayState?: GatewayState; 873 /** 874 * A NetworkInterface array that contains descriptions of the gateway network interfaces. 875 */ 876 GatewayNetworkInterfaces?: GatewayNetworkInterfaces; 877 /** 878 * The type of the gateway. 879 */ 880 GatewayType?: GatewayType; 881 /** 882 * 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. 883 */ 884 NextUpdateAvailabilityDate?: NextUpdateAvailabilityDate; 885 /** 886 * 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. 887 */ 888 LastSoftwareUpdate?: LastSoftwareUpdate; 889 } 890 export interface DescribeMaintenanceStartTimeInput { 891 GatewayARN: GatewayARN; 892 } 893 export interface DescribeMaintenanceStartTimeOutput { 894 GatewayARN?: GatewayARN; 895 HourOfDay?: HourOfDay; 896 MinuteOfHour?: MinuteOfHour; 897 DayOfWeek?: DayOfWeek; 898 Timezone?: GatewayTimezone; 899 } 900 export interface DescribeSnapshotScheduleInput { 901 /** 902 * The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes. 903 */ 904 VolumeARN: VolumeARN; 905 } 906 export interface DescribeSnapshotScheduleOutput { 907 VolumeARN?: VolumeARN; 908 StartAt?: HourOfDay; 909 RecurrenceInHours?: RecurrenceInHours; 910 Description?: Description; 911 Timezone?: GatewayTimezone; 912 } 913 export interface DescribeStorediSCSIVolumesInput { 914 /** 915 * 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. 916 */ 917 VolumeARNs: VolumeARNs; 918 } 919 export interface DescribeStorediSCSIVolumesOutput { 920 StorediSCSIVolumes?: StorediSCSIVolumes; 921 } 922 export interface DescribeTapeArchivesInput { 923 /** 924 * Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. 925 */ 926 TapeARNs?: TapeARNs; 927 /** 928 * An opaque string that indicates the position at which to begin describing virtual tapes. 929 */ 930 Marker?: Marker; 931 /** 932 * Specifies that the number of virtual tapes descried be limited to the specified number. 933 */ 934 Limit?: PositiveIntObject; 935 } 936 export interface DescribeTapeArchivesOutput { 937 /** 938 * 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. 939 */ 940 TapeArchives?: TapeArchives; 941 /** 942 * 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. 943 */ 944 Marker?: Marker; 945 } 946 export interface DescribeTapeRecoveryPointsInput { 947 GatewayARN: GatewayARN; 948 /** 949 * An opaque string that indicates the position at which to begin describing the virtual tape recovery points. 950 */ 951 Marker?: Marker; 952 /** 953 * Specifies that the number of virtual tape recovery points that are described be limited to the specified number. 954 */ 955 Limit?: PositiveIntObject; 956 } 957 export interface DescribeTapeRecoveryPointsOutput { 958 GatewayARN?: GatewayARN; 959 /** 960 * An array of TapeRecoveryPointInfos that are available for the specified gateway. 961 */ 962 TapeRecoveryPointInfos?: TapeRecoveryPointInfos; 963 /** 964 * 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. 965 */ 966 Marker?: Marker; 967 } 968 export interface DescribeTapesInput { 969 GatewayARN: GatewayARN; 970 /** 971 * Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, AWS Storage Gateway returns a description of all virtual tapes associated with the specified gateway. 972 */ 973 TapeARNs?: TapeARNs; 974 /** 975 * 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. 976 */ 977 Marker?: Marker; 978 /** 979 * 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. 980 */ 981 Limit?: PositiveIntObject; 982 } 983 export interface DescribeTapesOutput { 984 /** 985 * An array of virtual tape descriptions. 986 */ 987 Tapes?: Tapes; 988 /** 989 * 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. 990 */ 991 Marker?: Marker; 992 } 993 export interface DescribeUploadBufferInput { 994 GatewayARN: GatewayARN; 995 } 996 export interface DescribeUploadBufferOutput { 997 GatewayARN?: GatewayARN; 998 DiskIds?: DiskIds; 999 UploadBufferUsedInBytes?: long; 1000 UploadBufferAllocatedInBytes?: long; 1001 } 1002 export interface DescribeVTLDevicesInput { 1003 GatewayARN: GatewayARN; 1004 /** 1005 * 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. 1006 */ 1007 VTLDeviceARNs?: VTLDeviceARNs; 1008 /** 1009 * An opaque string that indicates the position at which to begin describing the VTL devices. 1010 */ 1011 Marker?: Marker; 1012 /** 1013 * Specifies that the number of VTL devices described be limited to the specified number. 1014 */ 1015 Limit?: PositiveIntObject; 1016 } 1017 export interface DescribeVTLDevicesOutput { 1018 GatewayARN?: GatewayARN; 1019 /** 1020 * An array of VTL device objects composed of the Amazon Resource Name(ARN) of the VTL devices. 1021 */ 1022 VTLDevices?: VTLDevices; 1023 /** 1024 * 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. 1025 */ 1026 Marker?: Marker; 1027 } 1028 export interface DescribeWorkingStorageInput { 1029 GatewayARN: GatewayARN; 1030 } 1031 export interface DescribeWorkingStorageOutput { 1032 GatewayARN?: GatewayARN; 1033 /** 1034 * 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. 1035 */ 1036 DiskIds?: DiskIds; 1037 /** 1038 * The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0. 1039 */ 1040 WorkingStorageUsedInBytes?: long; 1041 /** 1042 * The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0. 1043 */ 1044 WorkingStorageAllocatedInBytes?: long; 1045 } 1046 export type Description = string; 1047 export type DeviceType = string; 1048 export interface DeviceiSCSIAttributes { 1049 /** 1050 * Specifies the unique Amazon Resource Name(ARN) that encodes the iSCSI qualified name(iqn) of a tape drive or media changer target. 1051 */ 1052 TargetARN?: TargetARN; 1053 /** 1054 * The network interface identifier of the VTL device. 1055 */ 1056 NetworkInterfaceId?: NetworkInterfaceId; 1057 /** 1058 * The port used to communicate with iSCSI VTL device targets. 1059 */ 1060 NetworkInterfacePort?: integer; 1061 /** 1062 * Indicates whether mutual CHAP is enabled for the iSCSI target. 1063 */ 1064 ChapEnabled?: boolean; 1065 } 1066 export interface DisableGatewayInput { 1067 GatewayARN: GatewayARN; 1068 } 1069 export interface DisableGatewayOutput { 1070 /** 1071 * The unique Amazon Resource Name of the disabled gateway. 1072 */ 1073 GatewayARN?: GatewayARN; 1074 } 1075 export interface Disk { 1076 DiskId?: DiskId; 1077 DiskPath?: string; 1078 DiskNode?: string; 1079 DiskStatus?: string; 1080 DiskSizeInBytes?: long; 1081 DiskAllocationType?: DiskAllocationType; 1082 DiskAllocationResource?: string; 1083 } 1084 export type DiskAllocationType = string; 1085 export type DiskId = string; 1086 export type DiskIds = DiskId[]; 1087 export type Disks = Disk[]; 1088 export type DoubleObject = number; 1089 export type ErrorCode = "ActivationKeyExpired"|"ActivationKeyInvalid"|"ActivationKeyNotFound"|"GatewayInternalError"|"GatewayNotConnected"|"GatewayNotFound"|"GatewayProxyNetworkConnectionBusy"|"AuthenticationFailure"|"BandwidthThrottleScheduleNotFound"|"Blocked"|"CannotExportSnapshot"|"ChapCredentialNotFound"|"DiskAlreadyAllocated"|"DiskDoesNotExist"|"DiskSizeGreaterThanVolumeMaxSize"|"DiskSizeLessThanVolumeSize"|"DiskSizeNotGigAligned"|"DuplicateCertificateInfo"|"DuplicateSchedule"|"EndpointNotFound"|"IAMNotSupported"|"InitiatorInvalid"|"InitiatorNotFound"|"InternalError"|"InvalidGateway"|"InvalidEndpoint"|"InvalidParameters"|"InvalidSchedule"|"LocalStorageLimitExceeded"|"LunAlreadyAllocated "|"LunInvalid"|"MaximumContentLengthExceeded"|"MaximumTapeCartridgeCountExceeded"|"MaximumVolumeCountExceeded"|"NetworkConfigurationChanged"|"NoDisksAvailable"|"NotImplemented"|"NotSupported"|"OperationAborted"|"OutdatedGateway"|"ParametersNotImplemented"|"RegionInvalid"|"RequestTimeout"|"ServiceUnavailable"|"SnapshotDeleted"|"SnapshotIdInvalid"|"SnapshotInProgress"|"SnapshotNotFound"|"SnapshotScheduleNotFound"|"StagingAreaFull"|"StorageFailure"|"TapeCartridgeNotFound"|"TargetAlreadyExists"|"TargetInvalid"|"TargetNotFound"|"UnauthorizedOperation"|"VolumeAlreadyExists"|"VolumeIdInvalid"|"VolumeInUse"|"VolumeNotFound"|"VolumeNotReady"|string; 1090 export type GatewayARN = string; 1091 export type GatewayId = string; 1092 export interface GatewayInfo { 1093 /** 1094 * 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. 1095 */ 1096 GatewayId?: GatewayId; 1097 /** 1098 * The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region. 1099 */ 1100 GatewayARN?: GatewayARN; 1101 /** 1102 * The type of the gateway. 1103 */ 1104 GatewayType?: GatewayType; 1105 /** 1106 * The state of the gateway. Valid Values: DISABLED or ACTIVE 1107 */ 1108 GatewayOperationalState?: GatewayOperationalState; 1109 /** 1110 * The name of the gateway. 1111 */ 1112 GatewayName?: string; 1113 } 1114 export type GatewayName = string; 1115 export type GatewayNetworkInterfaces = NetworkInterface[]; 1116 export type GatewayOperationalState = string; 1117 export type GatewayState = string; 1118 export type GatewayTimezone = string; 1119 export type GatewayType = string; 1120 export type Gateways = GatewayInfo[]; 1121 export type HourOfDay = number; 1122 export type Initiator = string; 1123 export type Initiators = Initiator[]; 1124 export type IqnName = string; 1125 export type LastSoftwareUpdate = string; 1126 export interface ListGatewaysInput { 1127 /** 1128 * An opaque string that indicates the position at which to begin the returned list of gateways. 1129 */ 1130 Marker?: Marker; 1131 /** 1132 * Specifies that the list of gateways returned be limited to the specified number of items. 1133 */ 1134 Limit?: PositiveIntObject; 1135 } 1136 export interface ListGatewaysOutput { 1137 Gateways?: Gateways; 1138 Marker?: Marker; 1139 } 1140 export interface ListLocalDisksInput { 1141 GatewayARN: GatewayARN; 1142 } 1143 export interface ListLocalDisksOutput { 1144 GatewayARN?: GatewayARN; 1145 Disks?: Disks; 1146 } 1147 export interface ListTagsForResourceInput { 1148 /** 1149 * The Amazon Resource Name (ARN) of the resource for which you want to list tags. 1150 */ 1151 ResourceARN: ResourceARN; 1152 /** 1153 * An opaque string that indicates the position at which to begin returning the list of tags. 1154 */ 1155 Marker?: Marker; 1156 /** 1157 * Specifies that the list of tags returned be limited to the specified number of items. 1158 */ 1159 Limit?: PositiveIntObject; 1160 } 1161 export interface ListTagsForResourceOutput { 1162 /** 1163 * he Amazon Resource Name (ARN) of the resource for which you want to list tags. 1164 */ 1165 ResourceARN?: ResourceARN; 1166 /** 1167 * An opaque string that indicates the position at which to stop returning the list of tags. 1168 */ 1169 Marker?: Marker; 1170 /** 1171 * An array that contains the tags for the specified resource. 1172 */ 1173 Tags?: Tags; 1174 } 1175 export interface ListTapesInput { 1176 TapeARNs?: TapeARNs; 1177 /** 1178 * A string that indicates the position at which to begin the returned list of tapes. 1179 */ 1180 Marker?: Marker; 1181 /** 1182 * An optional number limit for the tapes in the list returned by this call. 1183 */ 1184 Limit?: PositiveIntObject; 1185 } 1186 export interface ListTapesOutput { 1187 TapeInfos?: TapeInfos; 1188 /** 1189 * 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. 1190 */ 1191 Marker?: Marker; 1192 } 1193 export interface ListVolumeInitiatorsInput { 1194 /** 1195 * The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes for the gateway. 1196 */ 1197 VolumeARN: VolumeARN; 1198 } 1199 export interface ListVolumeInitiatorsOutput { 1200 /** 1201 * The host names and port numbers of all iSCSI initiators that are connected to the gateway. 1202 */ 1203 Initiators?: Initiators; 1204 } 1205 export interface ListVolumeRecoveryPointsInput { 1206 GatewayARN: GatewayARN; 1207 } 1208 export interface ListVolumeRecoveryPointsOutput { 1209 GatewayARN?: GatewayARN; 1210 VolumeRecoveryPointInfos?: VolumeRecoveryPointInfos; 1211 } 1212 export interface ListVolumesInput { 1213 GatewayARN?: GatewayARN; 1214 /** 1215 * 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. 1216 */ 1217 Marker?: Marker; 1218 /** 1219 * Specifies that the list of volumes returned be limited to the specified number of items. 1220 */ 1221 Limit?: PositiveIntObject; 1222 } 1223 export interface ListVolumesOutput { 1224 GatewayARN?: GatewayARN; 1225 Marker?: Marker; 1226 VolumeInfos?: VolumeInfos; 1227 } 1228 export type LocalConsolePassword = string; 1229 export type Marker = string; 1230 export type MediumChangerType = string; 1231 export type MinuteOfHour = number; 1232 export interface NetworkInterface { 1233 /** 1234 * The Internet Protocol version 4 (IPv4) address of the interface. 1235 */ 1236 Ipv4Address?: string; 1237 /** 1238 * The Media Access Control (MAC) address of the interface. This is currently unsupported and will not be returned in output. 1239 */ 1240 MacAddress?: string; 1241 /** 1242 * The Internet Protocol version 6 (IPv6) address of the interface. Currently not supported. 1243 */ 1244 Ipv6Address?: string; 1245 } 1246 export type NetworkInterfaceId = string; 1247 export type NextUpdateAvailabilityDate = string; 1248 export type NumTapesToCreate = number; 1249 export type PositiveIntObject = number; 1250 export type RecurrenceInHours = number; 1251 export type RegionId = string; 1252 export interface RemoveTagsFromResourceInput { 1253 /** 1254 * The Amazon Resource Name (ARN) of the resource you want to remove the tags from. 1255 */ 1256 ResourceARN: ResourceARN; 1257 /** 1258 * The keys of the tags you want to remove from the specified resource. A tag is composed of a key/value pair. 1259 */ 1260 TagKeys: TagKeys; 1261 } 1262 export interface RemoveTagsFromResourceOutput { 1263 /** 1264 * The Amazon Resource Name (ARN) of the resource that the tags were removed from. 1265 */ 1266 ResourceARN?: ResourceARN; 1267 } 1268 export interface ResetCacheInput { 1269 GatewayARN: GatewayARN; 1270 } 1271 export interface ResetCacheOutput { 1272 GatewayARN?: GatewayARN; 1273 } 1274 export type ResourceARN = string; 1275 export interface RetrieveTapeArchiveInput { 1276 /** 1277 * The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS). 1278 */ 1279 TapeARN: TapeARN; 1280 /** 1281 * 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 gateway-VTL. 1282 */ 1283 GatewayARN: GatewayARN; 1284 } 1285 export interface RetrieveTapeArchiveOutput { 1286 /** 1287 * The Amazon Resource Name (ARN) of the retrieved virtual tape. 1288 */ 1289 TapeARN?: TapeARN; 1290 } 1291 export interface RetrieveTapeRecoveryPointInput { 1292 /** 1293 * The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the recovery point. 1294 */ 1295 TapeARN: TapeARN; 1296 GatewayARN: GatewayARN; 1297 } 1298 export interface RetrieveTapeRecoveryPointOutput { 1299 /** 1300 * The Amazon Resource Name (ARN) of the virtual tape for which the recovery point was retrieved. 1301 */ 1302 TapeARN?: TapeARN; 1303 } 1304 export interface SetLocalConsolePasswordInput { 1305 GatewayARN: GatewayARN; 1306 /** 1307 * The password you want to set for your VM local console. 1308 */ 1309 LocalConsolePassword: LocalConsolePassword; 1310 } 1311 export interface SetLocalConsolePasswordOutput { 1312 GatewayARN?: GatewayARN; 1313 } 1314 export interface ShutdownGatewayInput { 1315 GatewayARN: GatewayARN; 1316 } 1317 export interface ShutdownGatewayOutput { 1318 GatewayARN?: GatewayARN; 1319 } 1320 export type SnapshotDescription = string; 1321 export type SnapshotId = string; 1322 export interface StartGatewayInput { 1323 GatewayARN: GatewayARN; 1324 } 1325 export interface StartGatewayOutput { 1326 GatewayARN?: GatewayARN; 1327 } 1328 export interface StorageGatewayError { 1329 /** 1330 * Additional information about the error. 1331 */ 1332 errorCode?: ErrorCode; 1333 /** 1334 * Human-readable text that provides detail about the error that occurred. 1335 */ 1336 errorDetails?: errorDetails; 1337 } 1338 export interface StorediSCSIVolume { 1339 VolumeARN?: VolumeARN; 1340 VolumeId?: VolumeId; 1341 VolumeType?: VolumeType; 1342 VolumeStatus?: VolumeStatus; 1343 VolumeSizeInBytes?: long; 1344 VolumeProgress?: DoubleObject; 1345 VolumeDiskId?: DiskId; 1346 SourceSnapshotId?: SnapshotId; 1347 PreservedExistingData?: boolean; 1348 VolumeiSCSIAttributes?: VolumeiSCSIAttributes; 1349 } 1350 export type StorediSCSIVolumes = StorediSCSIVolume[]; 1351 export interface Tag { 1352 Key: TagKey; 1353 Value: TagValue; 1354 } 1355 export type TagKey = string; 1356 export type TagKeys = TagKey[]; 1357 export type TagValue = string; 1358 export type Tags = Tag[]; 1359 export interface Tape { 1360 /** 1361 * The Amazon Resource Name (ARN) of the virtual tape. 1362 */ 1363 TapeARN?: TapeARN; 1364 /** 1365 * The barcode that identifies a specific virtual tape. 1366 */ 1367 TapeBarcode?: TapeBarcode; 1368 /** 1369 * The size, in bytes, of the virtual tape. 1370 */ 1371 TapeSizeInBytes?: TapeSize; 1372 /** 1373 * The current state of the virtual tape. 1374 */ 1375 TapeStatus?: TapeStatus; 1376 /** 1377 * The virtual tape library (VTL) device that the virtual tape is associated with. 1378 */ 1379 VTLDevice?: VTLDeviceARN; 1380 /** 1381 * For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete. Range: 0 (not started) to 100 (complete). 1382 */ 1383 Progress?: DoubleObject; 1384 } 1385 export type TapeARN = string; 1386 export type TapeARNs = TapeARN[]; 1387 export interface TapeArchive { 1388 /** 1389 * The Amazon Resource Name (ARN) of an archived virtual tape. 1390 */ 1391 TapeARN?: TapeARN; 1392 /** 1393 * The barcode that identifies the archived virtual tape. 1394 */ 1395 TapeBarcode?: TapeBarcode; 1396 /** 1397 * The size, in bytes, of the archived virtual tape. 1398 */ 1399 TapeSizeInBytes?: TapeSize; 1400 /** 1401 * The time that the archiving of the virtual tape was completed. The string format of the completion time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format. 1402 */ 1403 CompletionTime?: Time; 1404 /** 1405 * The Amazon Resource Name (ARN) of the gateway-VTL that the virtual tape is being retrieved to. The virtual tape is retrieved from the virtual tape shelf (VTS). 1406 */ 1407 RetrievedTo?: GatewayARN; 1408 /** 1409 * The current state of the archived virtual tape. 1410 */ 1411 TapeStatus?: TapeArchiveStatus; 1412 } 1413 export type TapeArchiveStatus = string; 1414 export type TapeArchives = TapeArchive[]; 1415 export type TapeBarcode = string; 1416 export type TapeBarcodePrefix = string; 1417 export type TapeDriveType = string; 1418 export interface TapeInfo { 1419 /** 1420 * The Amazon Resource Name (ARN) of a virtual tape. 1421 */ 1422 TapeARN?: TapeARN; 1423 /** 1424 * The barcode that identifies a specific virtual tape. 1425 */ 1426 TapeBarcode?: TapeBarcode; 1427 /** 1428 * The size, in bytes, of a virtual tape. 1429 */ 1430 TapeSizeInBytes?: TapeSize; 1431 /** 1432 * The status of the tape. 1433 */ 1434 TapeStatus?: TapeStatus; 1435 /** 1436 * The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region. 1437 */ 1438 GatewayARN?: GatewayARN; 1439 } 1440 export type TapeInfos = TapeInfo[]; 1441 export interface TapeRecoveryPointInfo { 1442 /** 1443 * The Amazon Resource Name (ARN) of the virtual tape. 1444 */ 1445 TapeARN?: TapeARN; 1446 /** 1447 * The time when the point-in-time view of the virtual tape was replicated for later recovery. The string format of the tape recovery point time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format. 1448 */ 1449 TapeRecoveryPointTime?: Time; 1450 /** 1451 * The size, in bytes, of the virtual tapes to recover. 1452 */ 1453 TapeSizeInBytes?: TapeSize; 1454 TapeStatus?: TapeRecoveryPointStatus; 1455 } 1456 export type TapeRecoveryPointInfos = TapeRecoveryPointInfo[]; 1457 export type TapeRecoveryPointStatus = string; 1458 export type TapeSize = number; 1459 export type TapeStatus = string; 1460 export type Tapes = Tape[]; 1461 export type TargetARN = string; 1462 export type TargetName = string; 1463 export type Time = Date; 1464 export interface UpdateBandwidthRateLimitInput { 1465 GatewayARN: GatewayARN; 1466 /** 1467 * The average upload bandwidth rate limit in bits per second. 1468 */ 1469 AverageUploadRateLimitInBitsPerSec?: BandwidthUploadRateLimit; 1470 /** 1471 * The average download bandwidth rate limit in bits per second. 1472 */ 1473 AverageDownloadRateLimitInBitsPerSec?: BandwidthDownloadRateLimit; 1474 } 1475 export interface UpdateBandwidthRateLimitOutput { 1476 GatewayARN?: GatewayARN; 1477 } 1478 export interface UpdateChapCredentialsInput { 1479 /** 1480 * The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified VolumeARN. 1481 */ 1482 TargetARN: TargetARN; 1483 /** 1484 * 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. 1485 */ 1486 SecretToAuthenticateInitiator: ChapSecret; 1487 /** 1488 * The iSCSI initiator that connects to the target. 1489 */ 1490 InitiatorName: IqnName; 1491 /** 1492 * 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. 1493 */ 1494 SecretToAuthenticateTarget?: ChapSecret; 1495 } 1496 export interface UpdateChapCredentialsOutput { 1497 /** 1498 * The Amazon Resource Name (ARN) of the target. This is the same target specified in the request. 1499 */ 1500 TargetARN?: TargetARN; 1501 /** 1502 * The iSCSI initiator that connects to the target. This is the same initiator name specified in the request. 1503 */ 1504 InitiatorName?: IqnName; 1505 } 1506 export interface UpdateGatewayInformationInput { 1507 GatewayARN: GatewayARN; 1508 GatewayName?: GatewayName; 1509 GatewayTimezone?: GatewayTimezone; 1510 } 1511 export interface UpdateGatewayInformationOutput { 1512 GatewayARN?: GatewayARN; 1513 GatewayName?: string; 1514 } 1515 export interface UpdateGatewaySoftwareNowInput { 1516 GatewayARN: GatewayARN; 1517 } 1518 export interface UpdateGatewaySoftwareNowOutput { 1519 GatewayARN?: GatewayARN; 1520 } 1521 export interface UpdateMaintenanceStartTimeInput { 1522 GatewayARN: GatewayARN; 1523 /** 1524 * 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. 1525 */ 1526 HourOfDay: HourOfDay; 1527 /** 1528 * 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. 1529 */ 1530 MinuteOfHour: MinuteOfHour; 1531 /** 1532 * The maintenance start time day of the week. 1533 */ 1534 DayOfWeek: DayOfWeek; 1535 } 1536 export interface UpdateMaintenanceStartTimeOutput { 1537 GatewayARN?: GatewayARN; 1538 } 1539 export interface UpdateSnapshotScheduleInput { 1540 /** 1541 * The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes. 1542 */ 1543 VolumeARN: VolumeARN; 1544 /** 1545 * 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. 1546 */ 1547 StartAt: HourOfDay; 1548 /** 1549 * Frequency of snapshots. Specify the number of hours between snapshots. 1550 */ 1551 RecurrenceInHours: RecurrenceInHours; 1552 /** 1553 * Optional description of the snapshot that overwrites the existing description. 1554 */ 1555 Description?: Description; 1556 } 1557 export interface UpdateSnapshotScheduleOutput { 1558 /** 1559 * 1560 */ 1561 VolumeARN?: VolumeARN; 1562 } 1563 export interface UpdateVTLDeviceTypeInput { 1564 /** 1565 * The Amazon Resource Name (ARN) of the medium changer you want to select. 1566 */ 1567 VTLDeviceARN: VTLDeviceARN; 1568 /** 1569 * The type of medium changer you want to select. Valid Values: "STK-L700", "AWS-Gateway-VTL" 1570 */ 1571 DeviceType: DeviceType; 1572 } 1573 export interface UpdateVTLDeviceTypeOutput { 1574 /** 1575 * The Amazon Resource Name (ARN) of the medium changer you have selected. 1576 */ 1577 VTLDeviceARN?: VTLDeviceARN; 1578 } 1579 export interface VTLDevice { 1580 /** 1581 * Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer). 1582 */ 1583 VTLDeviceARN?: VTLDeviceARN; 1584 VTLDeviceType?: VTLDeviceType; 1585 VTLDeviceVendor?: VTLDeviceVendor; 1586 VTLDeviceProductIdentifier?: VTLDeviceProductIdentifier; 1587 /** 1588 * A list of iSCSI information about a VTL device. 1589 */ 1590 DeviceiSCSIAttributes?: DeviceiSCSIAttributes; 1591 } 1592 export type VTLDeviceARN = string; 1593 export type VTLDeviceARNs = VTLDeviceARN[]; 1594 export type VTLDeviceProductIdentifier = string; 1595 export type VTLDeviceType = string; 1596 export type VTLDeviceVendor = string; 1597 export type VTLDevices = VTLDevice[]; 1598 export type VolumeARN = string; 1599 export type VolumeARNs = VolumeARN[]; 1600 export type VolumeId = string; 1601 export interface VolumeInfo { 1602 /** 1603 * The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN: arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-). 1604 */ 1605 VolumeARN?: VolumeARN; 1606 /** 1607 * 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 (-). 1608 */ 1609 VolumeId?: VolumeId; 1610 GatewayARN?: GatewayARN; 1611 /** 1612 * 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 (-). 1613 */ 1614 GatewayId?: GatewayId; 1615 VolumeType?: VolumeType; 1616 /** 1617 * The size, in bytes, of the volume. Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-). 1618 */ 1619 VolumeSizeInBytes?: long; 1620 } 1621 export type VolumeInfos = VolumeInfo[]; 1622 export interface VolumeRecoveryPointInfo { 1623 VolumeARN?: VolumeARN; 1624 VolumeSizeInBytes?: long; 1625 VolumeUsageInBytes?: long; 1626 VolumeRecoveryPointTime?: string; 1627 } 1628 export type VolumeRecoveryPointInfos = VolumeRecoveryPointInfo[]; 1629 export type VolumeStatus = string; 1630 export type VolumeType = string; 1631 export interface VolumeiSCSIAttributes { 1632 /** 1633 * The Amazon Resource Name (ARN) of the volume target. 1634 */ 1635 TargetARN?: TargetARN; 1636 /** 1637 * The network interface identifier. 1638 */ 1639 NetworkInterfaceId?: NetworkInterfaceId; 1640 /** 1641 * The port used to communicate with iSCSI targets. 1642 */ 1643 NetworkInterfacePort?: integer; 1644 /** 1645 * The logical disk number. 1646 */ 1647 LunNumber?: PositiveIntObject; 1648 /** 1649 * Indicates whether mutual CHAP is enabled for the iSCSI target. 1650 */ 1651 ChapEnabled?: boolean; 1652 } 1653 export type double = number; 1654 export type errorDetails = {[key: string]: string}; 1655 export type integer = number; 1656 export type long = number; 1657 /** 1658 * 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. 1659 */ 1660 export type apiVersion = "2013-06-30"|"latest"|string; 1661 export interface ClientApiVersions { 1662 /** 1663 * 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. 1664 */ 1665 apiVersion?: apiVersion; 1666 } 1667 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 1668 } 1669 export = StorageGateway;