docs(client-api-gateway): Documentation updates for Amazon API Gateway

Author: awstools

clients/client-api-gateway/src/APIGateway.ts

@@ -23,8 +23,7 @@ export interface CreateApiKeyCommandInput extends CreateApiKeyRequest {}
 export interface CreateApiKeyCommandOutput extends ApiKey, __MetadataBearer {}
 
 /**
- * <p>Create an <a>ApiKey</a> resource. </p>
- *         <div class="seeAlso"><a href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-api-key.html">AWS CLI</a></div>
+ * <p>Create an ApiKey resource. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/CreateApiKeyCommand.ts

@@ -23,8 +23,7 @@ export interface CreateAuthorizerCommandInput extends CreateAuthorizerRequest {}
 export interface CreateAuthorizerCommandOutput extends Authorizer, __MetadataBearer {}
 
 /**
- * <p>Adds a new <a>Authorizer</a> resource to an existing <a>RestApi</a> resource.</p>
- *         <div class="seeAlso"><a href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-authorizer.html">AWS CLI</a></div>
+ * <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.
  * ```javascript

clients/client-api-gateway/src/commands/CreateAuthorizerCommand.ts

@@ -23,7 +23,7 @@ export interface CreateBasePathMappingCommandInput extends CreateBasePathMapping
 export interface CreateBasePathMappingCommandOutput extends BasePathMapping, __MetadataBearer {}
 
 /**
- * <p>Creates a new <a>BasePathMapping</a> resource.</p>
+ * <p>Creates a new BasePathMapping resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/CreateBasePathMappingCommand.ts

@@ -23,7 +23,7 @@ export interface CreateDeploymentCommandInput extends CreateDeploymentRequest {}
 export interface CreateDeploymentCommandOutput extends Deployment, __MetadataBearer {}
 
 /**
- * <p>Creates a <a>Deployment</a> resource, which makes a specified <a>RestApi</a> callable over the internet.</p>
+ * <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.
  * ```javascript

clients/client-api-gateway/src/commands/CreateDeploymentCommand.ts

@@ -22,6 +22,23 @@ import {
 export interface CreateDocumentationPartCommandInput extends CreateDocumentationPartRequest {}
 export interface CreateDocumentationPartCommandOutput extends DocumentationPart, __MetadataBearer {}
 
+/**
+ * <p>Creates a documentation part.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { APIGatewayClient, CreateDocumentationPartCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
+ * // const { APIGatewayClient, CreateDocumentationPartCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
+ * const client = new APIGatewayClient(config);
+ * const command = new CreateDocumentationPartCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @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.
+ *
+ */
 export class CreateDocumentationPartCommand extends $Command<
   CreateDocumentationPartCommandInput,
   CreateDocumentationPartCommandOutput,

clients/client-api-gateway/src/commands/CreateDocumentationPartCommand.ts

@@ -22,6 +22,23 @@ import {
 export interface CreateDocumentationVersionCommandInput extends CreateDocumentationVersionRequest {}
 export interface CreateDocumentationVersionCommandOutput extends DocumentationVersion, __MetadataBearer {}
 
+/**
+ * <p>Creates a documentation version</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { APIGatewayClient, CreateDocumentationVersionCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
+ * // const { APIGatewayClient, CreateDocumentationVersionCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
+ * const client = new APIGatewayClient(config);
+ * const command = new CreateDocumentationVersionCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @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.
+ *
+ */
 export class CreateDocumentationVersionCommand extends $Command<
   CreateDocumentationVersionCommandInput,
   CreateDocumentationVersionCommandOutput,

clients/client-api-gateway/src/commands/CreateDocumentationVersionCommand.ts

@@ -23,7 +23,7 @@ export interface CreateModelCommandInput extends CreateModelRequest {}
 export interface CreateModelCommandOutput extends Model, __MetadataBearer {}
 
 /**
- * <p>Adds a new <a>Model</a> resource to an existing <a>RestApi</a> resource.</p>
+ * <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.
  * ```javascript

clients/client-api-gateway/src/commands/CreateModelCommand.ts

@@ -23,7 +23,7 @@ export interface CreateRequestValidatorCommandInput extends CreateRequestValidat
 export interface CreateRequestValidatorCommandOutput extends RequestValidator, __MetadataBearer {}
 
 /**
- * <p>Creates a <a>ReqeustValidator</a> of a given <a>RestApi</a>.</p>
+ * <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.
  * ```javascript

clients/client-api-gateway/src/commands/CreateRequestValidatorCommand.ts

@@ -23,7 +23,7 @@ export interface CreateResourceCommandInput extends CreateResourceRequest {}
 export interface CreateResourceCommandOutput extends Resource, __MetadataBearer {}
 
 /**
- * <p>Creates a <a>Resource</a> resource.</p>
+ * <p>Creates a Resource resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/CreateResourceCommand.ts

@@ -23,7 +23,7 @@ export interface CreateRestApiCommandInput extends CreateRestApiRequest {}
 export interface CreateRestApiCommandOutput extends RestApi, __MetadataBearer {}
 
 /**
- * <p>Creates a new <a>RestApi</a> resource.</p>
+ * <p>Creates a new RestApi resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/CreateRestApiCommand.ts

@@ -23,8 +23,7 @@ export interface CreateStageCommandInput extends CreateStageRequest {}
 export interface CreateStageCommandOutput extends Stage, __MetadataBearer {}
 
 /**
- * <p>Creates a new <a>Stage</a> resource that references a pre-existing <a>Deployment</a> for the API. </p>
- *         <!--   <p>Creates a <a>Stage</a> resource.</p>  -->
+ * <p>Creates a new Stage resource that references a pre-existing Deployment for the API. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/CreateStageCommand.ts

@@ -23,7 +23,7 @@ export interface DeleteApiKeyCommandInput extends DeleteApiKeyRequest {}
 export interface DeleteApiKeyCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Deletes the <a>ApiKey</a> resource.</p>
+ * <p>Deletes the ApiKey resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/DeleteApiKeyCommand.ts

@@ -23,8 +23,7 @@ export interface DeleteAuthorizerCommandInput extends DeleteAuthorizerRequest {}
 export interface DeleteAuthorizerCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Deletes an existing <a>Authorizer</a> resource.</p>
- *         <div class="seeAlso"><a href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/delete-authorizer.html">AWS CLI</a></div>
+ * <p>Deletes an existing Authorizer resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/DeleteAuthorizerCommand.ts

@@ -23,7 +23,7 @@ export interface DeleteBasePathMappingCommandInput extends DeleteBasePathMapping
 export interface DeleteBasePathMappingCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Deletes the <a>BasePathMapping</a> resource.</p>
+ * <p>Deletes the BasePathMapping resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/DeleteBasePathMappingCommand.ts

@@ -23,7 +23,7 @@ export interface DeleteClientCertificateCommandInput extends DeleteClientCertifi
 export interface DeleteClientCertificateCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Deletes the <a>ClientCertificate</a> resource.</p>
+ * <p>Deletes the ClientCertificate resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/DeleteClientCertificateCommand.ts

@@ -23,7 +23,7 @@ export interface DeleteDeploymentCommandInput extends DeleteDeploymentRequest {}
 export interface DeleteDeploymentCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Deletes a <a>Deployment</a> resource. Deleting a deployment will only succeed if there are no <a>Stage</a> resources associated with it.</p>
+ * <p>Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/DeleteDeploymentCommand.ts

@@ -22,6 +22,23 @@ import {
 export interface DeleteDocumentationPartCommandInput extends DeleteDocumentationPartRequest {}
 export interface DeleteDocumentationPartCommandOutput extends __MetadataBearer {}
 
+/**
+ * <p>Deletes a documentation part</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { APIGatewayClient, DeleteDocumentationPartCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
+ * // const { APIGatewayClient, DeleteDocumentationPartCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
+ * const client = new APIGatewayClient(config);
+ * const command = new DeleteDocumentationPartCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link DeleteDocumentationPartCommandInput} for command's `input` shape.
+ * @see {@link DeleteDocumentationPartCommandOutput} for command's `response` shape.
+ * @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape.
+ *
+ */
 export class DeleteDocumentationPartCommand extends $Command<
   DeleteDocumentationPartCommandInput,
   DeleteDocumentationPartCommandOutput,

clients/client-api-gateway/src/commands/DeleteDocumentationPartCommand.ts

@@ -22,6 +22,23 @@ import {
 export interface DeleteDocumentationVersionCommandInput extends DeleteDocumentationVersionRequest {}
 export interface DeleteDocumentationVersionCommandOutput extends __MetadataBearer {}
 
+/**
+ * <p>Deletes a documentation version.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { APIGatewayClient, DeleteDocumentationVersionCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
+ * // const { APIGatewayClient, DeleteDocumentationVersionCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
+ * const client = new APIGatewayClient(config);
+ * const command = new DeleteDocumentationVersionCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link DeleteDocumentationVersionCommandInput} for command's `input` shape.
+ * @see {@link DeleteDocumentationVersionCommandOutput} for command's `response` shape.
+ * @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape.
+ *
+ */
 export class DeleteDocumentationVersionCommand extends $Command<
   DeleteDocumentationVersionCommandInput,
   DeleteDocumentationVersionCommandOutput,

clients/client-api-gateway/src/commands/DeleteDocumentationVersionCommand.ts

@@ -23,7 +23,7 @@ export interface DeleteDomainNameCommandInput extends DeleteDomainNameRequest {}
 export interface DeleteDomainNameCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Deletes the <a>DomainName</a> resource.</p>
+ * <p>Deletes the DomainName resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/DeleteDomainNameCommand.ts

@@ -23,7 +23,7 @@ export interface DeleteGatewayResponseCommandInput extends DeleteGatewayResponse
 export interface DeleteGatewayResponseCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Clears any customization of a <a>GatewayResponse</a> of a specified response type on the given <a>RestApi</a> and resets it with the default settings.</p>
+ * <p>Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/DeleteGatewayResponseCommand.ts

@@ -23,7 +23,7 @@ export interface DeleteMethodCommandInput extends DeleteMethodRequest {}
 export interface DeleteMethodCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Deletes an existing <a>Method</a> resource.</p>
+ * <p>Deletes an existing Method resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/DeleteMethodCommand.ts

@@ -23,7 +23,7 @@ export interface DeleteMethodResponseCommandInput extends DeleteMethodResponseRe
 export interface DeleteMethodResponseCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Deletes an existing <a>MethodResponse</a> resource.</p>
+ * <p>Deletes an existing MethodResponse resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/DeleteMethodResponseCommand.ts

@@ -23,7 +23,7 @@ export interface DeleteRequestValidatorCommandInput extends DeleteRequestValidat
 export interface DeleteRequestValidatorCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Deletes a <a>RequestValidator</a> of a given <a>RestApi</a>.</p>
+ * <p>Deletes a RequestValidator of a given RestApi.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/DeleteRequestValidatorCommand.ts

@@ -23,7 +23,7 @@ export interface DeleteResourceCommandInput extends DeleteResourceRequest {}
 export interface DeleteResourceCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Deletes a <a>Resource</a> resource.</p>
+ * <p>Deletes a Resource resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/DeleteResourceCommand.ts

@@ -23,7 +23,7 @@ export interface DeleteStageCommandInput extends DeleteStageRequest {}
 export interface DeleteStageCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Deletes a <a>Stage</a> resource.</p>
+ * <p>Deletes a Stage resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/DeleteStageCommand.ts

@@ -23,7 +23,7 @@ export interface DeleteVpcLinkCommandInput extends DeleteVpcLinkRequest {}
 export interface DeleteVpcLinkCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Deletes an existing <a>VpcLink</a> of a specified identifier.</p>
+ * <p>Deletes an existing VpcLink of a specified identifier.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/DeleteVpcLinkCommand.ts

@@ -23,7 +23,7 @@ export interface GenerateClientCertificateCommandInput extends GenerateClientCer
 export interface GenerateClientCertificateCommandOutput extends ClientCertificate, __MetadataBearer {}
 
 /**
- * <p>Generates a <a>ClientCertificate</a> resource.</p>
+ * <p>Generates a ClientCertificate resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/GenerateClientCertificateCommand.ts

@@ -23,7 +23,7 @@ export interface GetAccountCommandInput extends GetAccountRequest {}
 export interface GetAccountCommandOutput extends Account, __MetadataBearer {}
 
 /**
- * <p>Gets information about the current <a>Account</a> resource.</p>
+ * <p>Gets information about the current Account resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/GetAccountCommand.ts

@@ -23,7 +23,7 @@ export interface GetApiKeyCommandInput extends GetApiKeyRequest {}
 export interface GetApiKeyCommandOutput extends ApiKey, __MetadataBearer {}
 
 /**
- * <p>Gets information about the current <a>ApiKey</a> resource.</p>
+ * <p>Gets information about the current ApiKey resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/GetApiKeyCommand.ts

@@ -23,7 +23,7 @@ export interface GetApiKeysCommandInput extends GetApiKeysRequest {}
 export interface GetApiKeysCommandOutput extends ApiKeys, __MetadataBearer {}
 
 /**
- * <p>Gets information about the current <a>ApiKeys</a> resource.</p>
+ * <p>Gets information about the current ApiKeys resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/GetApiKeysCommand.ts

@@ -23,8 +23,7 @@ export interface GetAuthorizerCommandInput extends GetAuthorizerRequest {}
 export interface GetAuthorizerCommandOutput extends Authorizer, __MetadataBearer {}
 
 /**
- * <p>Describe an existing <a>Authorizer</a> resource.</p>
- *         <div class="seeAlso"><a href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizer.html">AWS CLI</a></div>
+ * <p>Describe an existing Authorizer resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/GetAuthorizerCommand.ts

@@ -23,8 +23,7 @@ export interface GetAuthorizersCommandInput extends GetAuthorizersRequest {}
 export interface GetAuthorizersCommandOutput extends Authorizers, __MetadataBearer {}
 
 /**
- * <p>Describe an existing <a>Authorizers</a> resource.</p>
- *         <div class="seeAlso"><a href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizers.html">AWS CLI</a></div>
+ * <p>Describe an existing Authorizers resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/GetAuthorizersCommand.ts

@@ -23,7 +23,7 @@ export interface GetBasePathMappingCommandInput extends GetBasePathMappingReques
 export interface GetBasePathMappingCommandOutput extends BasePathMapping, __MetadataBearer {}
 
 /**
- * <p>Describe a <a>BasePathMapping</a> resource.</p>
+ * <p>Describe a BasePathMapping resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/GetBasePathMappingCommand.ts

@@ -23,7 +23,7 @@ export interface GetBasePathMappingsCommandInput extends GetBasePathMappingsRequ
 export interface GetBasePathMappingsCommandOutput extends BasePathMappings, __MetadataBearer {}
 
 /**
- * <p>Represents a collection of <a>BasePathMapping</a> resources.</p>
+ * <p>Represents a collection of BasePathMapping resources.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/GetBasePathMappingsCommand.ts

@@ -23,7 +23,7 @@ export interface GetClientCertificateCommandInput extends GetClientCertificateRe
 export interface GetClientCertificateCommandOutput extends ClientCertificate, __MetadataBearer {}
 
 /**
- * <p>Gets information about the current <a>ClientCertificate</a> resource.</p>
+ * <p>Gets information about the current ClientCertificate resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/GetClientCertificateCommand.ts

@@ -23,7 +23,7 @@ export interface GetClientCertificatesCommandInput extends GetClientCertificates
 export interface GetClientCertificatesCommandOutput extends ClientCertificates, __MetadataBearer {}
 
 /**
- * <p>Gets a collection of <a>ClientCertificate</a> resources.</p>
+ * <p>Gets a collection of ClientCertificate resources.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-api-gateway/src/commands/GetClientCertificatesCommand.ts

@@ -23,7 +23,7 @@ export interface GetDeploymentCommandInput extends GetDeploymentRequest {}
 export interface GetDeploymentCommandOutput extends Deployment, __MetadataBearer {}
 
 /**
- * <p>Gets information about a <a>Deployment</a> resource.</p>
+ * <p>Gets information about a Deployment resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript