docs(clients): use interface for client input and resolved config

aws · Apr 16, 2021 · da68d81 · da68d81
1 parent 5fe8ed6
commit da68d81
Show file tree

Hide file tree

Showing 252 changed files with 3,286 additions and 504 deletions.
diff --git a/clients/client-accessanalyzer/AccessAnalyzerClient.ts b/clients/client-accessanalyzer/AccessAnalyzerClient.ts
@@ -212,23 +212,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
   defaultUserAgentProvider?: Provider<__UserAgent>;
 }
 
-export type AccessAnalyzerClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
+type AccessAnalyzerClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
   ClientDefaults &
   RegionInputConfig &
   EndpointsInputConfig &
   RetryInputConfig &
   HostHeaderInputConfig &
   AwsAuthInputConfig &
   UserAgentInputConfig;
+/**
+ * The configuration interface of AccessAnalyzerClient class constructor that set the region, credentials and other options.
+ */
+export interface AccessAnalyzerClientConfig extends AccessAnalyzerClientConfigType {}
 
-export type AccessAnalyzerClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
+type AccessAnalyzerClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
   Required<ClientDefaults> &
   RegionResolvedConfig &
   EndpointsResolvedConfig &
   RetryResolvedConfig &
   HostHeaderResolvedConfig &
   AwsAuthResolvedConfig &
   UserAgentResolvedConfig;
+/**
+ * The resolved configuration interface of AccessAnalyzerClient class. This is resolved and normalized from the {@link AccessAnalyzerClientConfig | constructor configuration interface}.
+ */
+export interface AccessAnalyzerClientResolvedConfig extends AccessAnalyzerClientResolvedConfigType {}
 
 /**
  * <p>AWS IAM Access Analyzer helps identify potential resource-access risks by enabling you to identify
@@ -245,6 +253,9 @@ export class AccessAnalyzerClient extends __Client<
   ServiceOutputTypes,
   AccessAnalyzerClientResolvedConfig
 > {
+  /**
+   * The resolved configuration of AccessAnalyzerClient class. This is resolved and normalized from the {@link AccessAnalyzerClientConfig | constructor configuration interface}.
+   */
   readonly config: AccessAnalyzerClientResolvedConfig;
 
   constructor(configuration: AccessAnalyzerClientConfig) {

diff --git a/clients/client-acm-pca/ACMPCAClient.ts b/clients/client-acm-pca/ACMPCAClient.ts
@@ -257,23 +257,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
   defaultUserAgentProvider?: Provider<__UserAgent>;
 }
 
-export type ACMPCAClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
+type ACMPCAClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
   ClientDefaults &
   RegionInputConfig &
   EndpointsInputConfig &
   RetryInputConfig &
   HostHeaderInputConfig &
   AwsAuthInputConfig &
   UserAgentInputConfig;
+/**
+ * The configuration interface of ACMPCAClient class constructor that set the region, credentials and other options.
+ */
+export interface ACMPCAClientConfig extends ACMPCAClientConfigType {}
 
-export type ACMPCAClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
+type ACMPCAClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
   Required<ClientDefaults> &
   RegionResolvedConfig &
   EndpointsResolvedConfig &
   RetryResolvedConfig &
   HostHeaderResolvedConfig &
   AwsAuthResolvedConfig &
   UserAgentResolvedConfig;
+/**
+ * The resolved configuration interface of ACMPCAClient class. This is resolved and normalized from the {@link ACMPCAClientConfig | constructor configuration interface}.
+ */
+export interface ACMPCAClientResolvedConfig extends ACMPCAClientResolvedConfigType {}
 
 /**
  * <note>
@@ -299,6 +307,9 @@ export class ACMPCAClient extends __Client<
   ServiceOutputTypes,
   ACMPCAClientResolvedConfig
 > {
+  /**
+   * The resolved configuration of ACMPCAClient class. This is resolved and normalized from the {@link ACMPCAClientConfig | constructor configuration interface}.
+   */
   readonly config: ACMPCAClientResolvedConfig;
 
   constructor(configuration: ACMPCAClientConfig) {

diff --git a/clients/client-acm/ACMClient.ts b/clients/client-acm/ACMClient.ts
@@ -206,23 +206,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
   defaultUserAgentProvider?: Provider<__UserAgent>;
 }
 
-export type ACMClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
+type ACMClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
   ClientDefaults &
   RegionInputConfig &
   EndpointsInputConfig &
   RetryInputConfig &
   HostHeaderInputConfig &
   AwsAuthInputConfig &
   UserAgentInputConfig;
+/**
+ * The configuration interface of ACMClient class constructor that set the region, credentials and other options.
+ */
+export interface ACMClientConfig extends ACMClientConfigType {}
 
-export type ACMClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
+type ACMClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
   Required<ClientDefaults> &
   RegionResolvedConfig &
   EndpointsResolvedConfig &
   RetryResolvedConfig &
   HostHeaderResolvedConfig &
   AwsAuthResolvedConfig &
   UserAgentResolvedConfig;
+/**
+ * The resolved configuration interface of ACMClient class. This is resolved and normalized from the {@link ACMClientConfig | constructor configuration interface}.
+ */
+export interface ACMClientResolvedConfig extends ACMClientResolvedConfigType {}
 
 /**
  * <fullname>AWS Certificate Manager</fullname>
@@ -238,6 +246,9 @@ export class ACMClient extends __Client<
   ServiceOutputTypes,
   ACMClientResolvedConfig
 > {
+  /**
+   * The resolved configuration of ACMClient class. This is resolved and normalized from the {@link ACMClientConfig | constructor configuration interface}.
+   */
   readonly config: ACMClientResolvedConfig;
 
   constructor(configuration: ACMClientConfig) {

diff --git a/clients/client-alexa-for-business/AlexaForBusinessClient.ts b/clients/client-alexa-for-business/AlexaForBusinessClient.ts
@@ -545,23 +545,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
   defaultUserAgentProvider?: Provider<__UserAgent>;
 }
 
-export type AlexaForBusinessClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
+type AlexaForBusinessClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
   ClientDefaults &
   RegionInputConfig &
   EndpointsInputConfig &
   RetryInputConfig &
   HostHeaderInputConfig &
   AwsAuthInputConfig &
   UserAgentInputConfig;
+/**
+ * The configuration interface of AlexaForBusinessClient class constructor that set the region, credentials and other options.
+ */
+export interface AlexaForBusinessClientConfig extends AlexaForBusinessClientConfigType {}
 
-export type AlexaForBusinessClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
+type AlexaForBusinessClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
   Required<ClientDefaults> &
   RegionResolvedConfig &
   EndpointsResolvedConfig &
   RetryResolvedConfig &
   HostHeaderResolvedConfig &
   AwsAuthResolvedConfig &
   UserAgentResolvedConfig;
+/**
+ * The resolved configuration interface of AlexaForBusinessClient class. This is resolved and normalized from the {@link AlexaForBusinessClientConfig | constructor configuration interface}.
+ */
+export interface AlexaForBusinessClientResolvedConfig extends AlexaForBusinessClientResolvedConfigType {}
 
 /**
  * <p>Alexa for Business helps you use Alexa in your organization. Alexa for Business provides you with the tools
@@ -579,6 +587,9 @@ export class AlexaForBusinessClient extends __Client<
   ServiceOutputTypes,
   AlexaForBusinessClientResolvedConfig
 > {
+  /**
+   * The resolved configuration of AlexaForBusinessClient class. This is resolved and normalized from the {@link AlexaForBusinessClientConfig | constructor configuration interface}.
+   */
   readonly config: AlexaForBusinessClientResolvedConfig;
 
   constructor(configuration: AlexaForBusinessClientConfig) {

diff --git a/clients/client-amplify/AmplifyClient.ts b/clients/client-amplify/AmplifyClient.ts
@@ -290,23 +290,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
   defaultUserAgentProvider?: Provider<__UserAgent>;
 }
 
-export type AmplifyClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
+type AmplifyClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
   ClientDefaults &
   RegionInputConfig &
   EndpointsInputConfig &
   RetryInputConfig &
   HostHeaderInputConfig &
   AwsAuthInputConfig &
   UserAgentInputConfig;
+/**
+ * The configuration interface of AmplifyClient class constructor that set the region, credentials and other options.
+ */
+export interface AmplifyClientConfig extends AmplifyClientConfigType {}
 
-export type AmplifyClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
+type AmplifyClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
   Required<ClientDefaults> &
   RegionResolvedConfig &
   EndpointsResolvedConfig &
   RetryResolvedConfig &
   HostHeaderResolvedConfig &
   AwsAuthResolvedConfig &
   UserAgentResolvedConfig;
+/**
+ * The resolved configuration interface of AmplifyClient class. This is resolved and normalized from the {@link AmplifyClientConfig | constructor configuration interface}.
+ */
+export interface AmplifyClientResolvedConfig extends AmplifyClientResolvedConfigType {}
 
 /**
  * <p>Amplify enables developers to develop and deploy cloud-powered mobile and web apps.
@@ -322,6 +330,9 @@ export class AmplifyClient extends __Client<
   ServiceOutputTypes,
   AmplifyClientResolvedConfig
 > {
+  /**
+   * The resolved configuration of AmplifyClient class. This is resolved and normalized from the {@link AmplifyClientConfig | constructor configuration interface}.
+   */
   readonly config: AmplifyClientResolvedConfig;
 
   constructor(configuration: AmplifyClientConfig) {

diff --git a/clients/client-amplifybackend/AmplifyBackendClient.ts b/clients/client-amplifybackend/AmplifyBackendClient.ts
@@ -236,23 +236,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
   defaultUserAgentProvider?: Provider<__UserAgent>;
 }
 
-export type AmplifyBackendClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
+type AmplifyBackendClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
   ClientDefaults &
   RegionInputConfig &
   EndpointsInputConfig &
   RetryInputConfig &
   HostHeaderInputConfig &
   AwsAuthInputConfig &
   UserAgentInputConfig;
+/**
+ * The configuration interface of AmplifyBackendClient class constructor that set the region, credentials and other options.
+ */
+export interface AmplifyBackendClientConfig extends AmplifyBackendClientConfigType {}
 
-export type AmplifyBackendClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
+type AmplifyBackendClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
   Required<ClientDefaults> &
   RegionResolvedConfig &
   EndpointsResolvedConfig &
   RetryResolvedConfig &
   HostHeaderResolvedConfig &
   AwsAuthResolvedConfig &
   UserAgentResolvedConfig;
+/**
+ * The resolved configuration interface of AmplifyBackendClient class. This is resolved and normalized from the {@link AmplifyBackendClientConfig | constructor configuration interface}.
+ */
+export interface AmplifyBackendClientResolvedConfig extends AmplifyBackendClientResolvedConfigType {}
 
 /**
  * <p>AWS Amplify Admin API</p>
@@ -263,6 +271,9 @@ export class AmplifyBackendClient extends __Client<
   ServiceOutputTypes,
   AmplifyBackendClientResolvedConfig
 > {
+  /**
+   * The resolved configuration of AmplifyBackendClient class. This is resolved and normalized from the {@link AmplifyBackendClientConfig | constructor configuration interface}.
+   */
   readonly config: AmplifyBackendClientResolvedConfig;
 
   constructor(configuration: AmplifyBackendClientConfig) {

diff --git a/clients/client-api-gateway/APIGatewayClient.ts b/clients/client-api-gateway/APIGatewayClient.ts
@@ -618,23 +618,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
   defaultUserAgentProvider?: Provider<__UserAgent>;
 }
 
-export type APIGatewayClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
+type APIGatewayClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
   ClientDefaults &
   RegionInputConfig &
   EndpointsInputConfig &
   RetryInputConfig &
   HostHeaderInputConfig &
   AwsAuthInputConfig &
   UserAgentInputConfig;
+/**
+ * The configuration interface of APIGatewayClient class constructor that set the region, credentials and other options.
+ */
+export interface APIGatewayClientConfig extends APIGatewayClientConfigType {}
 
-export type APIGatewayClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
+type APIGatewayClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
   Required<ClientDefaults> &
   RegionResolvedConfig &
   EndpointsResolvedConfig &
   RetryResolvedConfig &
   HostHeaderResolvedConfig &
   AwsAuthResolvedConfig &
   UserAgentResolvedConfig;
+/**
+ * The resolved configuration interface of APIGatewayClient class. This is resolved and normalized from the {@link APIGatewayClientConfig | constructor configuration interface}.
+ */
+export interface APIGatewayClientResolvedConfig extends APIGatewayClientResolvedConfigType {}
 
 /**
  * <fullname>Amazon API Gateway</fullname>
@@ -646,6 +654,9 @@ export class APIGatewayClient extends __Client<
   ServiceOutputTypes,
   APIGatewayClientResolvedConfig
 > {
+  /**
+   * The resolved configuration of APIGatewayClient class. This is resolved and normalized from the {@link APIGatewayClientConfig | constructor configuration interface}.
+   */
   readonly config: APIGatewayClientResolvedConfig;
 
   constructor(configuration: APIGatewayClientConfig) {

diff --git a/clients/client-apigatewaymanagementapi/ApiGatewayManagementApiClient.ts b/clients/client-apigatewaymanagementapi/ApiGatewayManagementApiClient.ts
@@ -155,23 +155,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
   defaultUserAgentProvider?: Provider<__UserAgent>;
 }
 
-export type ApiGatewayManagementApiClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
+type ApiGatewayManagementApiClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
   ClientDefaults &
   RegionInputConfig &
   EndpointsInputConfig &
   RetryInputConfig &
   HostHeaderInputConfig &
   AwsAuthInputConfig &
   UserAgentInputConfig;
+/**
+ * The configuration interface of ApiGatewayManagementApiClient class constructor that set the region, credentials and other options.
+ */
+export interface ApiGatewayManagementApiClientConfig extends ApiGatewayManagementApiClientConfigType {}
 
-export type ApiGatewayManagementApiClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
+type ApiGatewayManagementApiClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
   Required<ClientDefaults> &
   RegionResolvedConfig &
   EndpointsResolvedConfig &
   RetryResolvedConfig &
   HostHeaderResolvedConfig &
   AwsAuthResolvedConfig &
   UserAgentResolvedConfig;
+/**
+ * The resolved configuration interface of ApiGatewayManagementApiClient class. This is resolved and normalized from the {@link ApiGatewayManagementApiClientConfig | constructor configuration interface}.
+ */
+export interface ApiGatewayManagementApiClientResolvedConfig extends ApiGatewayManagementApiClientResolvedConfigType {}
 
 /**
  * <p>The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://{api-id}.execute-api.{region}.amazonaws.com/{stage}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.</p>
@@ -182,6 +190,9 @@ export class ApiGatewayManagementApiClient extends __Client<
   ServiceOutputTypes,
   ApiGatewayManagementApiClientResolvedConfig
 > {
+  /**
+   * The resolved configuration of ApiGatewayManagementApiClient class. This is resolved and normalized from the {@link ApiGatewayManagementApiClientConfig | constructor configuration interface}.
+   */
   readonly config: ApiGatewayManagementApiClientResolvedConfig;
 
   constructor(configuration: ApiGatewayManagementApiClientConfig) {

diff --git a/clients/client-apigatewayv2/ApiGatewayV2Client.ts b/clients/client-apigatewayv2/ApiGatewayV2Client.ts
@@ -404,23 +404,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
   defaultUserAgentProvider?: Provider<__UserAgent>;
 }
 
-export type ApiGatewayV2ClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
+type ApiGatewayV2ClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
   ClientDefaults &
   RegionInputConfig &
   EndpointsInputConfig &
   RetryInputConfig &
   HostHeaderInputConfig &
   AwsAuthInputConfig &
   UserAgentInputConfig;
+/**
+ * The configuration interface of ApiGatewayV2Client class constructor that set the region, credentials and other options.
+ */
+export interface ApiGatewayV2ClientConfig extends ApiGatewayV2ClientConfigType {}
 
-export type ApiGatewayV2ClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
+type ApiGatewayV2ClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
   Required<ClientDefaults> &
   RegionResolvedConfig &
   EndpointsResolvedConfig &
   RetryResolvedConfig &
   HostHeaderResolvedConfig &
   AwsAuthResolvedConfig &
   UserAgentResolvedConfig;
+/**
+ * The resolved configuration interface of ApiGatewayV2Client class. This is resolved and normalized from the {@link ApiGatewayV2ClientConfig | constructor configuration interface}.
+ */
+export interface ApiGatewayV2ClientResolvedConfig extends ApiGatewayV2ClientResolvedConfigType {}
 
 /**
  * <p>Amazon API Gateway V2</p>
@@ -431,6 +439,9 @@ export class ApiGatewayV2Client extends __Client<
   ServiceOutputTypes,
   ApiGatewayV2ClientResolvedConfig
 > {
+  /**
+   * The resolved configuration of ApiGatewayV2Client class. This is resolved and normalized from the {@link ApiGatewayV2ClientConfig | constructor configuration interface}.
+   */
   readonly config: ApiGatewayV2ClientResolvedConfig;
 
   constructor(configuration: ApiGatewayV2ClientConfig) {