@aws-sdk/client-api-gateway 3.296.0 → 3.298.0

package/dist-types/APIGatewayClient.d.ts

@@ -128,15 +128,24 @@ import { UpdateUsageCommandInput, UpdateUsageCommandOutput } from "./commands/Up
 import { UpdateUsagePlanCommandInput, UpdateUsagePlanCommandOutput } from "./commands/UpdateUsagePlanCommand";
 import { UpdateVpcLinkCommandInput, UpdateVpcLinkCommandOutput } from "./commands/UpdateVpcLinkCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = CreateApiKeyCommandInput | CreateAuthorizerCommandInput | CreateBasePathMappingCommandInput | CreateDeploymentCommandInput | CreateDocumentationPartCommandInput | CreateDocumentationVersionCommandInput | CreateDomainNameCommandInput | CreateModelCommandInput | CreateRequestValidatorCommandInput | CreateResourceCommandInput | CreateRestApiCommandInput | CreateStageCommandInput | CreateUsagePlanCommandInput | CreateUsagePlanKeyCommandInput | CreateVpcLinkCommandInput | DeleteApiKeyCommandInput | DeleteAuthorizerCommandInput | DeleteBasePathMappingCommandInput | DeleteClientCertificateCommandInput | DeleteDeploymentCommandInput | DeleteDocumentationPartCommandInput | DeleteDocumentationVersionCommandInput | DeleteDomainNameCommandInput | DeleteGatewayResponseCommandInput | DeleteIntegrationCommandInput | DeleteIntegrationResponseCommandInput | DeleteMethodCommandInput | DeleteMethodResponseCommandInput | DeleteModelCommandInput | DeleteRequestValidatorCommandInput | DeleteResourceCommandInput | DeleteRestApiCommandInput | DeleteStageCommandInput | DeleteUsagePlanCommandInput | DeleteUsagePlanKeyCommandInput | DeleteVpcLinkCommandInput | FlushStageAuthorizersCacheCommandInput | FlushStageCacheCommandInput | GenerateClientCertificateCommandInput | GetAccountCommandInput | GetApiKeyCommandInput | GetApiKeysCommandInput | GetAuthorizerCommandInput | GetAuthorizersCommandInput | GetBasePathMappingCommandInput | GetBasePathMappingsCommandInput | GetClientCertificateCommandInput | GetClientCertificatesCommandInput | GetDeploymentCommandInput | GetDeploymentsCommandInput | GetDocumentationPartCommandInput | GetDocumentationPartsCommandInput | GetDocumentationVersionCommandInput | GetDocumentationVersionsCommandInput | GetDomainNameCommandInput | GetDomainNamesCommandInput | GetExportCommandInput | GetGatewayResponseCommandInput | GetGatewayResponsesCommandInput | GetIntegrationCommandInput | GetIntegrationResponseCommandInput | GetMethodCommandInput | GetMethodResponseCommandInput | GetModelCommandInput | GetModelTemplateCommandInput | GetModelsCommandInput | GetRequestValidatorCommandInput | GetRequestValidatorsCommandInput | GetResourceCommandInput | GetResourcesCommandInput | GetRestApiCommandInput | GetRestApisCommandInput | GetSdkCommandInput | GetSdkTypeCommandInput | GetSdkTypesCommandInput | GetStageCommandInput | GetStagesCommandInput | GetTagsCommandInput | GetUsageCommandInput | GetUsagePlanCommandInput | GetUsagePlanKeyCommandInput | GetUsagePlanKeysCommandInput | GetUsagePlansCommandInput | GetVpcLinkCommandInput | GetVpcLinksCommandInput | ImportApiKeysCommandInput | ImportDocumentationPartsCommandInput | ImportRestApiCommandInput | PutGatewayResponseCommandInput | PutIntegrationCommandInput | PutIntegrationResponseCommandInput | PutMethodCommandInput | PutMethodResponseCommandInput | PutRestApiCommandInput | TagResourceCommandInput | TestInvokeAuthorizerCommandInput | TestInvokeMethodCommandInput | UntagResourceCommandInput | UpdateAccountCommandInput | UpdateApiKeyCommandInput | UpdateAuthorizerCommandInput | UpdateBasePathMappingCommandInput | UpdateClientCertificateCommandInput | UpdateDeploymentCommandInput | UpdateDocumentationPartCommandInput | UpdateDocumentationVersionCommandInput | UpdateDomainNameCommandInput | UpdateGatewayResponseCommandInput | UpdateIntegrationCommandInput | UpdateIntegrationResponseCommandInput | UpdateMethodCommandInput | UpdateMethodResponseCommandInput | UpdateModelCommandInput | UpdateRequestValidatorCommandInput | UpdateResourceCommandInput | UpdateRestApiCommandInput | UpdateStageCommandInput | UpdateUsageCommandInput | UpdateUsagePlanCommandInput | UpdateVpcLinkCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = CreateApiKeyCommandOutput | CreateAuthorizerCommandOutput | CreateBasePathMappingCommandOutput | CreateDeploymentCommandOutput | CreateDocumentationPartCommandOutput | CreateDocumentationVersionCommandOutput | CreateDomainNameCommandOutput | CreateModelCommandOutput | CreateRequestValidatorCommandOutput | CreateResourceCommandOutput | CreateRestApiCommandOutput | CreateStageCommandOutput | CreateUsagePlanCommandOutput | CreateUsagePlanKeyCommandOutput | CreateVpcLinkCommandOutput | DeleteApiKeyCommandOutput | DeleteAuthorizerCommandOutput | DeleteBasePathMappingCommandOutput | DeleteClientCertificateCommandOutput | DeleteDeploymentCommandOutput | DeleteDocumentationPartCommandOutput | DeleteDocumentationVersionCommandOutput | DeleteDomainNameCommandOutput | DeleteGatewayResponseCommandOutput | DeleteIntegrationCommandOutput | DeleteIntegrationResponseCommandOutput | DeleteMethodCommandOutput | DeleteMethodResponseCommandOutput | DeleteModelCommandOutput | DeleteRequestValidatorCommandOutput | DeleteResourceCommandOutput | DeleteRestApiCommandOutput | DeleteStageCommandOutput | DeleteUsagePlanCommandOutput | DeleteUsagePlanKeyCommandOutput | DeleteVpcLinkCommandOutput | FlushStageAuthorizersCacheCommandOutput | FlushStageCacheCommandOutput | GenerateClientCertificateCommandOutput | GetAccountCommandOutput | GetApiKeyCommandOutput | GetApiKeysCommandOutput | GetAuthorizerCommandOutput | GetAuthorizersCommandOutput | GetBasePathMappingCommandOutput | GetBasePathMappingsCommandOutput | GetClientCertificateCommandOutput | GetClientCertificatesCommandOutput | GetDeploymentCommandOutput | GetDeploymentsCommandOutput | GetDocumentationPartCommandOutput | GetDocumentationPartsCommandOutput | GetDocumentationVersionCommandOutput | GetDocumentationVersionsCommandOutput | GetDomainNameCommandOutput | GetDomainNamesCommandOutput | GetExportCommandOutput | GetGatewayResponseCommandOutput | GetGatewayResponsesCommandOutput | GetIntegrationCommandOutput | GetIntegrationResponseCommandOutput | GetMethodCommandOutput | GetMethodResponseCommandOutput | GetModelCommandOutput | GetModelTemplateCommandOutput | GetModelsCommandOutput | GetRequestValidatorCommandOutput | GetRequestValidatorsCommandOutput | GetResourceCommandOutput | GetResourcesCommandOutput | GetRestApiCommandOutput | GetRestApisCommandOutput | GetSdkCommandOutput | GetSdkTypeCommandOutput | GetSdkTypesCommandOutput | GetStageCommandOutput | GetStagesCommandOutput | GetTagsCommandOutput | GetUsageCommandOutput | GetUsagePlanCommandOutput | GetUsagePlanKeyCommandOutput | GetUsagePlanKeysCommandOutput | GetUsagePlansCommandOutput | GetVpcLinkCommandOutput | GetVpcLinksCommandOutput | ImportApiKeysCommandOutput | ImportDocumentationPartsCommandOutput | ImportRestApiCommandOutput | PutGatewayResponseCommandOutput | PutIntegrationCommandOutput | PutIntegrationResponseCommandOutput | PutMethodCommandOutput | PutMethodResponseCommandOutput | PutRestApiCommandOutput | TagResourceCommandOutput | TestInvokeAuthorizerCommandOutput | TestInvokeMethodCommandOutput | UntagResourceCommandOutput | UpdateAccountCommandOutput | UpdateApiKeyCommandOutput | UpdateAuthorizerCommandOutput | UpdateBasePathMappingCommandOutput | UpdateClientCertificateCommandOutput | UpdateDeploymentCommandOutput | UpdateDocumentationPartCommandOutput | UpdateDocumentationVersionCommandOutput | UpdateDomainNameCommandOutput | UpdateGatewayResponseCommandOutput | UpdateIntegrationCommandOutput | UpdateIntegrationResponseCommandOutput | UpdateMethodCommandOutput | UpdateMethodResponseCommandOutput | UpdateModelCommandOutput | UpdateRequestValidatorCommandOutput | UpdateResourceCommandOutput | UpdateRestApiCommandOutput | UpdateStageCommandOutput | UpdateUsageCommandOutput | UpdateUsagePlanCommandOutput | UpdateVpcLinkCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -226,23 +235,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type APIGatewayClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of APIGatewayClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of APIGatewayClient class constructor that set the region, credentials and other options.
  */
 export interface APIGatewayClientConfig extends APIGatewayClientConfigType {
 }
+/**
+ * @public
+ */
 type APIGatewayClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of APIGatewayClient class. This is resolved and normalized from the {@link APIGatewayClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of APIGatewayClient class. This is resolved and normalized from the {@link APIGatewayClientConfig | constructor configuration interface}.
  */
 export interface APIGatewayClientResolvedConfig extends APIGatewayClientResolvedConfigType {
 }
 /**
+ * @public
  * <fullname>Amazon API Gateway</fullname>
  *          <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
  */

package/dist-types/commands/CreateApiKeyCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { APIGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../APIGatewayClient";
 import { ApiKey, CreateApiKeyRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateApiKeyCommand}.
  */
 export interface CreateApiKeyCommandInput extends CreateApiKeyRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateApiKeyCommand}.
  */
 export interface CreateApiKeyCommandOutput extends ApiKey, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Create an ApiKey resource. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateApiKeyCommandOutput extends ApiKey, __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateApiKeyCommandInput - {@link CreateApiKeyCommandInput}
+ * @returns {@link CreateApiKeyCommandOutput}
  * @see {@link CreateApiKeyCommandInput} for command's `input` shape.
  * @see {@link CreateApiKeyCommandOutput} for command's `response` shape.
  * @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape.
@@ -52,11 +59,20 @@ export interface CreateApiKeyCommandOutput extends ApiKey, __MetadataBearer {
 export declare class CreateApiKeyCommand extends $Command<CreateApiKeyCommandInput, CreateApiKeyCommandOutput, APIGatewayClientResolvedConfig> {
     readonly input: CreateApiKeyCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateApiKeyCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: APIGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateApiKeyCommandInput, CreateApiKeyCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CreateAuthorizerCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { APIGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../APIGatewayClient";
 import { Authorizer, CreateAuthorizerRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateAuthorizerCommand}.
  */
 export interface CreateAuthorizerCommandInput extends CreateAuthorizerRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateAuthorizerCommand}.
  */
 export interface CreateAuthorizerCommandOutput extends Authorizer, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Adds a new Authorizer resource to an existing RestApi resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateAuthorizerCommandOutput extends Authorizer, __MetadataBea
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateAuthorizerCommandInput - {@link CreateAuthorizerCommandInput}
+ * @returns {@link CreateAuthorizerCommandOutput}
  * @see {@link CreateAuthorizerCommandInput} for command's `input` shape.
  * @see {@link CreateAuthorizerCommandOutput} for command's `response` shape.
  * @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape.
@@ -52,11 +59,20 @@ export interface CreateAuthorizerCommandOutput extends Authorizer, __MetadataBea
 export declare class CreateAuthorizerCommand extends $Command<CreateAuthorizerCommandInput, CreateAuthorizerCommandOutput, APIGatewayClientResolvedConfig> {
     readonly input: CreateAuthorizerCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateAuthorizerCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: APIGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAuthorizerCommandInput, CreateAuthorizerCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CreateBasePathMappingCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { APIGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../APIGatewayClient";
 import { BasePathMapping, CreateBasePathMappingRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateBasePathMappingCommand}.
  */
 export interface CreateBasePathMappingCommandInput extends CreateBasePathMappingRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateBasePathMappingCommand}.
  */
 export interface CreateBasePathMappingCommandOutput extends BasePathMapping, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a new BasePathMapping resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateBasePathMappingCommandOutput extends BasePathMapping, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateBasePathMappingCommandInput - {@link CreateBasePathMappingCommandInput}
+ * @returns {@link CreateBasePathMappingCommandOutput}
  * @see {@link CreateBasePathMappingCommandInput} for command's `input` shape.
  * @see {@link CreateBasePathMappingCommandOutput} for command's `response` shape.
  * @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape.
@@ -52,11 +59,20 @@ export interface CreateBasePathMappingCommandOutput extends BasePathMapping, __M
 export declare class CreateBasePathMappingCommand extends $Command<CreateBasePathMappingCommandInput, CreateBasePathMappingCommandOutput, APIGatewayClientResolvedConfig> {
     readonly input: CreateBasePathMappingCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateBasePathMappingCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: APIGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateBasePathMappingCommandInput, CreateBasePathMappingCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CreateDeploymentCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { APIGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../APIGatewayClient";
 import { CreateDeploymentRequest, Deployment } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateDeploymentCommand}.
  */
 export interface CreateDeploymentCommandInput extends CreateDeploymentRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateDeploymentCommand}.
  */
 export interface CreateDeploymentCommandOutput extends Deployment, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a Deployment resource, which makes a specified RestApi callable over the internet.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateDeploymentCommandOutput extends Deployment, __MetadataBea
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateDeploymentCommandInput - {@link CreateDeploymentCommandInput}
+ * @returns {@link CreateDeploymentCommandOutput}
  * @see {@link CreateDeploymentCommandInput} for command's `input` shape.
  * @see {@link CreateDeploymentCommandOutput} for command's `response` shape.
  * @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape.
@@ -55,11 +62,20 @@ export interface CreateDeploymentCommandOutput extends Deployment, __MetadataBea
 export declare class CreateDeploymentCommand extends $Command<CreateDeploymentCommandInput, CreateDeploymentCommandOutput, APIGatewayClientResolvedConfig> {
     readonly input: CreateDeploymentCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateDeploymentCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: APIGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDeploymentCommandInput, CreateDeploymentCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CreateDocumentationPartCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { APIGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../APIGatewayClient";
 import { CreateDocumentationPartRequest, DocumentationPart } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateDocumentationPartCommand}.
  */
 export interface CreateDocumentationPartCommandInput extends CreateDocumentationPartRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateDocumentationPartCommand}.
  */
 export interface CreateDocumentationPartCommandOutput extends DocumentationPart, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a documentation part.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateDocumentationPartCommandOutput extends DocumentationPart,
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateDocumentationPartCommandInput - {@link CreateDocumentationPartCommandInput}
+ * @returns {@link CreateDocumentationPartCommandOutput}
  * @see {@link CreateDocumentationPartCommandInput} for command's `input` shape.
  * @see {@link CreateDocumentationPartCommandOutput} for command's `response` shape.
  * @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape.
@@ -52,11 +59,20 @@ export interface CreateDocumentationPartCommandOutput extends DocumentationPart,
 export declare class CreateDocumentationPartCommand extends $Command<CreateDocumentationPartCommandInput, CreateDocumentationPartCommandOutput, APIGatewayClientResolvedConfig> {
     readonly input: CreateDocumentationPartCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateDocumentationPartCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: APIGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDocumentationPartCommandInput, CreateDocumentationPartCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CreateDocumentationVersionCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { APIGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../APIGatewayClient";
 import { CreateDocumentationVersionRequest, DocumentationVersion } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateDocumentationVersionCommand}.
  */
 export interface CreateDocumentationVersionCommandInput extends CreateDocumentationVersionRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateDocumentationVersionCommand}.
  */
 export interface CreateDocumentationVersionCommandOutput extends DocumentationVersion, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a documentation version</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateDocumentationVersionCommandOutput extends DocumentationVe
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateDocumentationVersionCommandInput - {@link CreateDocumentationVersionCommandInput}
+ * @returns {@link CreateDocumentationVersionCommandOutput}
  * @see {@link CreateDocumentationVersionCommandInput} for command's `input` shape.
  * @see {@link CreateDocumentationVersionCommandOutput} for command's `response` shape.
  * @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape.
@@ -52,11 +59,20 @@ export interface CreateDocumentationVersionCommandOutput extends DocumentationVe
 export declare class CreateDocumentationVersionCommand extends $Command<CreateDocumentationVersionCommandInput, CreateDocumentationVersionCommandOutput, APIGatewayClientResolvedConfig> {
     readonly input: CreateDocumentationVersionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateDocumentationVersionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: APIGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDocumentationVersionCommandInput, CreateDocumentationVersionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CreateDomainNameCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { APIGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../APIGatewayClient";
 import { CreateDomainNameRequest, DomainName } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateDomainNameCommand}.
  */
 export interface CreateDomainNameCommandInput extends CreateDomainNameRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateDomainNameCommand}.
  */
 export interface CreateDomainNameCommandOutput extends DomainName, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a new domain name.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateDomainNameCommandOutput extends DomainName, __MetadataBea
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateDomainNameCommandInput - {@link CreateDomainNameCommandInput}
+ * @returns {@link CreateDomainNameCommandOutput}
  * @see {@link CreateDomainNameCommandInput} for command's `input` shape.
  * @see {@link CreateDomainNameCommandOutput} for command's `response` shape.
  * @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape.
@@ -49,11 +56,20 @@ export interface CreateDomainNameCommandOutput extends DomainName, __MetadataBea
 export declare class CreateDomainNameCommand extends $Command<CreateDomainNameCommandInput, CreateDomainNameCommandOutput, APIGatewayClientResolvedConfig> {
     readonly input: CreateDomainNameCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateDomainNameCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: APIGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDomainNameCommandInput, CreateDomainNameCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CreateModelCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { APIGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../APIGatewayClient";
 import { CreateModelRequest, Model } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateModelCommand}.
  */
 export interface CreateModelCommandInput extends CreateModelRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateModelCommand}.
  */
 export interface CreateModelCommandOutput extends Model, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Adds a new Model resource to an existing RestApi resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateModelCommandOutput extends Model, __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateModelCommandInput - {@link CreateModelCommandInput}
+ * @returns {@link CreateModelCommandOutput}
  * @see {@link CreateModelCommandInput} for command's `input` shape.
  * @see {@link CreateModelCommandOutput} for command's `response` shape.
  * @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape.
@@ -52,11 +59,20 @@ export interface CreateModelCommandOutput extends Model, __MetadataBearer {
 export declare class CreateModelCommand extends $Command<CreateModelCommandInput, CreateModelCommandOutput, APIGatewayClientResolvedConfig> {
     readonly input: CreateModelCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateModelCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: APIGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateModelCommandInput, CreateModelCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CreateRequestValidatorCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { APIGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../APIGatewayClient";
 import { CreateRequestValidatorRequest, RequestValidator } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateRequestValidatorCommand}.
  */
 export interface CreateRequestValidatorCommandInput extends CreateRequestValidatorRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateRequestValidatorCommand}.
  */
 export interface CreateRequestValidatorCommandOutput extends RequestValidator, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a RequestValidator of a given RestApi.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateRequestValidatorCommandOutput extends RequestValidator, _
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateRequestValidatorCommandInput - {@link CreateRequestValidatorCommandInput}
+ * @returns {@link CreateRequestValidatorCommandOutput}
  * @see {@link CreateRequestValidatorCommandInput} for command's `input` shape.
  * @see {@link CreateRequestValidatorCommandOutput} for command's `response` shape.
  * @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape.
@@ -52,11 +59,20 @@ export interface CreateRequestValidatorCommandOutput extends RequestValidator, _
 export declare class CreateRequestValidatorCommand extends $Command<CreateRequestValidatorCommandInput, CreateRequestValidatorCommandOutput, APIGatewayClientResolvedConfig> {
     readonly input: CreateRequestValidatorCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateRequestValidatorCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: APIGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateRequestValidatorCommandInput, CreateRequestValidatorCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CreateResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { APIGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../APIGatewayClient";
 import { CreateResourceRequest, Resource } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateResourceCommand}.
  */
 export interface CreateResourceCommandInput extends CreateResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateResourceCommand}.
  */
 export interface CreateResourceCommandOutput extends Resource, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a Resource resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateResourceCommandOutput extends Resource, __MetadataBearer
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateResourceCommandInput - {@link CreateResourceCommandInput}
+ * @returns {@link CreateResourceCommandOutput}
  * @see {@link CreateResourceCommandInput} for command's `input` shape.
  * @see {@link CreateResourceCommandOutput} for command's `response` shape.
  * @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape.
@@ -52,11 +59,20 @@ export interface CreateResourceCommandOutput extends Resource, __MetadataBearer
 export declare class CreateResourceCommand extends $Command<CreateResourceCommandInput, CreateResourceCommandOutput, APIGatewayClientResolvedConfig> {
     readonly input: CreateResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: APIGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateResourceCommandInput, CreateResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CreateRestApiCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { APIGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../APIGatewayClient";
 import { CreateRestApiRequest, RestApi } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateRestApiCommand}.
  */
 export interface CreateRestApiCommandInput extends CreateRestApiRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateRestApiCommand}.
  */
 export interface CreateRestApiCommandOutput extends RestApi, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a new RestApi resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateRestApiCommandOutput extends RestApi, __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateRestApiCommandInput - {@link CreateRestApiCommandInput}
+ * @returns {@link CreateRestApiCommandOutput}
  * @see {@link CreateRestApiCommandInput} for command's `input` shape.
  * @see {@link CreateRestApiCommandOutput} for command's `response` shape.
  * @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape.
@@ -49,11 +56,20 @@ export interface CreateRestApiCommandOutput extends RestApi, __MetadataBearer {
 export declare class CreateRestApiCommand extends $Command<CreateRestApiCommandInput, CreateRestApiCommandOutput, APIGatewayClientResolvedConfig> {
     readonly input: CreateRestApiCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateRestApiCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: APIGatewayClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateRestApiCommandInput, CreateRestApiCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }