@aws-sdk/client-api-gateway 3.95.0 → 3.99.0

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

@@ -7,7 +7,7 @@ export interface GetModelCommandInput extends GetModelRequest {
 export interface GetModelCommandOutput extends Model, __MetadataBearer {
 }
 /**
- * <p>Describes an existing model defined for a <a>RestApi</a> resource.</p>
+ * <p>Describes an existing model defined for a RestApi resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -7,7 +7,7 @@ export interface GetModelsCommandInput extends GetModelsRequest {
 export interface GetModelsCommandOutput extends Models, __MetadataBearer {
 }
 /**
- * <p>Describes existing <a>Models</a> defined for a <a>RestApi</a> resource.</p>
+ * <p>Describes existing Models defined for a RestApi resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

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

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

@@ -7,7 +7,7 @@ export interface GetRequestValidatorsCommandInput extends GetRequestValidatorsRe
 export interface GetRequestValidatorsCommandOutput extends RequestValidators, __MetadataBearer {
 }
 /**
- * <p>Gets the <a>RequestValidators</a> collection of a given <a>RestApi</a>.</p>
+ * <p>Gets the RequestValidators collection of a given RestApi.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -7,7 +7,7 @@ export interface GetResourcesCommandInput extends GetResourcesRequest {
 export interface GetResourcesCommandOutput extends Resources, __MetadataBearer {
 }
 /**
- * <p>Lists information about a collection of <a>Resource</a> resources.</p>
+ * <p>Lists information about a collection of Resource resources.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -7,7 +7,7 @@ export interface GetRestApiCommandInput extends GetRestApiRequest {
 export interface GetRestApiCommandOutput extends RestApi, __MetadataBearer {
 }
 /**
- * <p>Lists the <a>RestApi</a> resource in the collection.</p>
+ * <p>Lists the RestApi resource in the collection.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -7,7 +7,7 @@ export interface GetRestApisCommandInput extends GetRestApisRequest {
 export interface GetRestApisCommandOutput extends RestApis, __MetadataBearer {
 }
 /**
- * <p>Lists the <a>RestApis</a> resources for your collection.</p>
+ * <p>Lists the RestApis resources for your collection.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -7,7 +7,7 @@ export interface GetSdkCommandInput extends GetSdkRequest {
 export interface GetSdkCommandOutput extends SdkResponse, __MetadataBearer {
 }
 /**
- * <p>Generates a client SDK for a <a>RestApi</a> and <a>Stage</a>.</p>
+ * <p>Generates a client SDK for a RestApi and Stage.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -6,6 +6,23 @@ export interface GetSdkTypeCommandInput extends GetSdkTypeRequest {
 }
 export interface GetSdkTypeCommandOutput extends SdkType, __MetadataBearer {
 }
+/**
+ * <p>Gets an SDK type.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { APIGatewayClient, GetSdkTypeCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
+ * // const { APIGatewayClient, GetSdkTypeCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
+ * const client = new APIGatewayClient(config);
+ * const command = new GetSdkTypeCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link GetSdkTypeCommandInput} for command's `input` shape.
+ * @see {@link GetSdkTypeCommandOutput} for command's `response` shape.
+ * @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape.
+ *
+ */
 export declare class GetSdkTypeCommand extends $Command<GetSdkTypeCommandInput, GetSdkTypeCommandOutput, APIGatewayClientResolvedConfig> {
     readonly input: GetSdkTypeCommandInput;
     constructor(input: GetSdkTypeCommandInput);

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

@@ -6,6 +6,23 @@ export interface GetSdkTypesCommandInput extends GetSdkTypesRequest {
 }
 export interface GetSdkTypesCommandOutput extends SdkTypes, __MetadataBearer {
 }
+/**
+ * <p>Gets SDK types</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { APIGatewayClient, GetSdkTypesCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
+ * // const { APIGatewayClient, GetSdkTypesCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
+ * const client = new APIGatewayClient(config);
+ * const command = new GetSdkTypesCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link GetSdkTypesCommandInput} for command's `input` shape.
+ * @see {@link GetSdkTypesCommandOutput} for command's `response` shape.
+ * @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape.
+ *
+ */
 export declare class GetSdkTypesCommand extends $Command<GetSdkTypesCommandInput, GetSdkTypesCommandOutput, APIGatewayClientResolvedConfig> {
     readonly input: GetSdkTypesCommandInput;
     constructor(input: GetSdkTypesCommandInput);

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

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

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

@@ -7,7 +7,7 @@ export interface GetStagesCommandInput extends GetStagesRequest {
 export interface GetStagesCommandOutput extends Stages, __MetadataBearer {
 }
 /**
- * <p>Gets information about one or more <a>Stage</a> resources.</p>
+ * <p>Gets information about one or more Stage resources.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -7,7 +7,7 @@ export interface GetTagsCommandInput extends GetTagsRequest {
 export interface GetTagsCommandOutput extends Tags, __MetadataBearer {
 }
 /**
- * <p>Gets the <a>Tags</a> collection for a given resource.</p>
+ * <p>Gets the Tags collection for a given resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -7,7 +7,7 @@ export interface GetVpcLinksCommandInput extends GetVpcLinksRequest {
 export interface GetVpcLinksCommandOutput extends VpcLinks, __MetadataBearer {
 }
 /**
- * <p>Gets the <a>VpcLinks</a> collection under the caller's account in a selected region.</p>
+ * <p>Gets the VpcLinks collection under the caller's account in a selected region.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -6,6 +6,23 @@ export interface ImportDocumentationPartsCommandInput extends ImportDocumentatio
 }
 export interface ImportDocumentationPartsCommandOutput extends DocumentationPartIds, __MetadataBearer {
 }
+/**
+ * <p>Imports documentation parts</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { APIGatewayClient, ImportDocumentationPartsCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
+ * // const { APIGatewayClient, ImportDocumentationPartsCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
+ * const client = new APIGatewayClient(config);
+ * const command = new ImportDocumentationPartsCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link ImportDocumentationPartsCommandInput} for command's `input` shape.
+ * @see {@link ImportDocumentationPartsCommandOutput} for command's `response` shape.
+ * @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape.
+ *
+ */
 export declare class ImportDocumentationPartsCommand extends $Command<ImportDocumentationPartsCommandInput, ImportDocumentationPartsCommandOutput, APIGatewayClientResolvedConfig> {
     readonly input: ImportDocumentationPartsCommandInput;
     constructor(input: ImportDocumentationPartsCommandInput);

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

@@ -7,7 +7,7 @@ export interface PutGatewayResponseCommandInput extends PutGatewayResponseReques
 export interface PutGatewayResponseCommandOutput extends GatewayResponse, __MetadataBearer {
 }
 /**
- * <p>Creates a customization of a <a>GatewayResponse</a> of a specified response type and status code on the given <a>RestApi</a>.</p>
+ * <p>Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -7,7 +7,7 @@ export interface PutMethodCommandInput extends PutMethodRequest {
 export interface PutMethodCommandOutput extends Method, __MetadataBearer {
 }
 /**
- * <p>Add a method to an existing <a>Resource</a> resource.</p>
+ * <p>Add a method to an existing Resource resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -7,7 +7,7 @@ export interface PutMethodResponseCommandInput extends PutMethodResponseRequest
 export interface PutMethodResponseCommandOutput extends MethodResponse, __MetadataBearer {
 }
 /**
- * <p>Adds a <a>MethodResponse</a> to an existing <a>Method</a> resource.</p>
+ * <p>Adds a MethodResponse to an existing Method resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -7,11 +7,7 @@ export interface TestInvokeAuthorizerCommandInput extends TestInvokeAuthorizerRe
 export interface TestInvokeAuthorizerCommandOutput extends TestInvokeAuthorizerResponse, __MetadataBearer {
 }
 /**
- * <p>Simulate the execution of an <a>Authorizer</a> in your <a>RestApi</a> with headers, parameters, and an incoming request body.</p>
- *       <div class="seeAlso">
- *         <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html">Use Lambda Function as Authorizer</a>
- *         <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html">Use Cognito User Pool as Authorizer</a>
- *       </div>
+ * <p>Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -7,7 +7,7 @@ export interface TestInvokeMethodCommandInput extends TestInvokeMethodRequest {
 export interface TestInvokeMethodCommandOutput extends TestInvokeMethodResponse, __MetadataBearer {
 }
 /**
- * <p>Simulate the execution of a <a>Method</a> in your <a>RestApi</a> with headers, parameters, and an incoming request body.</p>
+ * <p>Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

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

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

@@ -7,7 +7,7 @@ export interface UpdateApiKeyCommandInput extends UpdateApiKeyRequest {
 export interface UpdateApiKeyCommandOutput extends ApiKey, __MetadataBearer {
 }
 /**
- * <p>Changes information about an <a>ApiKey</a> resource.</p>
+ * <p>Changes information about an ApiKey resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

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

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

@@ -7,7 +7,7 @@ export interface UpdateBasePathMappingCommandInput extends UpdateBasePathMapping
 export interface UpdateBasePathMappingCommandOutput extends BasePathMapping, __MetadataBearer {
 }
 /**
- * <p>Changes information about the <a>BasePathMapping</a> resource.</p>
+ * <p>Changes information about the BasePathMapping resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -7,7 +7,7 @@ export interface UpdateClientCertificateCommandInput extends UpdateClientCertifi
 export interface UpdateClientCertificateCommandOutput extends ClientCertificate, __MetadataBearer {
 }
 /**
- * <p>Changes information about an <a>ClientCertificate</a> resource.</p>
+ * <p>Changes information about an ClientCertificate resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

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

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

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

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

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

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

@@ -7,7 +7,7 @@ export interface UpdateDomainNameCommandInput extends UpdateDomainNameRequest {
 export interface UpdateDomainNameCommandOutput extends DomainName, __MetadataBearer {
 }
 /**
- * <p>Changes information about the <a>DomainName</a> resource.</p>
+ * <p>Changes information about the DomainName resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -7,7 +7,7 @@ export interface UpdateGatewayResponseCommandInput extends UpdateGatewayResponse
 export interface UpdateGatewayResponseCommandOutput extends GatewayResponse, __MetadataBearer {
 }
 /**
- * <p>Updates a <a>GatewayResponse</a> of a specified response type on the given <a>RestApi</a>.</p>
+ * <p>Updates a GatewayResponse of a specified response type on the given RestApi.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

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

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

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

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

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

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

@@ -7,7 +7,7 @@ export interface UpdateResourceCommandInput extends UpdateResourceRequest {
 export interface UpdateResourceCommandOutput extends Resource, __MetadataBearer {
 }
 /**
- * <p>Changes information about a <a>Resource</a> resource.</p>
+ * <p>Changes information about a Resource resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -7,7 +7,7 @@ export interface UpdateStageCommandInput extends UpdateStageRequest {
 export interface UpdateStageCommandOutput extends Stage, __MetadataBearer {
 }
 /**
- * <p>Changes information about a <a>Stage</a> resource.</p>
+ * <p>Changes information about a Stage resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -7,7 +7,7 @@ export interface UpdateVpcLinkCommandInput extends UpdateVpcLinkRequest {
 export interface UpdateVpcLinkCommandOutput extends VpcLink, __MetadataBearer {
 }
 /**
- * <p>Updates an existing <a>VpcLink</a> of a specified identifier.</p>
+ * <p>Updates 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