From ee421eae77f20decd856f75776171cd16a1ac719 Mon Sep 17 00:00:00 2001
From: awstools Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a
- * Returns a description of virtual tapes that correspond to the specified Amazon Resource
+ * Names (ARNs). If The operation supports pagination. By default, the operation returns a maximum of up to
+ * 100 tapes. You can optionally specify the Sends you notification through CloudWatch Events when all files written to your file
- * share have been uploaded to S3. Amazon S3.TapeARN
is not specified, returns a description of all virtual tapes
- * associated with the specified gateway. This operation is only supported in the tape gateway
- * type.TapeARN
is not specified, returns a description of the
+ * virtual tapes associated with the specified gateway. This operation is only supported for
+ * the tape gateway type.Limit
field 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
field. You can use this
+ * Marker
value in your subsequent request to retrieve the next set of
+ * tapes.
Storage Gateway can send a notification through Amazon CloudWatch Events when all * files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you * make a request for notification. When the upload is done, Storage Gateway sends you diff --git a/clients/client-storage-gateway/src/commands/RefreshCacheCommand.ts b/clients/client-storage-gateway/src/commands/RefreshCacheCommand.ts index 9212af999090c..9caf444dfd15a 100644 --- a/clients/client-storage-gateway/src/commands/RefreshCacheCommand.ts +++ b/clients/client-storage-gateway/src/commands/RefreshCacheCommand.ts @@ -35,8 +35,9 @@ export interface RefreshCacheCommandOutput extends RefreshCacheOutput, __Metadat * inventory to reflect changes in the inventory of the objects in the S3 bucket. This * operation is only supported in the S3 File Gateway types.
*You can subscribe to be notified through an Amazon CloudWatch event when your
- * RefreshCache
operation completes. For more information, see Getting notified about file operations in the Storage Gateway
- * User Guide. This operation is Only supported for S3 File Gateways.
RefreshCache
operation completes. For more information, see Getting
+ * notified about file operations in the Amazon S3 File Gateway User
+ * Guide. This operation is Only supported for S3 File Gateways.
* When this API is called, it only initiates the refresh operation. When the API call * completes and returns a success code, it doesn't necessarily mean that the file * refresh has completed. You should use the refresh-complete notification to determine that @@ -45,8 +46,9 @@ export interface RefreshCacheCommandOutput extends RefreshCacheOutput, __Metadat * operation completes.
*Throttle limit: This API is asynchronous, so the gateway will accept no more than two * refreshes at any time. We recommend using the refresh-complete CloudWatch event - * notification before issuing additional requests. For more information, see Getting notified about file operations in the Storage Gateway - * User Guide.
+ * notification before issuing additional requests. For more information, see Getting + * notified about file operations in the Amazon S3 File Gateway User + * Guide. *The S3 bucket name does not need to be included when entering the list of folders in * the FolderList parameter.
* - *For more information, see Getting notified about file operations in the Storage Gateway - * User Guide.
+ *For more information, see Getting + * notified about file operations in the Amazon S3 File Gateway User + * Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-storage-gateway/src/commands/ShutdownGatewayCommand.ts b/clients/client-storage-gateway/src/commands/ShutdownGatewayCommand.ts index 69992075e0d78..dfed220e93a37 100644 --- a/clients/client-storage-gateway/src/commands/ShutdownGatewayCommand.ts +++ b/clients/client-storage-gateway/src/commands/ShutdownGatewayCommand.ts @@ -28,8 +28,12 @@ export interface ShutdownGatewayCommandOutput extends ShutdownGatewayOutput, __M /** * @public - *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.
+ *Shuts down a Tape Gateway or Volume Gateway. To specify which gateway to shut down, use + * the Amazon Resource Name (ARN) of the gateway in the body of your request.
+ *This API action cannot be used to shut down S3 File Gateway or FSx File + * Gateway.
+ *The operation shuts down the gateway service component running in the gateway's * virtual machine (VM) and not the host VM.
*Date after which this gateway will not receive software updates for new features and bug + * fixes.
+ */ + DeprecationDate?: string; + + /** + * @public + *The version number of the software running on the gateway appliance.
+ */ + SoftwareVersion?: string; } /** diff --git a/codegen/sdk-codegen/aws-models/storage-gateway.json b/codegen/sdk-codegen/aws-models/storage-gateway.json index c700c02f87ba3..90da4d2da8b87 100644 --- a/codegen/sdk-codegen/aws-models/storage-gateway.json +++ b/codegen/sdk-codegen/aws-models/storage-gateway.json @@ -4376,7 +4376,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a\n TapeARN
is not specified, returns a description of all virtual tapes\n associated with the specified gateway. This operation is only supported in the tape gateway\n type.
Returns a description of virtual tapes that correspond to the specified Amazon Resource\n Names (ARNs). If TapeARN
is not specified, returns a description of the\n virtual tapes associated with the specified gateway. This operation is only supported for\n the tape gateway type.
The operation supports pagination. By default, the operation returns a maximum of up to\n 100 tapes. You can optionally specify the Limit
field in the body to limit the\n number of tapes in the response. If the number of tapes returned in the response is\n truncated, the response includes a Marker
field. You can use this\n Marker
value in your subsequent request to retrieve the next set of\n tapes.
A unique identifier for the specific instance of the host platform running the gateway.\n This value is only available for certain host environments, and its format depends on the\n host environment type.
" } + }, + "DeprecationDate": { + "target": "com.amazonaws.storagegateway#DeprecationDate", + "traits": { + "smithy.api#documentation": "Date after which this gateway will not receive software updates for new features and bug\n fixes.
" + } + }, + "SoftwareVersion": { + "target": "com.amazonaws.storagegateway#SoftwareVersion", + "traits": { + "smithy.api#documentation": "The version number of the software running on the gateway appliance.
" + } } }, "traits": { @@ -7426,7 +7451,7 @@ } ], "traits": { - "smithy.api#documentation": "Sends you notification through CloudWatch Events when all files written to your file\n share have been uploaded to S3. Amazon S3.
\nStorage Gateway can send a notification through Amazon CloudWatch Events when all\n files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you\n make a request for notification. When the upload is done, Storage Gateway sends you\n notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to\n send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.
\nFor more information, see Getting\n file upload notification in the Amazon S3 File Gateway User\n Guide.
" + "smithy.api#documentation": "Sends you notification through CloudWatch Events when all files written to your file\n share have been uploaded to Amazon S3.
\nStorage Gateway can send a notification through Amazon CloudWatch Events when all\n files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you\n make a request for notification. When the upload is done, Storage Gateway sends you\n notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to\n send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.
\nFor more information, see Getting\n file upload notification in the Amazon S3 File Gateway User\n Guide.
" } }, "com.amazonaws.storagegateway#NotifyWhenUploadedInput": { @@ -7685,7 +7710,7 @@ } ], "traits": { - "smithy.api#documentation": "Refreshes the cached inventory of objects for the specified file share. This operation\n finds objects in the Amazon S3 bucket that were added, removed, or replaced since\n the gateway last listed the bucket's contents and cached the results. This operation\n does not import files into the S3 File Gateway cache storage. It only updates the cached\n inventory to reflect changes in the inventory of the objects in the S3 bucket. This\n operation is only supported in the S3 File Gateway types.
\nYou can subscribe to be notified through an Amazon CloudWatch event when your\n RefreshCache
operation completes. For more information, see Getting notified about file operations in the Storage Gateway\n User Guide. This operation is Only supported for S3 File Gateways.
When this API is called, it only initiates the refresh operation. When the API call\n completes and returns a success code, it doesn't necessarily mean that the file\n refresh has completed. You should use the refresh-complete notification to determine that\n the operation has completed before you check for new files on the gateway file share. You\n can subscribe to be notified through a CloudWatch event when your RefreshCache
\n operation completes.
Throttle limit: This API is asynchronous, so the gateway will accept no more than two\n refreshes at any time. We recommend using the refresh-complete CloudWatch event\n notification before issuing additional requests. For more information, see Getting notified about file operations in the Storage Gateway\n User Guide.
\nWait at least 60 seconds between consecutive RefreshCache API requests.
\nIf you invoke the RefreshCache API when two requests are already being\n processed, any new request will cause an\n InvalidGatewayRequestException
error because too many requests\n were sent to the server.
The S3 bucket name does not need to be included when entering the list of folders in\n the FolderList parameter.
\nFor more information, see Getting notified about file operations in the Storage Gateway\n User Guide.
" + "smithy.api#documentation": "Refreshes the cached inventory of objects for the specified file share. This operation\n finds objects in the Amazon S3 bucket that were added, removed, or replaced since\n the gateway last listed the bucket's contents and cached the results. This operation\n does not import files into the S3 File Gateway cache storage. It only updates the cached\n inventory to reflect changes in the inventory of the objects in the S3 bucket. This\n operation is only supported in the S3 File Gateway types.
\nYou can subscribe to be notified through an Amazon CloudWatch event when your\n RefreshCache
operation completes. For more information, see Getting\n notified about file operations in the Amazon S3 File Gateway User\n Guide. This operation is Only supported for S3 File Gateways.
When this API is called, it only initiates the refresh operation. When the API call\n completes and returns a success code, it doesn't necessarily mean that the file\n refresh has completed. You should use the refresh-complete notification to determine that\n the operation has completed before you check for new files on the gateway file share. You\n can subscribe to be notified through a CloudWatch event when your RefreshCache
\n operation completes.
Throttle limit: This API is asynchronous, so the gateway will accept no more than two\n refreshes at any time. We recommend using the refresh-complete CloudWatch event\n notification before issuing additional requests. For more information, see Getting\n notified about file operations in the Amazon S3 File Gateway User\n Guide.
\nWait at least 60 seconds between consecutive RefreshCache API requests.
\nIf you invoke the RefreshCache API when two requests are already being\n processed, any new request will cause an\n InvalidGatewayRequestException
error because too many requests\n were sent to the server.
The S3 bucket name does not need to be included when entering the list of folders in\n the FolderList parameter.
\nFor more information, see Getting\n notified about file operations in the Amazon S3 File Gateway User\n Guide.
" } }, "com.amazonaws.storagegateway#RefreshCacheInput": { @@ -8430,7 +8455,7 @@ } ], "traits": { - "smithy.api#documentation": "Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource\n Name (ARN) of the gateway in the body of your request.
\nThe operation shuts down the gateway service component running in the gateway's\n virtual machine (VM) and not the host VM.
\nIf you want to shut down the VM, it is recommended that you first shut down the\n gateway component in the VM to avoid unpredictable conditions.
\nAfter the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway.\n Your applications cannot read from or write to the gateway's storage volumes, and\n there are no snapshots taken.
\nWhen you make a shutdown request, you will get a 200 OK
success response\n immediately. However, it might take some time for the gateway to shut down. You can call\n the DescribeGatewayInformation API to check the status. For more\n 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\n gateway.
", + "smithy.api#documentation": "Shuts down a Tape Gateway or Volume Gateway. To specify which gateway to shut down, use\n the Amazon Resource Name (ARN) of the gateway in the body of your request.
\nThis API action cannot be used to shut down S3 File Gateway or FSx File\n Gateway.
\nThe operation shuts down the gateway service component running in the gateway's\n virtual machine (VM) and not the host VM.
\nIf you want to shut down the VM, it is recommended that you first shut down the\n gateway component in the VM to avoid unpredictable conditions.
\nAfter the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway.\n Your applications cannot read from or write to the gateway's storage volumes, and\n there are no snapshots taken.
\nWhen you make a shutdown request, you will get a 200 OK
success response\n immediately. However, it might take some time for the gateway to shut down. You can call\n the DescribeGatewayInformation API to check the status. For more\n 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\n gateway.
", "smithy.api#examples": [ { "title": "To shut down a gateway service",