feat(client-storage-gateway): Add SoftwareVersion to response of Desc…

…ribeGatewayInformation.
aws · Oct 5, 2023 · 79d3bd7 · 79d3bd7
1 parent 0cedc3d
commit 79d3bd7
Show file tree

Hide file tree

Showing 8 changed files with 84 additions and 62 deletions.
diff --git a/clients/client-storage-gateway/src/commands/DescribeGatewayInformationCommand.ts b/clients/client-storage-gateway/src/commands/DescribeGatewayInformationCommand.ts
@@ -14,7 +14,11 @@ import {
   SMITHY_CONTEXT_KEY,
 } from "@smithy/types";
 
-import { DescribeGatewayInformationInput, DescribeGatewayInformationOutput } from "../models/models_0";
+import {
+  DescribeGatewayInformationInput,
+  DescribeGatewayInformationOutput,
+  DescribeGatewayInformationOutputFilterSensitiveLog,
+} from "../models/models_0";
 import { de_DescribeGatewayInformationCommand, se_DescribeGatewayInformationCommand } from "../protocols/Aws_json1_1";
 import { ServiceInputTypes, ServiceOutputTypes, StorageGatewayClientResolvedConfig } from "../StorageGatewayClient";
 
@@ -37,9 +41,9 @@ export interface DescribeGatewayInformationCommandOutput extends DescribeGateway
 
 /**
  * @public
- * <p>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.</p>
+ * <p>Returns metadata about a gateway such as its name, network interfaces, time zone,
+ *          status, and software version. To specify which gateway to describe, use the Amazon Resource
+ *          Name (ARN) of the gateway in your request.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -86,6 +90,7 @@ export interface DescribeGatewayInformationCommandOutput extends DescribeGateway
  * //     "Small" || "Medium" || "Large",
  * //   ],
  * //   HostEnvironmentId: "STRING_VALUE",
+ * //   SoftwareVersion: "STRING_VALUE",
  * // };
  *
  * ```
@@ -185,7 +190,7 @@ export class DescribeGatewayInformationCommand extends $Command<
       clientName,
       commandName,
       inputFilterSensitiveLog: (_: any) => _,
-      outputFilterSensitiveLog: (_: any) => _,
+      outputFilterSensitiveLog: DescribeGatewayInformationOutputFilterSensitiveLog,
       [SMITHY_CONTEXT_KEY]: {
         service: "StorageGateway_20130630",
         operation: "DescribeGatewayInformation",

diff --git a/clients/client-storage-gateway/src/commands/JoinDomainCommand.ts b/clients/client-storage-gateway/src/commands/JoinDomainCommand.ts
@@ -39,6 +39,15 @@ export interface JoinDomainCommandOutput extends JoinDomainOutput, __MetadataBea
  * @public
  * <p>Adds a file gateway to an Active Directory domain. This operation is only supported for
  *          file gateways that support the SMB file protocol.</p>
+ *          <note>
+ *             <p>Joining a domain creates an Active Directory computer account in the default
+ *             organizational unit, using the gateway's <b>Gateway ID</b> as
+ *             the account name (for example, SGW-1234ADE). If your Active Directory environment
+ *             requires that you pre-stage accounts to facilitate the join domain process, you will
+ *             need to create this account ahead of time.</p>
+ *             <p>To create the gateway's computer account in an organizational unit other than the
+ *             default, you must specify the organizational unit when joining the domain.</p>
+ *          </note>
  * @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/ListFileSharesCommand.ts b/clients/client-storage-gateway/src/commands/ListFileSharesCommand.ts
@@ -38,8 +38,8 @@ export interface ListFileSharesCommandOutput extends ListFileSharesOutput, __Met
 /**
  * @public
  * <p>Gets a list of the file shares for a specific S3 File Gateway, or the list of file
- *          shares that belong to the calling user account. This operation is only supported for S3
- *          File Gateways.</p>
+ *          shares that belong to the calling Amazon Web Services account. This operation is only
+ *          supported for S3 File Gateways.</p>
  * @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/NotifyWhenUploadedCommand.ts b/clients/client-storage-gateway/src/commands/NotifyWhenUploadedCommand.ts
@@ -44,7 +44,8 @@ export interface NotifyWhenUploadedCommandOutput extends NotifyWhenUploadedOutpu
  *          make a request for notification. When the upload is done, Storage Gateway sends you
  *          notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to
  *          send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.</p>
- *          <p>For more information, see <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification">Getting file upload notification</a> in the <i>Storage Gateway User
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/filegateway/latest/files3/monitoring-file-gateway.html#get-notification">Getting
+ *             file upload notification</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.

diff --git a/clients/client-storage-gateway/src/commands/RefreshCacheCommand.ts b/clients/client-storage-gateway/src/commands/RefreshCacheCommand.ts
@@ -62,10 +62,6 @@ export interface RefreshCacheCommandOutput extends RefreshCacheOutput, __Metadat
  *                   <p>Wait at least 60 seconds between consecutive RefreshCache API requests.</p>
  *                </li>
  *                <li>
- *                   <p>RefreshCache does not evict cache entries if invoked consecutively within 60
- *                   seconds of a previous RefreshCache request.</p>
- *                </li>
- *                <li>
  *                   <p>If you invoke the RefreshCache API when two requests are already being
  *                   processed, any new request will cause an
  *                      <code>InvalidGatewayRequestException</code> error because too many requests

diff --git a/clients/client-storage-gateway/src/commands/UpdateBandwidthRateLimitScheduleCommand.ts b/clients/client-storage-gateway/src/commands/UpdateBandwidthRateLimitScheduleCommand.ts
@@ -45,8 +45,9 @@ export interface UpdateBandwidthRateLimitScheduleCommandOutput
  * <p> Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways
  *          do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in
  *          effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This
- *          operation is supported only for volume, tape and S3 file gateways. FSx file gateways do not
- *          support bandwidth rate limits.</p>
+ *          operation is supported for volume, tape, and S3 file gateways. S3 file gateways support
+ *          bandwidth rate limits for upload only. FSx file gateways do not support bandwidth rate
+ *          limits.</p>
  * @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/models/models_0.ts b/clients/client-storage-gateway/src/models/models_0.ts
@@ -854,8 +854,12 @@ export interface BandwidthRateLimitInterval {
   /**
    * @public
    * <p> The average upload rate limit component of the bandwidth rate limit interval, in bits
-   *          per second. This field does not appear in the response if the upload rate limit is not set.
-   *       </p>
+   *          per second. This field does not appear in the response if the upload rate limit is not set. </p>
+   *          <note>
+   *             <p>For Tape Gateway and Volume Gateway, the minimum value is <code>51200</code>.</p>
+   *             <p>For S3 File Gateway and FSx File Gateway, the minimum value is
+   *             <code>104857600</code>.</p>
+   *          </note>
    */
   AverageUploadRateLimitInBitsPerSec?: number;
 
@@ -3350,6 +3354,12 @@ export interface DescribeGatewayInformationOutput {
    *          host environment type.</p>
    */
   HostEnvironmentId?: string;
+
+  /**
+   * @public
+   * <p>The version number of the software running on the gateway appliance.</p>
+   */
+  SoftwareVersion?: string;
 }
 
 /**
@@ -7671,6 +7681,21 @@ export const DescribeChapCredentialsOutputFilterSensitiveLog = (obj: DescribeCha
   ...(obj.ChapCredentials && { ChapCredentials: obj.ChapCredentials.map((item) => ChapInfoFilterSensitiveLog(item)) }),
 });
 
+/**
+ * @internal
+ */
+export const NetworkInterfaceFilterSensitiveLog = (obj: NetworkInterface): any => ({
+  ...obj,
+});
+
+/**
+ * @internal
+ */
+export const DescribeGatewayInformationOutputFilterSensitiveLog = (obj: DescribeGatewayInformationOutput): any => ({
+  ...obj,
+  ...(obj.GatewayNetworkInterfaces && { GatewayNetworkInterfaces: SENSITIVE_STRING }),
+});
+
 /**
  * @internal
  */