docs: add documentation for destroy method (aws#2204)

Author: AllanZhengYP

clients/client-accessanalyzer/AccessAnalyzerClient.ts

@@ -268,6 +268,11 @@ export class AccessAnalyzerClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-acm-pca/ACMPCAClient.ts

@@ -322,6 +322,11 @@ export class ACMPCAClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-acm/ACMClient.ts

@@ -261,6 +261,11 @@ export class ACMClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-alexa-for-business/AlexaForBusinessClient.ts

@@ -602,6 +602,11 @@ export class AlexaForBusinessClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-amplify/AmplifyClient.ts

@@ -345,6 +345,11 @@ export class AmplifyClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-amplifybackend/AmplifyBackendClient.ts

@@ -286,6 +286,11 @@ export class AmplifyBackendClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-api-gateway/APIGatewayClient.ts

@@ -670,6 +670,11 @@ export class APIGatewayClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-apigatewaymanagementapi/ApiGatewayManagementApiClient.ts

@@ -205,6 +205,11 @@ export class ApiGatewayManagementApiClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-apigatewayv2/ApiGatewayV2Client.ts

@@ -454,6 +454,11 @@ export class ApiGatewayV2Client extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-app-mesh/AppMeshClient.ts

@@ -376,6 +376,11 @@ export class AppMeshClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-appconfig/AppConfigClient.ts

@@ -394,6 +394,11 @@ export class AppConfigClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-appflow/AppflowClient.ts

@@ -307,6 +307,11 @@ export class AppflowClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-appintegrations/AppIntegrationsClient.ts

@@ -257,6 +257,11 @@ export class AppIntegrationsClient extends __Client<
     this.middlewareStack.use(getOmitRetryHeadersPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-application-auto-scaling/ApplicationAutoScalingClient.ts

@@ -320,6 +320,11 @@ export class ApplicationAutoScalingClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-application-discovery-service/ApplicationDiscoveryServiceClient.ts

@@ -445,6 +445,11 @@ export class ApplicationDiscoveryServiceClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-application-insights/ApplicationInsightsClient.ts

@@ -316,6 +316,11 @@ export class ApplicationInsightsClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-appstream/AppStreamClient.ts

@@ -414,6 +414,11 @@ export class AppStreamClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-appsync/AppSyncClient.ts

@@ -338,6 +338,11 @@ export class AppSyncClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-athena/AthenaClient.ts

@@ -307,6 +307,11 @@ export class AthenaClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-auditmanager/AuditManagerClient.ts

@@ -473,6 +473,11 @@ export class AuditManagerClient extends __Client<
     this.middlewareStack.use(getOmitRetryHeadersPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-auto-scaling-plans/AutoScalingPlansClient.ts

@@ -233,6 +233,11 @@ export class AutoScalingPlansClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-auto-scaling/AutoScalingClient.ts

@@ -499,6 +499,11 @@ export class AutoScalingClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-backup/BackupClient.ts

@@ -436,6 +436,11 @@ export class BackupClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-batch/BatchClient.ts

@@ -289,6 +289,11 @@ export class BatchClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-braket/BraketClient.ts

@@ -217,6 +217,11 @@ export class BraketClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-budgets/BudgetsClient.ts

@@ -331,6 +331,11 @@ export class BudgetsClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-chime/ChimeClient.ts

@@ -1095,6 +1095,11 @@ export class ChimeClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-cloud9/Cloud9Client.ts

@@ -319,6 +319,11 @@ export class Cloud9Client extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-clouddirectory/CloudDirectoryClient.ts

@@ -480,6 +480,11 @@ export class CloudDirectoryClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-cloudformation/CloudFormationClient.ts

@@ -447,6 +447,11 @@ export class CloudFormationClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-cloudfront/CloudFrontClient.ts

@@ -570,6 +570,11 @@ export class CloudFrontClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-cloudhsm-v2/CloudHSMV2Client.ts

@@ -248,6 +248,11 @@ export class CloudHSMV2Client extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }

clients/client-cloudhsm/CloudHSMClient.ts

@@ -275,6 +275,11 @@ export class CloudHSMClient extends __Client<
     this.middlewareStack.use(getUserAgentPlugin(this.config));
   }
 
+  /**
+   * Destroy underlying resources, like sockets. It's usually not necessary to do this.
+   * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
+   * Otherwise, sockets might stay open for quite a long time before the server terminates them.
+   */
   destroy(): void {
     super.destroy();
   }