Skip to content

Commit

Permalink
feat(client-storage-gateway): Add DeprecationDate and SoftwareVersion…
Browse files Browse the repository at this point in the history
… to response of ListGateways.
  • Loading branch information
awstools committed Jan 24, 2024
1 parent 9e30002 commit ee421ea
Show file tree
Hide file tree
Showing 7 changed files with 70 additions and 17 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,16 @@ export interface DescribeTapesCommandOutput extends DescribeTapesOutput, __Metad

/**
* @public
* <p>Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a
* <code>TapeARN</code> 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.</p>
* <p>Returns a description of virtual tapes that correspond to the specified Amazon Resource
* Names (ARNs). If <code>TapeARN</code> 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.</p>
* <p>The operation supports pagination. By default, the operation returns a maximum of up to
* 100 tapes. You can optionally specify the <code>Limit</code> 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 <code>Marker</code> field. You can use this
* <code>Marker</code> value in your subsequent request to retrieve the next set of
* tapes.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ export interface ListGatewaysCommandOutput extends ListGatewaysOutput, __Metadat
* // Ec2InstanceRegion: "STRING_VALUE",
* // HostEnvironment: "VMWARE" || "HYPER-V" || "EC2" || "KVM" || "OTHER" || "SNOWBALL",
* // HostEnvironmentId: "STRING_VALUE",
* // DeprecationDate: "STRING_VALUE",
* // SoftwareVersion: "STRING_VALUE",
* // },
* // ],
* // Marker: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export interface NotifyWhenUploadedCommandOutput extends NotifyWhenUploadedOutpu
/**
* @public
* <p>Sends you notification through CloudWatch Events when all files written to your file
* share have been uploaded to S3. Amazon S3.</p>
* share have been uploaded to Amazon S3.</p>
* <p>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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.</p>
* <p>You can subscribe to be notified through an Amazon CloudWatch event when your
* <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
* User Guide</i>. This operation is Only supported for S3 File Gateways.</p>
* <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
* notified about file operations</a> in the <i>Amazon S3 File Gateway User
* Guide</i>. This operation is Only supported for S3 File Gateways.</p>
* <p>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
Expand All @@ -45,8 +46,9 @@ export interface RefreshCacheCommandOutput extends RefreshCacheOutput, __Metadat
* operation completes.</p>
* <p>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 <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
* User Guide</i>.</p>
* 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
* notified about file operations</a> in the <i>Amazon S3 File Gateway User
* Guide</i>.</p>
* <important>
* <ul>
* <li>
Expand All @@ -64,8 +66,9 @@ export interface RefreshCacheCommandOutput extends RefreshCacheOutput, __Metadat
* <p>The S3 bucket name does not need to be included when entering the list of folders in
* the FolderList parameter.</p>
* </note>
* <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
* User Guide</i>.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/filegateway/latest/files3/monitoring-file-gateway.html#get-notification">Getting
* notified about file operations</a> in the <i>Amazon S3 File Gateway User
* Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,12 @@ export interface ShutdownGatewayCommandOutput extends ShutdownGatewayOutput, __M

/**
* @public
* <p>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.</p>
* <p>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.</p>
* <note>
* <p>This API action cannot be used to shut down S3 File Gateway or FSx File
* Gateway.</p>
* </note>
* <p>The operation shuts down the gateway service component running in the gateway's
* virtual machine (VM) and not the host VM.</p>
* <note>
Expand Down
13 changes: 13 additions & 0 deletions clients/client-storage-gateway/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5432,6 +5432,19 @@ export interface GatewayInfo {
* host environment type.</p>
*/
HostEnvironmentId?: string;

/**
* @public
* <p>Date after which this gateway will not receive software updates for new features and bug
* fixes.</p>
*/
DeprecationDate?: string;

/**
* @public
* <p>The version number of the software running on the gateway appliance.</p>
*/
SoftwareVersion?: string;
}

/**
Expand Down

0 comments on commit ee421ea

Please sign in to comment.