@aws-sdk/client-api-gateway 3.95.0 → 3.99.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/dist-cjs/runtimeConfig.js +2 -0
- package/dist-es/runtimeConfig.js +2 -0
- package/dist-types/APIGateway.d.ts +110 -82
- package/dist-types/commands/CreateApiKeyCommand.d.ts +1 -2
- package/dist-types/commands/CreateAuthorizerCommand.d.ts +1 -2
- package/dist-types/commands/CreateBasePathMappingCommand.d.ts +1 -1
- package/dist-types/commands/CreateDeploymentCommand.d.ts +1 -1
- package/dist-types/commands/CreateDocumentationPartCommand.d.ts +17 -0
- package/dist-types/commands/CreateDocumentationVersionCommand.d.ts +17 -0
- package/dist-types/commands/CreateModelCommand.d.ts +1 -1
- package/dist-types/commands/CreateRequestValidatorCommand.d.ts +1 -1
- package/dist-types/commands/CreateResourceCommand.d.ts +1 -1
- package/dist-types/commands/CreateRestApiCommand.d.ts +1 -1
- package/dist-types/commands/CreateStageCommand.d.ts +1 -2
- package/dist-types/commands/DeleteApiKeyCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAuthorizerCommand.d.ts +1 -2
- package/dist-types/commands/DeleteBasePathMappingCommand.d.ts +1 -1
- package/dist-types/commands/DeleteClientCertificateCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDeploymentCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDocumentationPartCommand.d.ts +17 -0
- package/dist-types/commands/DeleteDocumentationVersionCommand.d.ts +17 -0
- package/dist-types/commands/DeleteDomainNameCommand.d.ts +1 -1
- package/dist-types/commands/DeleteGatewayResponseCommand.d.ts +1 -1
- package/dist-types/commands/DeleteMethodCommand.d.ts +1 -1
- package/dist-types/commands/DeleteMethodResponseCommand.d.ts +1 -1
- package/dist-types/commands/DeleteRequestValidatorCommand.d.ts +1 -1
- package/dist-types/commands/DeleteResourceCommand.d.ts +1 -1
- package/dist-types/commands/DeleteStageCommand.d.ts +1 -1
- package/dist-types/commands/DeleteVpcLinkCommand.d.ts +1 -1
- package/dist-types/commands/GenerateClientCertificateCommand.d.ts +1 -1
- package/dist-types/commands/GetAccountCommand.d.ts +1 -1
- package/dist-types/commands/GetApiKeyCommand.d.ts +1 -1
- package/dist-types/commands/GetApiKeysCommand.d.ts +1 -1
- package/dist-types/commands/GetAuthorizerCommand.d.ts +1 -2
- package/dist-types/commands/GetAuthorizersCommand.d.ts +1 -2
- package/dist-types/commands/GetBasePathMappingCommand.d.ts +1 -1
- package/dist-types/commands/GetBasePathMappingsCommand.d.ts +1 -1
- package/dist-types/commands/GetClientCertificateCommand.d.ts +1 -1
- package/dist-types/commands/GetClientCertificatesCommand.d.ts +1 -1
- package/dist-types/commands/GetDeploymentCommand.d.ts +1 -1
- package/dist-types/commands/GetDeploymentsCommand.d.ts +1 -1
- package/dist-types/commands/GetDocumentationPartCommand.d.ts +17 -0
- package/dist-types/commands/GetDocumentationPartsCommand.d.ts +17 -0
- package/dist-types/commands/GetDocumentationVersionCommand.d.ts +17 -0
- package/dist-types/commands/GetDocumentationVersionsCommand.d.ts +17 -0
- package/dist-types/commands/GetDomainNamesCommand.d.ts +1 -1
- package/dist-types/commands/GetExportCommand.d.ts +1 -1
- package/dist-types/commands/GetGatewayResponseCommand.d.ts +1 -1
- package/dist-types/commands/GetGatewayResponsesCommand.d.ts +1 -1
- package/dist-types/commands/GetMethodCommand.d.ts +1 -1
- package/dist-types/commands/GetMethodResponseCommand.d.ts +1 -1
- package/dist-types/commands/GetModelCommand.d.ts +1 -1
- package/dist-types/commands/GetModelsCommand.d.ts +1 -1
- package/dist-types/commands/GetRequestValidatorCommand.d.ts +1 -1
- package/dist-types/commands/GetRequestValidatorsCommand.d.ts +1 -1
- package/dist-types/commands/GetResourcesCommand.d.ts +1 -1
- package/dist-types/commands/GetRestApiCommand.d.ts +1 -1
- package/dist-types/commands/GetRestApisCommand.d.ts +1 -1
- package/dist-types/commands/GetSdkCommand.d.ts +1 -1
- package/dist-types/commands/GetSdkTypeCommand.d.ts +17 -0
- package/dist-types/commands/GetSdkTypesCommand.d.ts +17 -0
- package/dist-types/commands/GetStageCommand.d.ts +1 -1
- package/dist-types/commands/GetStagesCommand.d.ts +1 -1
- package/dist-types/commands/GetTagsCommand.d.ts +1 -1
- package/dist-types/commands/GetVpcLinksCommand.d.ts +1 -1
- package/dist-types/commands/ImportDocumentationPartsCommand.d.ts +17 -0
- package/dist-types/commands/PutGatewayResponseCommand.d.ts +1 -1
- package/dist-types/commands/PutMethodCommand.d.ts +1 -1
- package/dist-types/commands/PutMethodResponseCommand.d.ts +1 -1
- package/dist-types/commands/TestInvokeAuthorizerCommand.d.ts +1 -5
- package/dist-types/commands/TestInvokeMethodCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAccountCommand.d.ts +1 -1
- package/dist-types/commands/UpdateApiKeyCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAuthorizerCommand.d.ts +1 -2
- package/dist-types/commands/UpdateBasePathMappingCommand.d.ts +1 -1
- package/dist-types/commands/UpdateClientCertificateCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDeploymentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDocumentationPartCommand.d.ts +17 -0
- package/dist-types/commands/UpdateDocumentationVersionCommand.d.ts +17 -0
- package/dist-types/commands/UpdateDomainNameCommand.d.ts +1 -1
- package/dist-types/commands/UpdateGatewayResponseCommand.d.ts +1 -1
- package/dist-types/commands/UpdateMethodCommand.d.ts +1 -1
- package/dist-types/commands/UpdateMethodResponseCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRequestValidatorCommand.d.ts +1 -1
- package/dist-types/commands/UpdateResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateStageCommand.d.ts +1 -1
- package/dist-types/commands/UpdateVpcLinkCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +645 -1896
- package/dist-types/ts3.4/APIGateway.d.ts +13 -0
- package/dist-types/ts3.4/commands/CreateDocumentationPartCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/CreateDocumentationVersionCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/DeleteDocumentationPartCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/DeleteDocumentationVersionCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/GetDocumentationPartCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/GetDocumentationPartsCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/GetDocumentationVersionCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/GetDocumentationVersionsCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/GetSdkTypeCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/GetSdkTypesCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/ImportDocumentationPartsCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/UpdateDocumentationPartCommand.d.ts +1 -0
- package/dist-types/ts3.4/commands/UpdateDocumentationVersionCommand.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +3 -0
- package/package.json +6 -6
|
@@ -7,8 +7,7 @@ export interface CreateApiKeyCommandInput extends CreateApiKeyRequest {
|
|
|
7
7
|
export interface CreateApiKeyCommandOutput extends ApiKey, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Create an
|
|
11
|
-
* <div class="seeAlso"><a href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-api-key.html">AWS CLI</a></div>
|
|
10
|
+
* <p>Create an ApiKey resource. </p>
|
|
12
11
|
* @example
|
|
13
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
13
|
* ```javascript
|
|
@@ -7,8 +7,7 @@ export interface CreateAuthorizerCommandInput extends CreateAuthorizerRequest {
|
|
|
7
7
|
export interface CreateAuthorizerCommandOutput extends Authorizer, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Adds a new
|
|
11
|
-
* <div class="seeAlso"><a href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-authorizer.html">AWS CLI</a></div>
|
|
10
|
+
* <p>Adds a new Authorizer resource to an existing RestApi resource.</p>
|
|
12
11
|
* @example
|
|
13
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface CreateBasePathMappingCommandInput extends CreateBasePathMapping
|
|
|
7
7
|
export interface CreateBasePathMappingCommandOutput extends BasePathMapping, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a new
|
|
10
|
+
* <p>Creates a new BasePathMapping resource.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface CreateDeploymentCommandInput extends CreateDeploymentRequest {
|
|
|
7
7
|
export interface CreateDeploymentCommandOutput extends Deployment, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a
|
|
10
|
+
* <p>Creates a Deployment resource, which makes a specified RestApi callable over the internet.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -6,6 +6,23 @@ export interface CreateDocumentationPartCommandInput extends CreateDocumentation
|
|
|
6
6
|
}
|
|
7
7
|
export interface CreateDocumentationPartCommandOutput extends DocumentationPart, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Creates a documentation part.</p>
|
|
11
|
+
* @example
|
|
12
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
13
|
+
* ```javascript
|
|
14
|
+
* import { APIGatewayClient, CreateDocumentationPartCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
|
|
15
|
+
* // const { APIGatewayClient, CreateDocumentationPartCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
|
|
16
|
+
* const client = new APIGatewayClient(config);
|
|
17
|
+
* const command = new CreateDocumentationPartCommand(input);
|
|
18
|
+
* const response = await client.send(command);
|
|
19
|
+
* ```
|
|
20
|
+
*
|
|
21
|
+
* @see {@link CreateDocumentationPartCommandInput} for command's `input` shape.
|
|
22
|
+
* @see {@link CreateDocumentationPartCommandOutput} for command's `response` shape.
|
|
23
|
+
* @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape.
|
|
24
|
+
*
|
|
25
|
+
*/
|
|
9
26
|
export declare class CreateDocumentationPartCommand extends $Command<CreateDocumentationPartCommandInput, CreateDocumentationPartCommandOutput, APIGatewayClientResolvedConfig> {
|
|
10
27
|
readonly input: CreateDocumentationPartCommandInput;
|
|
11
28
|
constructor(input: CreateDocumentationPartCommandInput);
|
|
@@ -6,6 +6,23 @@ export interface CreateDocumentationVersionCommandInput extends CreateDocumentat
|
|
|
6
6
|
}
|
|
7
7
|
export interface CreateDocumentationVersionCommandOutput extends DocumentationVersion, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Creates a documentation version</p>
|
|
11
|
+
* @example
|
|
12
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
13
|
+
* ```javascript
|
|
14
|
+
* import { APIGatewayClient, CreateDocumentationVersionCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
|
|
15
|
+
* // const { APIGatewayClient, CreateDocumentationVersionCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
|
|
16
|
+
* const client = new APIGatewayClient(config);
|
|
17
|
+
* const command = new CreateDocumentationVersionCommand(input);
|
|
18
|
+
* const response = await client.send(command);
|
|
19
|
+
* ```
|
|
20
|
+
*
|
|
21
|
+
* @see {@link CreateDocumentationVersionCommandInput} for command's `input` shape.
|
|
22
|
+
* @see {@link CreateDocumentationVersionCommandOutput} for command's `response` shape.
|
|
23
|
+
* @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape.
|
|
24
|
+
*
|
|
25
|
+
*/
|
|
9
26
|
export declare class CreateDocumentationVersionCommand extends $Command<CreateDocumentationVersionCommandInput, CreateDocumentationVersionCommandOutput, APIGatewayClientResolvedConfig> {
|
|
10
27
|
readonly input: CreateDocumentationVersionCommandInput;
|
|
11
28
|
constructor(input: CreateDocumentationVersionCommandInput);
|
|
@@ -7,7 +7,7 @@ export interface CreateModelCommandInput extends CreateModelRequest {
|
|
|
7
7
|
export interface CreateModelCommandOutput extends Model, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Adds a new
|
|
10
|
+
* <p>Adds a new Model resource to an existing RestApi resource.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface CreateRequestValidatorCommandInput extends CreateRequestValidat
|
|
|
7
7
|
export interface CreateRequestValidatorCommandOutput extends RequestValidator, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a
|
|
10
|
+
* <p>Creates a RequestValidator of a given RestApi.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface CreateResourceCommandInput extends CreateResourceRequest {
|
|
|
7
7
|
export interface CreateResourceCommandOutput extends Resource, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a
|
|
10
|
+
* <p>Creates a Resource resource.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface CreateRestApiCommandInput extends CreateRestApiRequest {
|
|
|
7
7
|
export interface CreateRestApiCommandOutput extends RestApi, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a new
|
|
10
|
+
* <p>Creates a new RestApi resource.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,8 +7,7 @@ export interface CreateStageCommandInput extends CreateStageRequest {
|
|
|
7
7
|
export interface CreateStageCommandOutput extends Stage, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a new
|
|
11
|
-
* <!-- <p>Creates a <a>Stage</a> resource.</p> -->
|
|
10
|
+
* <p>Creates a new Stage resource that references a pre-existing Deployment for the API. </p>
|
|
12
11
|
* @example
|
|
13
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface DeleteApiKeyCommandInput extends DeleteApiKeyRequest {
|
|
|
7
7
|
export interface DeleteApiKeyCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes the
|
|
10
|
+
* <p>Deletes the ApiKey resource.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,8 +7,7 @@ export interface DeleteAuthorizerCommandInput extends DeleteAuthorizerRequest {
|
|
|
7
7
|
export interface DeleteAuthorizerCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes an existing
|
|
11
|
-
* <div class="seeAlso"><a href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/delete-authorizer.html">AWS CLI</a></div>
|
|
10
|
+
* <p>Deletes an existing Authorizer resource.</p>
|
|
12
11
|
* @example
|
|
13
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface DeleteBasePathMappingCommandInput extends DeleteBasePathMapping
|
|
|
7
7
|
export interface DeleteBasePathMappingCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes the
|
|
10
|
+
* <p>Deletes the BasePathMapping resource.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface DeleteClientCertificateCommandInput extends DeleteClientCertifi
|
|
|
7
7
|
export interface DeleteClientCertificateCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes the
|
|
10
|
+
* <p>Deletes the ClientCertificate resource.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface DeleteDeploymentCommandInput extends DeleteDeploymentRequest {
|
|
|
7
7
|
export interface DeleteDeploymentCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes a
|
|
10
|
+
* <p>Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -6,6 +6,23 @@ export interface DeleteDocumentationPartCommandInput extends DeleteDocumentation
|
|
|
6
6
|
}
|
|
7
7
|
export interface DeleteDocumentationPartCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Deletes a documentation part</p>
|
|
11
|
+
* @example
|
|
12
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
13
|
+
* ```javascript
|
|
14
|
+
* import { APIGatewayClient, DeleteDocumentationPartCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
|
|
15
|
+
* // const { APIGatewayClient, DeleteDocumentationPartCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
|
|
16
|
+
* const client = new APIGatewayClient(config);
|
|
17
|
+
* const command = new DeleteDocumentationPartCommand(input);
|
|
18
|
+
* const response = await client.send(command);
|
|
19
|
+
* ```
|
|
20
|
+
*
|
|
21
|
+
* @see {@link DeleteDocumentationPartCommandInput} for command's `input` shape.
|
|
22
|
+
* @see {@link DeleteDocumentationPartCommandOutput} for command's `response` shape.
|
|
23
|
+
* @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape.
|
|
24
|
+
*
|
|
25
|
+
*/
|
|
9
26
|
export declare class DeleteDocumentationPartCommand extends $Command<DeleteDocumentationPartCommandInput, DeleteDocumentationPartCommandOutput, APIGatewayClientResolvedConfig> {
|
|
10
27
|
readonly input: DeleteDocumentationPartCommandInput;
|
|
11
28
|
constructor(input: DeleteDocumentationPartCommandInput);
|
|
@@ -6,6 +6,23 @@ export interface DeleteDocumentationVersionCommandInput extends DeleteDocumentat
|
|
|
6
6
|
}
|
|
7
7
|
export interface DeleteDocumentationVersionCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Deletes a documentation version.</p>
|
|
11
|
+
* @example
|
|
12
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
13
|
+
* ```javascript
|
|
14
|
+
* import { APIGatewayClient, DeleteDocumentationVersionCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
|
|
15
|
+
* // const { APIGatewayClient, DeleteDocumentationVersionCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
|
|
16
|
+
* const client = new APIGatewayClient(config);
|
|
17
|
+
* const command = new DeleteDocumentationVersionCommand(input);
|
|
18
|
+
* const response = await client.send(command);
|
|
19
|
+
* ```
|
|
20
|
+
*
|
|
21
|
+
* @see {@link DeleteDocumentationVersionCommandInput} for command's `input` shape.
|
|
22
|
+
* @see {@link DeleteDocumentationVersionCommandOutput} for command's `response` shape.
|
|
23
|
+
* @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape.
|
|
24
|
+
*
|
|
25
|
+
*/
|
|
9
26
|
export declare class DeleteDocumentationVersionCommand extends $Command<DeleteDocumentationVersionCommandInput, DeleteDocumentationVersionCommandOutput, APIGatewayClientResolvedConfig> {
|
|
10
27
|
readonly input: DeleteDocumentationVersionCommandInput;
|
|
11
28
|
constructor(input: DeleteDocumentationVersionCommandInput);
|
|
@@ -7,7 +7,7 @@ export interface DeleteDomainNameCommandInput extends DeleteDomainNameRequest {
|
|
|
7
7
|
export interface DeleteDomainNameCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes the
|
|
10
|
+
* <p>Deletes the DomainName resource.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface DeleteGatewayResponseCommandInput extends DeleteGatewayResponse
|
|
|
7
7
|
export interface DeleteGatewayResponseCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Clears any customization of a
|
|
10
|
+
* <p>Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface DeleteMethodCommandInput extends DeleteMethodRequest {
|
|
|
7
7
|
export interface DeleteMethodCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes an existing
|
|
10
|
+
* <p>Deletes an existing Method resource.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface DeleteMethodResponseCommandInput extends DeleteMethodResponseRe
|
|
|
7
7
|
export interface DeleteMethodResponseCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes an existing
|
|
10
|
+
* <p>Deletes an existing MethodResponse resource.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface DeleteRequestValidatorCommandInput extends DeleteRequestValidat
|
|
|
7
7
|
export interface DeleteRequestValidatorCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes a
|
|
10
|
+
* <p>Deletes a RequestValidator of a given RestApi.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface DeleteResourceCommandInput extends DeleteResourceRequest {
|
|
|
7
7
|
export interface DeleteResourceCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes a
|
|
10
|
+
* <p>Deletes a Resource resource.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface DeleteStageCommandInput extends DeleteStageRequest {
|
|
|
7
7
|
export interface DeleteStageCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes a
|
|
10
|
+
* <p>Deletes a Stage resource.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface DeleteVpcLinkCommandInput extends DeleteVpcLinkRequest {
|
|
|
7
7
|
export interface DeleteVpcLinkCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes an existing
|
|
10
|
+
* <p>Deletes an existing VpcLink of a specified identifier.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface GenerateClientCertificateCommandInput extends GenerateClientCer
|
|
|
7
7
|
export interface GenerateClientCertificateCommandOutput extends ClientCertificate, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Generates a
|
|
10
|
+
* <p>Generates a ClientCertificate resource.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface GetAccountCommandInput extends GetAccountRequest {
|
|
|
7
7
|
export interface GetAccountCommandOutput extends Account, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Gets information about the current
|
|
10
|
+
* <p>Gets information about the current Account resource.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface GetApiKeyCommandInput extends GetApiKeyRequest {
|
|
|
7
7
|
export interface GetApiKeyCommandOutput extends ApiKey, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Gets information about the current
|
|
10
|
+
* <p>Gets information about the current ApiKey resource.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface GetApiKeysCommandInput extends GetApiKeysRequest {
|
|
|
7
7
|
export interface GetApiKeysCommandOutput extends ApiKeys, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Gets information about the current
|
|
10
|
+
* <p>Gets information about the current ApiKeys resource.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,8 +7,7 @@ export interface GetAuthorizerCommandInput extends GetAuthorizerRequest {
|
|
|
7
7
|
export interface GetAuthorizerCommandOutput extends Authorizer, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Describe an existing
|
|
11
|
-
* <div class="seeAlso"><a href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizer.html">AWS CLI</a></div>
|
|
10
|
+
* <p>Describe an existing Authorizer resource.</p>
|
|
12
11
|
* @example
|
|
13
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
13
|
* ```javascript
|
|
@@ -7,8 +7,7 @@ export interface GetAuthorizersCommandInput extends GetAuthorizersRequest {
|
|
|
7
7
|
export interface GetAuthorizersCommandOutput extends Authorizers, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Describe an existing
|
|
11
|
-
* <div class="seeAlso"><a href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizers.html">AWS CLI</a></div>
|
|
10
|
+
* <p>Describe an existing Authorizers resource.</p>
|
|
12
11
|
* @example
|
|
13
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface GetBasePathMappingCommandInput extends GetBasePathMappingReques
|
|
|
7
7
|
export interface GetBasePathMappingCommandOutput extends BasePathMapping, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Describe a
|
|
10
|
+
* <p>Describe a BasePathMapping resource.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface GetBasePathMappingsCommandInput extends GetBasePathMappingsRequ
|
|
|
7
7
|
export interface GetBasePathMappingsCommandOutput extends BasePathMappings, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Represents a collection of
|
|
10
|
+
* <p>Represents a collection of BasePathMapping resources.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface GetClientCertificateCommandInput extends GetClientCertificateRe
|
|
|
7
7
|
export interface GetClientCertificateCommandOutput extends ClientCertificate, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Gets information about the current
|
|
10
|
+
* <p>Gets information about the current ClientCertificate resource.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface GetClientCertificatesCommandInput extends GetClientCertificates
|
|
|
7
7
|
export interface GetClientCertificatesCommandOutput extends ClientCertificates, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Gets a collection of
|
|
10
|
+
* <p>Gets a collection of ClientCertificate resources.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface GetDeploymentCommandInput extends GetDeploymentRequest {
|
|
|
7
7
|
export interface GetDeploymentCommandOutput extends Deployment, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Gets information about a
|
|
10
|
+
* <p>Gets information about a Deployment resource.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface GetDeploymentsCommandInput extends GetDeploymentsRequest {
|
|
|
7
7
|
export interface GetDeploymentsCommandOutput extends Deployments, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Gets information about a
|
|
10
|
+
* <p>Gets information about a Deployments collection.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -6,6 +6,23 @@ export interface GetDocumentationPartCommandInput extends GetDocumentationPartRe
|
|
|
6
6
|
}
|
|
7
7
|
export interface GetDocumentationPartCommandOutput extends DocumentationPart, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Gets a documentation part.</p>
|
|
11
|
+
* @example
|
|
12
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
13
|
+
* ```javascript
|
|
14
|
+
* import { APIGatewayClient, GetDocumentationPartCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
|
|
15
|
+
* // const { APIGatewayClient, GetDocumentationPartCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
|
|
16
|
+
* const client = new APIGatewayClient(config);
|
|
17
|
+
* const command = new GetDocumentationPartCommand(input);
|
|
18
|
+
* const response = await client.send(command);
|
|
19
|
+
* ```
|
|
20
|
+
*
|
|
21
|
+
* @see {@link GetDocumentationPartCommandInput} for command's `input` shape.
|
|
22
|
+
* @see {@link GetDocumentationPartCommandOutput} for command's `response` shape.
|
|
23
|
+
* @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape.
|
|
24
|
+
*
|
|
25
|
+
*/
|
|
9
26
|
export declare class GetDocumentationPartCommand extends $Command<GetDocumentationPartCommandInput, GetDocumentationPartCommandOutput, APIGatewayClientResolvedConfig> {
|
|
10
27
|
readonly input: GetDocumentationPartCommandInput;
|
|
11
28
|
constructor(input: GetDocumentationPartCommandInput);
|
|
@@ -6,6 +6,23 @@ export interface GetDocumentationPartsCommandInput extends GetDocumentationParts
|
|
|
6
6
|
}
|
|
7
7
|
export interface GetDocumentationPartsCommandOutput extends DocumentationParts, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Gets documentation parts.</p>
|
|
11
|
+
* @example
|
|
12
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
13
|
+
* ```javascript
|
|
14
|
+
* import { APIGatewayClient, GetDocumentationPartsCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
|
|
15
|
+
* // const { APIGatewayClient, GetDocumentationPartsCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
|
|
16
|
+
* const client = new APIGatewayClient(config);
|
|
17
|
+
* const command = new GetDocumentationPartsCommand(input);
|
|
18
|
+
* const response = await client.send(command);
|
|
19
|
+
* ```
|
|
20
|
+
*
|
|
21
|
+
* @see {@link GetDocumentationPartsCommandInput} for command's `input` shape.
|
|
22
|
+
* @see {@link GetDocumentationPartsCommandOutput} for command's `response` shape.
|
|
23
|
+
* @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape.
|
|
24
|
+
*
|
|
25
|
+
*/
|
|
9
26
|
export declare class GetDocumentationPartsCommand extends $Command<GetDocumentationPartsCommandInput, GetDocumentationPartsCommandOutput, APIGatewayClientResolvedConfig> {
|
|
10
27
|
readonly input: GetDocumentationPartsCommandInput;
|
|
11
28
|
constructor(input: GetDocumentationPartsCommandInput);
|
|
@@ -6,6 +6,23 @@ export interface GetDocumentationVersionCommandInput extends GetDocumentationVer
|
|
|
6
6
|
}
|
|
7
7
|
export interface GetDocumentationVersionCommandOutput extends DocumentationVersion, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Gets a documentation version.</p>
|
|
11
|
+
* @example
|
|
12
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
13
|
+
* ```javascript
|
|
14
|
+
* import { APIGatewayClient, GetDocumentationVersionCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
|
|
15
|
+
* // const { APIGatewayClient, GetDocumentationVersionCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
|
|
16
|
+
* const client = new APIGatewayClient(config);
|
|
17
|
+
* const command = new GetDocumentationVersionCommand(input);
|
|
18
|
+
* const response = await client.send(command);
|
|
19
|
+
* ```
|
|
20
|
+
*
|
|
21
|
+
* @see {@link GetDocumentationVersionCommandInput} for command's `input` shape.
|
|
22
|
+
* @see {@link GetDocumentationVersionCommandOutput} for command's `response` shape.
|
|
23
|
+
* @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape.
|
|
24
|
+
*
|
|
25
|
+
*/
|
|
9
26
|
export declare class GetDocumentationVersionCommand extends $Command<GetDocumentationVersionCommandInput, GetDocumentationVersionCommandOutput, APIGatewayClientResolvedConfig> {
|
|
10
27
|
readonly input: GetDocumentationVersionCommandInput;
|
|
11
28
|
constructor(input: GetDocumentationVersionCommandInput);
|
|
@@ -6,6 +6,23 @@ export interface GetDocumentationVersionsCommandInput extends GetDocumentationVe
|
|
|
6
6
|
}
|
|
7
7
|
export interface GetDocumentationVersionsCommandOutput extends DocumentationVersions, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Gets documentation versions.</p>
|
|
11
|
+
* @example
|
|
12
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
13
|
+
* ```javascript
|
|
14
|
+
* import { APIGatewayClient, GetDocumentationVersionsCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
|
|
15
|
+
* // const { APIGatewayClient, GetDocumentationVersionsCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
|
|
16
|
+
* const client = new APIGatewayClient(config);
|
|
17
|
+
* const command = new GetDocumentationVersionsCommand(input);
|
|
18
|
+
* const response = await client.send(command);
|
|
19
|
+
* ```
|
|
20
|
+
*
|
|
21
|
+
* @see {@link GetDocumentationVersionsCommandInput} for command's `input` shape.
|
|
22
|
+
* @see {@link GetDocumentationVersionsCommandOutput} for command's `response` shape.
|
|
23
|
+
* @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape.
|
|
24
|
+
*
|
|
25
|
+
*/
|
|
9
26
|
export declare class GetDocumentationVersionsCommand extends $Command<GetDocumentationVersionsCommandInput, GetDocumentationVersionsCommandOutput, APIGatewayClientResolvedConfig> {
|
|
10
27
|
readonly input: GetDocumentationVersionsCommandInput;
|
|
11
28
|
constructor(input: GetDocumentationVersionsCommandInput);
|
|
@@ -7,7 +7,7 @@ export interface GetDomainNamesCommandInput extends GetDomainNamesRequest {
|
|
|
7
7
|
export interface GetDomainNamesCommandOutput extends DomainNames, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Represents a collection of
|
|
10
|
+
* <p>Represents a collection of DomainName resources.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface GetExportCommandInput extends GetExportRequest {
|
|
|
7
7
|
export interface GetExportCommandOutput extends ExportResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Exports a deployed version of a
|
|
10
|
+
* <p>Exports a deployed version of a RestApi in a specified format.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface GetGatewayResponseCommandInput extends GetGatewayResponseReques
|
|
|
7
7
|
export interface GetGatewayResponseCommandOutput extends GatewayResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Gets a
|
|
10
|
+
* <p>Gets a GatewayResponse of a specified response type on the given RestApi.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface GetGatewayResponsesCommandInput extends GetGatewayResponsesRequ
|
|
|
7
7
|
export interface GetGatewayResponsesCommandOutput extends GatewayResponses, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Gets the
|
|
10
|
+
* <p>Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface GetMethodCommandInput extends GetMethodRequest {
|
|
|
7
7
|
export interface GetMethodCommandOutput extends Method, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Describe an existing
|
|
10
|
+
* <p>Describe an existing Method resource.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface GetMethodResponseCommandInput extends GetMethodResponseRequest
|
|
|
7
7
|
export interface GetMethodResponseCommandOutput extends MethodResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Describes a
|
|
10
|
+
* <p>Describes a MethodResponse resource.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|