Skip to content

Commit ee421ea

Browse files
author
awstools
committedJan 24, 2024
feat(client-storage-gateway): Add DeprecationDate and SoftwareVersion to response of ListGateways.
1 parent 9e30002 commit ee421ea

File tree

7 files changed

+70
-17
lines changed

7 files changed

+70
-17
lines changed
 

‎clients/client-storage-gateway/src/commands/DescribeTapesCommand.ts

+10-4
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,16 @@ export interface DescribeTapesCommandOutput extends DescribeTapesOutput, __Metad
2828

2929
/**
3030
* @public
31-
* <p>Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a
32-
* <code>TapeARN</code> is not specified, returns a description of all virtual tapes
33-
* associated with the specified gateway. This operation is only supported in the tape gateway
34-
* type.</p>
31+
* <p>Returns a description of virtual tapes that correspond to the specified Amazon Resource
32+
* Names (ARNs). If <code>TapeARN</code> is not specified, returns a description of the
33+
* virtual tapes associated with the specified gateway. This operation is only supported for
34+
* the tape gateway type.</p>
35+
* <p>The operation supports pagination. By default, the operation returns a maximum of up to
36+
* 100 tapes. You can optionally specify the <code>Limit</code> field in the body to limit the
37+
* number of tapes in the response. If the number of tapes returned in the response is
38+
* truncated, the response includes a <code>Marker</code> field. You can use this
39+
* <code>Marker</code> value in your subsequent request to retrieve the next set of
40+
* tapes.</p>
3541
* @example
3642
* Use a bare-bones client and the command you need to make an API call.
3743
* ```javascript

‎clients/client-storage-gateway/src/commands/ListGatewaysCommand.ts

+2
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@ export interface ListGatewaysCommandOutput extends ListGatewaysOutput, __Metadat
6161
* // Ec2InstanceRegion: "STRING_VALUE",
6262
* // HostEnvironment: "VMWARE" || "HYPER-V" || "EC2" || "KVM" || "OTHER" || "SNOWBALL",
6363
* // HostEnvironmentId: "STRING_VALUE",
64+
* // DeprecationDate: "STRING_VALUE",
65+
* // SoftwareVersion: "STRING_VALUE",
6466
* // },
6567
* // ],
6668
* // Marker: "STRING_VALUE",

‎clients/client-storage-gateway/src/commands/NotifyWhenUploadedCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export interface NotifyWhenUploadedCommandOutput extends NotifyWhenUploadedOutpu
2929
/**
3030
* @public
3131
* <p>Sends you notification through CloudWatch Events when all files written to your file
32-
* share have been uploaded to S3. Amazon S3.</p>
32+
* share have been uploaded to Amazon S3.</p>
3333
* <p>Storage Gateway can send a notification through Amazon CloudWatch Events when all
3434
* 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
3535
* make a request for notification. When the upload is done, Storage Gateway sends you

‎clients/client-storage-gateway/src/commands/RefreshCacheCommand.ts

+9-6
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,9 @@ export interface RefreshCacheCommandOutput extends RefreshCacheOutput, __Metadat
3535
* inventory to reflect changes in the inventory of the objects in the S3 bucket. This
3636
* operation is only supported in the S3 File Gateway types.</p>
3737
* <p>You can subscribe to be notified through an Amazon CloudWatch event when your
38-
* <code>RefreshCache</code> operation completes. For more information, see <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification">Getting notified about file operations</a> in the <i>Storage Gateway
39-
* User Guide</i>. This operation is Only supported for S3 File Gateways.</p>
38+
* <code>RefreshCache</code> operation completes. For more information, see <a href="https://docs.aws.amazon.com/filegateway/latest/files3/monitoring-file-gateway.html#get-notification">Getting
39+
* notified about file operations</a> in the <i>Amazon S3 File Gateway User
40+
* Guide</i>. This operation is Only supported for S3 File Gateways.</p>
4041
* <p>When this API is called, it only initiates the refresh operation. When the API call
4142
* completes and returns a success code, it doesn't necessarily mean that the file
4243
* refresh has completed. You should use the refresh-complete notification to determine that
@@ -45,8 +46,9 @@ export interface RefreshCacheCommandOutput extends RefreshCacheOutput, __Metadat
4546
* operation completes.</p>
4647
* <p>Throttle limit: This API is asynchronous, so the gateway will accept no more than two
4748
* refreshes at any time. We recommend using the refresh-complete CloudWatch event
48-
* notification before issuing additional requests. For more information, see <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification">Getting notified about file operations</a> in the <i>Storage Gateway
49-
* User Guide</i>.</p>
49+
* notification before issuing additional requests. For more information, see <a href="https://docs.aws.amazon.com/filegateway/latest/files3/monitoring-file-gateway.html#get-notification">Getting
50+
* notified about file operations</a> in the <i>Amazon S3 File Gateway User
51+
* Guide</i>.</p>
5052
* <important>
5153
* <ul>
5254
* <li>
@@ -64,8 +66,9 @@ export interface RefreshCacheCommandOutput extends RefreshCacheOutput, __Metadat
6466
* <p>The S3 bucket name does not need to be included when entering the list of folders in
6567
* the FolderList parameter.</p>
6668
* </note>
67-
* <p>For more information, see <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification">Getting notified about file operations</a> in the <i>Storage Gateway
68-
* User Guide</i>.</p>
69+
* <p>For more information, see <a href="https://docs.aws.amazon.com/filegateway/latest/files3/monitoring-file-gateway.html#get-notification">Getting
70+
* notified about file operations</a> in the <i>Amazon S3 File Gateway User
71+
* Guide</i>.</p>
6972
* @example
7073
* Use a bare-bones client and the command you need to make an API call.
7174
* ```javascript

‎clients/client-storage-gateway/src/commands/ShutdownGatewayCommand.ts

+6-2
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,12 @@ export interface ShutdownGatewayCommandOutput extends ShutdownGatewayOutput, __M
2828

2929
/**
3030
* @public
31-
* <p>Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource
32-
* Name (ARN) of the gateway in the body of your request.</p>
31+
* <p>Shuts down a Tape Gateway or Volume Gateway. To specify which gateway to shut down, use
32+
* the Amazon Resource Name (ARN) of the gateway in the body of your request.</p>
33+
* <note>
34+
* <p>This API action cannot be used to shut down S3 File Gateway or FSx File
35+
* Gateway.</p>
36+
* </note>
3337
* <p>The operation shuts down the gateway service component running in the gateway's
3438
* virtual machine (VM) and not the host VM.</p>
3539
* <note>

‎clients/client-storage-gateway/src/models/models_0.ts

+13
Original file line numberDiff line numberDiff line change
@@ -5432,6 +5432,19 @@ export interface GatewayInfo {
54325432
* host environment type.</p>
54335433
*/
54345434
HostEnvironmentId?: string;
5435+
5436+
/**
5437+
* @public
5438+
* <p>Date after which this gateway will not receive software updates for new features and bug
5439+
* fixes.</p>
5440+
*/
5441+
DeprecationDate?: string;
5442+
5443+
/**
5444+
* @public
5445+
* <p>The version number of the software running on the gateway appliance.</p>
5446+
*/
5447+
SoftwareVersion?: string;
54355448
}
54365449

54375450
/**

0 commit comments

Comments
 (0)
Please sign in to comment.