@aws-sdk/client-api-gateway 3.325.0 → 3.326.0

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

@@ -45,6 +45,23 @@ export interface CreateApiKeyCommandOutput extends ApiKey, __MetadataBearer {
  * };
  * const command = new CreateApiKeyCommand(input);
  * const response = await client.send(command);
+ * // { // ApiKey
+ * //   id: "STRING_VALUE",
+ * //   value: "STRING_VALUE",
+ * //   name: "STRING_VALUE",
+ * //   customerId: "STRING_VALUE",
+ * //   description: "STRING_VALUE",
+ * //   enabled: true || false,
+ * //   createdDate: new Date("TIMESTAMP"),
+ * //   lastUpdatedDate: new Date("TIMESTAMP"),
+ * //   stageKeys: [ // ListOfString
+ * //     "STRING_VALUE",
+ * //   ],
+ * //   tags: { // MapOfStringToString
+ * //     "<keys>": "STRING_VALUE",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param CreateApiKeyCommandInput - {@link CreateApiKeyCommandInput}
@@ -71,6 +88,8 @@ export interface CreateApiKeyCommandOutput extends ApiKey, __MetadataBearer {
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>The request is denied because the caller has insufficient permissions.</p>
  *
+ * @throws {@link APIGatewayServiceException}
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
  *
  */
 export declare class CreateApiKeyCommand extends $Command<CreateApiKeyCommandInput, CreateApiKeyCommandOutput, APIGatewayClientResolvedConfig> {

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

@@ -42,6 +42,21 @@ export interface CreateAuthorizerCommandOutput extends Authorizer, __MetadataBea
  * };
  * const command = new CreateAuthorizerCommand(input);
  * const response = await client.send(command);
+ * // { // Authorizer
+ * //   id: "STRING_VALUE",
+ * //   name: "STRING_VALUE",
+ * //   type: "TOKEN" || "REQUEST" || "COGNITO_USER_POOLS",
+ * //   providerARNs: [ // ListOfARNs
+ * //     "STRING_VALUE",
+ * //   ],
+ * //   authType: "STRING_VALUE",
+ * //   authorizerUri: "STRING_VALUE",
+ * //   authorizerCredentials: "STRING_VALUE",
+ * //   identitySource: "STRING_VALUE",
+ * //   identityValidationExpression: "STRING_VALUE",
+ * //   authorizerResultTtlInSeconds: Number("int"),
+ * // };
+ *
  * ```
  *
  * @param CreateAuthorizerCommandInput - {@link CreateAuthorizerCommandInput}
@@ -68,6 +83,8 @@ export interface CreateAuthorizerCommandOutput extends Authorizer, __MetadataBea
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>The request is denied because the caller has insufficient permissions.</p>
  *
+ * @throws {@link APIGatewayServiceException}
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
  *
  */
 export declare class CreateAuthorizerCommand extends $Command<CreateAuthorizerCommandInput, CreateAuthorizerCommandOutput, APIGatewayClientResolvedConfig> {

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

@@ -34,6 +34,12 @@ export interface CreateBasePathMappingCommandOutput extends BasePathMapping, __M
  * };
  * const command = new CreateBasePathMappingCommand(input);
  * const response = await client.send(command);
+ * // { // BasePathMapping
+ * //   basePath: "STRING_VALUE",
+ * //   restApiId: "STRING_VALUE",
+ * //   stage: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param CreateBasePathMappingCommandInput - {@link CreateBasePathMappingCommandInput}
@@ -60,6 +66,8 @@ export interface CreateBasePathMappingCommandOutput extends BasePathMapping, __M
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>The request is denied because the caller has insufficient permissions.</p>
  *
+ * @throws {@link APIGatewayServiceException}
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
  *
  */
 export declare class CreateBasePathMappingCommand extends $Command<CreateBasePathMappingCommandInput, CreateBasePathMappingCommandOutput, APIGatewayClientResolvedConfig> {

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

@@ -47,6 +47,20 @@ export interface CreateDeploymentCommandOutput extends Deployment, __MetadataBea
  * };
  * const command = new CreateDeploymentCommand(input);
  * const response = await client.send(command);
+ * // { // Deployment
+ * //   id: "STRING_VALUE",
+ * //   description: "STRING_VALUE",
+ * //   createdDate: new Date("TIMESTAMP"),
+ * //   apiSummary: { // PathToMapOfMethodSnapshot
+ * //     "<keys>": { // MapOfMethodSnapshot
+ * //       "<keys>": { // MethodSnapshot
+ * //         authorizationType: "STRING_VALUE",
+ * //         apiKeyRequired: true || false,
+ * //       },
+ * //     },
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param CreateDeploymentCommandInput - {@link CreateDeploymentCommandInput}
@@ -76,6 +90,8 @@ export interface CreateDeploymentCommandOutput extends Deployment, __MetadataBea
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>The request is denied because the caller has insufficient permissions.</p>
  *
+ * @throws {@link APIGatewayServiceException}
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
  *
  */
 export declare class CreateDeploymentCommand extends $Command<CreateDeploymentCommandInput, CreateDeploymentCommandOutput, APIGatewayClientResolvedConfig> {

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

@@ -39,6 +39,18 @@ export interface CreateDocumentationPartCommandOutput extends DocumentationPart,
  * };
  * const command = new CreateDocumentationPartCommand(input);
  * const response = await client.send(command);
+ * // { // DocumentationPart
+ * //   id: "STRING_VALUE",
+ * //   location: { // DocumentationPartLocation
+ * //     type: "API" || "AUTHORIZER" || "MODEL" || "RESOURCE" || "METHOD" || "PATH_PARAMETER" || "QUERY_PARAMETER" || "REQUEST_HEADER" || "REQUEST_BODY" || "RESPONSE" || "RESPONSE_HEADER" || "RESPONSE_BODY", // required
+ * //     path: "STRING_VALUE",
+ * //     method: "STRING_VALUE",
+ * //     statusCode: "STRING_VALUE",
+ * //     name: "STRING_VALUE",
+ * //   },
+ * //   properties: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param CreateDocumentationPartCommandInput - {@link CreateDocumentationPartCommandInput}
@@ -65,6 +77,8 @@ export interface CreateDocumentationPartCommandOutput extends DocumentationPart,
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>The request is denied because the caller has insufficient permissions.</p>
  *
+ * @throws {@link APIGatewayServiceException}
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
  *
  */
 export declare class CreateDocumentationPartCommand extends $Command<CreateDocumentationPartCommandInput, CreateDocumentationPartCommandOutput, APIGatewayClientResolvedConfig> {

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

@@ -34,6 +34,12 @@ export interface CreateDocumentationVersionCommandOutput extends DocumentationVe
  * };
  * const command = new CreateDocumentationVersionCommand(input);
  * const response = await client.send(command);
+ * // { // DocumentationVersion
+ * //   version: "STRING_VALUE",
+ * //   createdDate: new Date("TIMESTAMP"),
+ * //   description: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param CreateDocumentationVersionCommandInput - {@link CreateDocumentationVersionCommandInput}
@@ -60,6 +66,8 @@ export interface CreateDocumentationVersionCommandOutput extends DocumentationVe
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>The request is denied because the caller has insufficient permissions.</p>
  *
+ * @throws {@link APIGatewayServiceException}
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
  *
  */
 export declare class CreateDocumentationVersionCommand extends $Command<CreateDocumentationVersionCommandInput, CreateDocumentationVersionCommandOutput, APIGatewayClientResolvedConfig> {

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

@@ -55,6 +55,41 @@ export interface CreateDomainNameCommandOutput extends DomainName, __MetadataBea
  * };
  * const command = new CreateDomainNameCommand(input);
  * const response = await client.send(command);
+ * // { // DomainName
+ * //   domainName: "STRING_VALUE",
+ * //   certificateName: "STRING_VALUE",
+ * //   certificateArn: "STRING_VALUE",
+ * //   certificateUploadDate: new Date("TIMESTAMP"),
+ * //   regionalDomainName: "STRING_VALUE",
+ * //   regionalHostedZoneId: "STRING_VALUE",
+ * //   regionalCertificateName: "STRING_VALUE",
+ * //   regionalCertificateArn: "STRING_VALUE",
+ * //   distributionDomainName: "STRING_VALUE",
+ * //   distributionHostedZoneId: "STRING_VALUE",
+ * //   endpointConfiguration: { // EndpointConfiguration
+ * //     types: [ // ListOfEndpointType
+ * //       "REGIONAL" || "EDGE" || "PRIVATE",
+ * //     ],
+ * //     vpcEndpointIds: [ // ListOfString
+ * //       "STRING_VALUE",
+ * //     ],
+ * //   },
+ * //   domainNameStatus: "AVAILABLE" || "UPDATING" || "PENDING" || "PENDING_CERTIFICATE_REIMPORT" || "PENDING_OWNERSHIP_VERIFICATION",
+ * //   domainNameStatusMessage: "STRING_VALUE",
+ * //   securityPolicy: "TLS_1_0" || "TLS_1_2",
+ * //   tags: { // MapOfStringToString
+ * //     "<keys>": "STRING_VALUE",
+ * //   },
+ * //   mutualTlsAuthentication: { // MutualTlsAuthentication
+ * //     truststoreUri: "STRING_VALUE",
+ * //     truststoreVersion: "STRING_VALUE",
+ * //     truststoreWarnings: [
+ * //       "STRING_VALUE",
+ * //     ],
+ * //   },
+ * //   ownershipVerificationCertificateArn: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param CreateDomainNameCommandInput - {@link CreateDomainNameCommandInput}
@@ -78,6 +113,8 @@ export interface CreateDomainNameCommandOutput extends DomainName, __MetadataBea
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>The request is denied because the caller has insufficient permissions.</p>
  *
+ * @throws {@link APIGatewayServiceException}
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
  *
  */
 export declare class CreateDomainNameCommand extends $Command<CreateDomainNameCommandInput, CreateDomainNameCommandOutput, APIGatewayClientResolvedConfig> {

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

@@ -35,6 +35,14 @@ export interface CreateModelCommandOutput extends Model, __MetadataBearer {
  * };
  * const command = new CreateModelCommand(input);
  * const response = await client.send(command);
+ * // { // Model
+ * //   id: "STRING_VALUE",
+ * //   name: "STRING_VALUE",
+ * //   description: "STRING_VALUE",
+ * //   schema: "STRING_VALUE",
+ * //   contentType: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param CreateModelCommandInput - {@link CreateModelCommandInput}
@@ -61,6 +69,8 @@ export interface CreateModelCommandOutput extends Model, __MetadataBearer {
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>The request is denied because the caller has insufficient permissions.</p>
  *
+ * @throws {@link APIGatewayServiceException}
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
  *
  */
 export declare class CreateModelCommand extends $Command<CreateModelCommandInput, CreateModelCommandOutput, APIGatewayClientResolvedConfig> {

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

@@ -34,6 +34,13 @@ export interface CreateRequestValidatorCommandOutput extends RequestValidator, _
  * };
  * const command = new CreateRequestValidatorCommand(input);
  * const response = await client.send(command);
+ * // { // RequestValidator
+ * //   id: "STRING_VALUE",
+ * //   name: "STRING_VALUE",
+ * //   validateRequestBody: true || false,
+ * //   validateRequestParameters: true || false,
+ * // };
+ *
  * ```
  *
  * @param CreateRequestValidatorCommandInput - {@link CreateRequestValidatorCommandInput}
@@ -60,6 +67,8 @@ export interface CreateRequestValidatorCommandOutput extends RequestValidator, _
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>The request is denied because the caller has insufficient permissions.</p>
  *
+ * @throws {@link APIGatewayServiceException}
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
  *
  */
 export declare class CreateRequestValidatorCommand extends $Command<CreateRequestValidatorCommandInput, CreateRequestValidatorCommandOutput, APIGatewayClientResolvedConfig> {

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

@@ -33,6 +33,72 @@ export interface CreateResourceCommandOutput extends Resource, __MetadataBearer
  * };
  * const command = new CreateResourceCommand(input);
  * const response = await client.send(command);
+ * // { // Resource
+ * //   id: "STRING_VALUE",
+ * //   parentId: "STRING_VALUE",
+ * //   pathPart: "STRING_VALUE",
+ * //   path: "STRING_VALUE",
+ * //   resourceMethods: { // MapOfMethod
+ * //     "<keys>": { // Method
+ * //       httpMethod: "STRING_VALUE",
+ * //       authorizationType: "STRING_VALUE",
+ * //       authorizerId: "STRING_VALUE",
+ * //       apiKeyRequired: true || false,
+ * //       requestValidatorId: "STRING_VALUE",
+ * //       operationName: "STRING_VALUE",
+ * //       requestParameters: { // MapOfStringToBoolean
+ * //         "<keys>": true || false,
+ * //       },
+ * //       requestModels: { // MapOfStringToString
+ * //         "<keys>": "STRING_VALUE",
+ * //       },
+ * //       methodResponses: { // MapOfMethodResponse
+ * //         "<keys>": { // MethodResponse
+ * //           statusCode: "STRING_VALUE",
+ * //           responseParameters: {
+ * //             "<keys>": true || false,
+ * //           },
+ * //           responseModels: {
+ * //             "<keys>": "STRING_VALUE",
+ * //           },
+ * //         },
+ * //       },
+ * //       methodIntegration: { // Integration
+ * //         type: "HTTP" || "AWS" || "MOCK" || "HTTP_PROXY" || "AWS_PROXY",
+ * //         httpMethod: "STRING_VALUE",
+ * //         uri: "STRING_VALUE",
+ * //         connectionType: "INTERNET" || "VPC_LINK",
+ * //         connectionId: "STRING_VALUE",
+ * //         credentials: "STRING_VALUE",
+ * //         requestParameters: "<MapOfStringToString>",
+ * //         requestTemplates: "<MapOfStringToString>",
+ * //         passthroughBehavior: "STRING_VALUE",
+ * //         contentHandling: "CONVERT_TO_BINARY" || "CONVERT_TO_TEXT",
+ * //         timeoutInMillis: Number("int"),
+ * //         cacheNamespace: "STRING_VALUE",
+ * //         cacheKeyParameters: [ // ListOfString
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         integrationResponses: { // MapOfIntegrationResponse
+ * //           "<keys>": { // IntegrationResponse
+ * //             statusCode: "STRING_VALUE",
+ * //             selectionPattern: "STRING_VALUE",
+ * //             responseParameters: "<MapOfStringToString>",
+ * //             responseTemplates: "<MapOfStringToString>",
+ * //             contentHandling: "CONVERT_TO_BINARY" || "CONVERT_TO_TEXT",
+ * //           },
+ * //         },
+ * //         tlsConfig: { // TlsConfig
+ * //           insecureSkipVerification: true || false,
+ * //         },
+ * //       },
+ * //       authorizationScopes: [
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param CreateResourceCommandInput - {@link CreateResourceCommandInput}
@@ -59,6 +125,8 @@ export interface CreateResourceCommandOutput extends Resource, __MetadataBearer
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>The request is denied because the caller has insufficient permissions.</p>
  *
+ * @throws {@link APIGatewayServiceException}
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
  *
  */
 export declare class CreateResourceCommand extends $Command<CreateResourceCommandInput, CreateResourceCommandOutput, APIGatewayClientResolvedConfig> {

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

@@ -52,6 +52,35 @@ export interface CreateRestApiCommandOutput extends RestApi, __MetadataBearer {
  * };
  * const command = new CreateRestApiCommand(input);
  * const response = await client.send(command);
+ * // { // RestApi
+ * //   id: "STRING_VALUE",
+ * //   name: "STRING_VALUE",
+ * //   description: "STRING_VALUE",
+ * //   createdDate: new Date("TIMESTAMP"),
+ * //   version: "STRING_VALUE",
+ * //   warnings: [ // ListOfString
+ * //     "STRING_VALUE",
+ * //   ],
+ * //   binaryMediaTypes: [
+ * //     "STRING_VALUE",
+ * //   ],
+ * //   minimumCompressionSize: Number("int"),
+ * //   apiKeySource: "HEADER" || "AUTHORIZER",
+ * //   endpointConfiguration: { // EndpointConfiguration
+ * //     types: [ // ListOfEndpointType
+ * //       "REGIONAL" || "EDGE" || "PRIVATE",
+ * //     ],
+ * //     vpcEndpointIds: [
+ * //       "STRING_VALUE",
+ * //     ],
+ * //   },
+ * //   policy: "STRING_VALUE",
+ * //   tags: { // MapOfStringToString
+ * //     "<keys>": "STRING_VALUE",
+ * //   },
+ * //   disableExecuteApiEndpoint: true || false,
+ * // };
+ *
  * ```
  *
  * @param CreateRestApiCommandInput - {@link CreateRestApiCommandInput}
@@ -75,6 +104,8 @@ export interface CreateRestApiCommandOutput extends RestApi, __MetadataBearer {
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>The request is denied because the caller has insufficient permissions.</p>
  *
+ * @throws {@link APIGatewayServiceException}
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
  *
  */
 export declare class CreateRestApiCommand extends $Command<CreateRestApiCommandInput, CreateRestApiCommandOutput, APIGatewayClientResolvedConfig> {

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

@@ -52,6 +52,53 @@ export interface CreateStageCommandOutput extends Stage, __MetadataBearer {
  * };
  * const command = new CreateStageCommand(input);
  * const response = await client.send(command);
+ * // { // Stage
+ * //   deploymentId: "STRING_VALUE",
+ * //   clientCertificateId: "STRING_VALUE",
+ * //   stageName: "STRING_VALUE",
+ * //   description: "STRING_VALUE",
+ * //   cacheClusterEnabled: true || false,
+ * //   cacheClusterSize: "0.5" || "1.6" || "6.1" || "13.5" || "28.4" || "58.2" || "118" || "237",
+ * //   cacheClusterStatus: "CREATE_IN_PROGRESS" || "AVAILABLE" || "DELETE_IN_PROGRESS" || "NOT_AVAILABLE" || "FLUSH_IN_PROGRESS",
+ * //   methodSettings: { // MapOfMethodSettings
+ * //     "<keys>": { // MethodSetting
+ * //       metricsEnabled: true || false,
+ * //       loggingLevel: "STRING_VALUE",
+ * //       dataTraceEnabled: true || false,
+ * //       throttlingBurstLimit: Number("int"),
+ * //       throttlingRateLimit: Number("double"),
+ * //       cachingEnabled: true || false,
+ * //       cacheTtlInSeconds: Number("int"),
+ * //       cacheDataEncrypted: true || false,
+ * //       requireAuthorizationForCacheControl: true || false,
+ * //       unauthorizedCacheControlHeaderStrategy: "FAIL_WITH_403" || "SUCCEED_WITH_RESPONSE_HEADER" || "SUCCEED_WITHOUT_RESPONSE_HEADER",
+ * //     },
+ * //   },
+ * //   variables: { // MapOfStringToString
+ * //     "<keys>": "STRING_VALUE",
+ * //   },
+ * //   documentationVersion: "STRING_VALUE",
+ * //   accessLogSettings: { // AccessLogSettings
+ * //     format: "STRING_VALUE",
+ * //     destinationArn: "STRING_VALUE",
+ * //   },
+ * //   canarySettings: { // CanarySettings
+ * //     percentTraffic: Number("double"),
+ * //     deploymentId: "STRING_VALUE",
+ * //     stageVariableOverrides: {
+ * //       "<keys>": "STRING_VALUE",
+ * //     },
+ * //     useStageCache: true || false,
+ * //   },
+ * //   tracingEnabled: true || false,
+ * //   webAclArn: "STRING_VALUE",
+ * //   tags: {
+ * //     "<keys>": "STRING_VALUE",
+ * //   },
+ * //   createdDate: new Date("TIMESTAMP"),
+ * //   lastUpdatedDate: new Date("TIMESTAMP"),
+ * // };
+ *
  * ```
  *
  * @param CreateStageCommandInput - {@link CreateStageCommandInput}
@@ -78,6 +125,8 @@ export interface CreateStageCommandOutput extends Stage, __MetadataBearer {
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>The request is denied because the caller has insufficient permissions.</p>
  *
+ * @throws {@link APIGatewayServiceException}
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
  *
  */
 export declare class CreateStageCommand extends $Command<CreateStageCommandInput, CreateStageCommandOutput, APIGatewayClientResolvedConfig> {

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

@@ -56,6 +56,37 @@ export interface CreateUsagePlanCommandOutput extends UsagePlan, __MetadataBeare
  * };
  * const command = new CreateUsagePlanCommand(input);
  * const response = await client.send(command);
+ * // { // UsagePlan
+ * //   id: "STRING_VALUE",
+ * //   name: "STRING_VALUE",
+ * //   description: "STRING_VALUE",
+ * //   apiStages: [ // ListOfApiStage
+ * //     { // ApiStage
+ * //       apiId: "STRING_VALUE",
+ * //       stage: "STRING_VALUE",
+ * //       throttle: { // MapOfApiStageThrottleSettings
+ * //         "<keys>": { // ThrottleSettings
+ * //           burstLimit: Number("int"),
+ * //           rateLimit: Number("double"),
+ * //         },
+ * //       },
+ * //     },
+ * //   ],
+ * //   throttle: {
+ * //     burstLimit: Number("int"),
+ * //     rateLimit: Number("double"),
+ * //   },
+ * //   quota: { // QuotaSettings
+ * //     limit: Number("int"),
+ * //     offset: Number("int"),
+ * //     period: "DAY" || "WEEK" || "MONTH",
+ * //   },
+ * //   productCode: "STRING_VALUE",
+ * //   tags: { // MapOfStringToString
+ * //     "<keys>": "STRING_VALUE",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param CreateUsagePlanCommandInput - {@link CreateUsagePlanCommandInput}
@@ -82,6 +113,8 @@ export interface CreateUsagePlanCommandOutput extends UsagePlan, __MetadataBeare
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>The request is denied because the caller has insufficient permissions.</p>
  *
+ * @throws {@link APIGatewayServiceException}
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
  *
  */
 export declare class CreateUsagePlanCommand extends $Command<CreateUsagePlanCommandInput, CreateUsagePlanCommandOutput, APIGatewayClientResolvedConfig> {

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

@@ -33,6 +33,13 @@ export interface CreateUsagePlanKeyCommandOutput extends UsagePlanKey, __Metadat
  * };
  * const command = new CreateUsagePlanKeyCommand(input);
  * const response = await client.send(command);
+ * // { // UsagePlanKey
+ * //   id: "STRING_VALUE",
+ * //   type: "STRING_VALUE",
+ * //   value: "STRING_VALUE",
+ * //   name: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param CreateUsagePlanKeyCommandInput - {@link CreateUsagePlanKeyCommandInput}
@@ -59,6 +66,8 @@ export interface CreateUsagePlanKeyCommandOutput extends UsagePlanKey, __Metadat
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>The request is denied because the caller has insufficient permissions.</p>
  *
+ * @throws {@link APIGatewayServiceException}
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
  *
  */
 export declare class CreateUsagePlanKeyCommand extends $Command<CreateUsagePlanKeyCommandInput, CreateUsagePlanKeyCommandOutput, APIGatewayClientResolvedConfig> {

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

@@ -38,6 +38,20 @@ export interface CreateVpcLinkCommandOutput extends VpcLink, __MetadataBearer {
  * };
  * const command = new CreateVpcLinkCommand(input);
  * const response = await client.send(command);
+ * // { // VpcLink
+ * //   id: "STRING_VALUE",
+ * //   name: "STRING_VALUE",
+ * //   description: "STRING_VALUE",
+ * //   targetArns: [ // ListOfString
+ * //     "STRING_VALUE",
+ * //   ],
+ * //   status: "AVAILABLE" || "PENDING" || "DELETING" || "FAILED",
+ * //   statusMessage: "STRING_VALUE",
+ * //   tags: { // MapOfStringToString
+ * //     "<keys>": "STRING_VALUE",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param CreateVpcLinkCommandInput - {@link CreateVpcLinkCommandInput}
@@ -61,6 +75,8 @@ export interface CreateVpcLinkCommandOutput extends VpcLink, __MetadataBearer {
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>The request is denied because the caller has insufficient permissions.</p>
  *
+ * @throws {@link APIGatewayServiceException}
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
  *
  */
 export declare class CreateVpcLinkCommand extends $Command<CreateVpcLinkCommandInput, CreateVpcLinkCommandOutput, APIGatewayClientResolvedConfig> {

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

@@ -31,6 +31,8 @@ export interface DeleteApiKeyCommandOutput extends __MetadataBearer {
  * };
  * const command = new DeleteApiKeyCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeleteApiKeyCommandInput - {@link DeleteApiKeyCommandInput}
@@ -54,6 +56,8 @@ export interface DeleteApiKeyCommandOutput extends __MetadataBearer {
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>The request is denied because the caller has insufficient permissions.</p>
  *
+ * @throws {@link APIGatewayServiceException}
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
  *
  */
 export declare class DeleteApiKeyCommand extends $Command<DeleteApiKeyCommandInput, DeleteApiKeyCommandOutput, APIGatewayClientResolvedConfig> {

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

@@ -32,6 +32,8 @@ export interface DeleteAuthorizerCommandOutput extends __MetadataBearer {
  * };
  * const command = new DeleteAuthorizerCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeleteAuthorizerCommandInput - {@link DeleteAuthorizerCommandInput}
@@ -55,6 +57,8 @@ export interface DeleteAuthorizerCommandOutput extends __MetadataBearer {
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>The request is denied because the caller has insufficient permissions.</p>
  *
+ * @throws {@link APIGatewayServiceException}
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
  *
  */
 export declare class DeleteAuthorizerCommand extends $Command<DeleteAuthorizerCommandInput, DeleteAuthorizerCommandOutput, APIGatewayClientResolvedConfig> {

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

@@ -32,6 +32,8 @@ export interface DeleteBasePathMappingCommandOutput extends __MetadataBearer {
  * };
  * const command = new DeleteBasePathMappingCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeleteBasePathMappingCommandInput - {@link DeleteBasePathMappingCommandInput}
@@ -55,6 +57,8 @@ export interface DeleteBasePathMappingCommandOutput extends __MetadataBearer {
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>The request is denied because the caller has insufficient permissions.</p>
  *
+ * @throws {@link APIGatewayServiceException}
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
  *
  */
 export declare class DeleteBasePathMappingCommand extends $Command<DeleteBasePathMappingCommandInput, DeleteBasePathMappingCommandOutput, APIGatewayClientResolvedConfig> {

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

@@ -31,6 +31,8 @@ export interface DeleteClientCertificateCommandOutput extends __MetadataBearer {
  * };
  * const command = new DeleteClientCertificateCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeleteClientCertificateCommandInput - {@link DeleteClientCertificateCommandInput}
@@ -54,6 +56,8 @@ export interface DeleteClientCertificateCommandOutput extends __MetadataBearer {
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>The request is denied because the caller has insufficient permissions.</p>
  *
+ * @throws {@link APIGatewayServiceException}
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
  *
  */
 export declare class DeleteClientCertificateCommand extends $Command<DeleteClientCertificateCommandInput, DeleteClientCertificateCommandOutput, APIGatewayClientResolvedConfig> {

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

@@ -32,6 +32,8 @@ export interface DeleteDeploymentCommandOutput extends __MetadataBearer {
  * };
  * const command = new DeleteDeploymentCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeleteDeploymentCommandInput - {@link DeleteDeploymentCommandInput}
@@ -58,6 +60,8 @@ export interface DeleteDeploymentCommandOutput extends __MetadataBearer {
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>The request is denied because the caller has insufficient permissions.</p>
  *
+ * @throws {@link APIGatewayServiceException}
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
  *
  */
 export declare class DeleteDeploymentCommand extends $Command<DeleteDeploymentCommandInput, DeleteDeploymentCommandOutput, APIGatewayClientResolvedConfig> {