@aws-sdk/client-api-gateway 3.298.0 → 3.300.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.
Files changed (121) hide show
  1. package/dist-types/commands/CreateApiKeyCommand.d.ts +17 -0
  2. package/dist-types/commands/CreateAuthorizerCommand.d.ts +14 -0
  3. package/dist-types/commands/CreateBasePathMappingCommand.d.ts +6 -0
  4. package/dist-types/commands/CreateDeploymentCommand.d.ts +19 -0
  5. package/dist-types/commands/CreateDocumentationPartCommand.d.ts +11 -0
  6. package/dist-types/commands/CreateDocumentationVersionCommand.d.ts +6 -0
  7. package/dist-types/commands/CreateDomainNameCommand.d.ts +27 -0
  8. package/dist-types/commands/CreateModelCommand.d.ts +7 -0
  9. package/dist-types/commands/CreateRequestValidatorCommand.d.ts +6 -0
  10. package/dist-types/commands/CreateResourceCommand.d.ts +5 -0
  11. package/dist-types/commands/CreateRestApiCommand.d.ts +24 -0
  12. package/dist-types/commands/CreateStageCommand.d.ts +24 -0
  13. package/dist-types/commands/CreateUsagePlanCommand.d.ts +28 -0
  14. package/dist-types/commands/CreateUsagePlanKeyCommand.d.ts +5 -0
  15. package/dist-types/commands/CreateVpcLinkCommand.d.ts +10 -0
  16. package/dist-types/commands/DeleteApiKeyCommand.d.ts +3 -0
  17. package/dist-types/commands/DeleteAuthorizerCommand.d.ts +4 -0
  18. package/dist-types/commands/DeleteBasePathMappingCommand.d.ts +4 -0
  19. package/dist-types/commands/DeleteClientCertificateCommand.d.ts +3 -0
  20. package/dist-types/commands/DeleteDeploymentCommand.d.ts +4 -0
  21. package/dist-types/commands/DeleteDocumentationPartCommand.d.ts +4 -0
  22. package/dist-types/commands/DeleteDocumentationVersionCommand.d.ts +4 -0
  23. package/dist-types/commands/DeleteDomainNameCommand.d.ts +3 -0
  24. package/dist-types/commands/DeleteGatewayResponseCommand.d.ts +4 -0
  25. package/dist-types/commands/DeleteIntegrationCommand.d.ts +5 -0
  26. package/dist-types/commands/DeleteIntegrationResponseCommand.d.ts +6 -0
  27. package/dist-types/commands/DeleteMethodCommand.d.ts +5 -0
  28. package/dist-types/commands/DeleteMethodResponseCommand.d.ts +6 -0
  29. package/dist-types/commands/DeleteModelCommand.d.ts +4 -0
  30. package/dist-types/commands/DeleteRequestValidatorCommand.d.ts +4 -0
  31. package/dist-types/commands/DeleteResourceCommand.d.ts +4 -0
  32. package/dist-types/commands/DeleteRestApiCommand.d.ts +3 -0
  33. package/dist-types/commands/DeleteStageCommand.d.ts +4 -0
  34. package/dist-types/commands/DeleteUsagePlanCommand.d.ts +3 -0
  35. package/dist-types/commands/DeleteUsagePlanKeyCommand.d.ts +4 -0
  36. package/dist-types/commands/DeleteVpcLinkCommand.d.ts +3 -0
  37. package/dist-types/commands/FlushStageAuthorizersCacheCommand.d.ts +4 -0
  38. package/dist-types/commands/FlushStageCacheCommand.d.ts +4 -0
  39. package/dist-types/commands/GenerateClientCertificateCommand.d.ts +6 -0
  40. package/dist-types/commands/GetAccountCommand.d.ts +1 -0
  41. package/dist-types/commands/GetApiKeyCommand.d.ts +4 -0
  42. package/dist-types/commands/GetApiKeysCommand.d.ts +7 -0
  43. package/dist-types/commands/GetAuthorizerCommand.d.ts +4 -0
  44. package/dist-types/commands/GetAuthorizersCommand.d.ts +5 -0
  45. package/dist-types/commands/GetBasePathMappingCommand.d.ts +4 -0
  46. package/dist-types/commands/GetBasePathMappingsCommand.d.ts +5 -0
  47. package/dist-types/commands/GetClientCertificateCommand.d.ts +3 -0
  48. package/dist-types/commands/GetClientCertificatesCommand.d.ts +4 -0
  49. package/dist-types/commands/GetDeploymentCommand.d.ts +7 -0
  50. package/dist-types/commands/GetDeploymentsCommand.d.ts +5 -0
  51. package/dist-types/commands/GetDocumentationPartCommand.d.ts +4 -0
  52. package/dist-types/commands/GetDocumentationPartsCommand.d.ts +9 -0
  53. package/dist-types/commands/GetDocumentationVersionCommand.d.ts +4 -0
  54. package/dist-types/commands/GetDocumentationVersionsCommand.d.ts +5 -0
  55. package/dist-types/commands/GetDomainNameCommand.d.ts +3 -0
  56. package/dist-types/commands/GetDomainNamesCommand.d.ts +4 -0
  57. package/dist-types/commands/GetExportCommand.d.ts +9 -0
  58. package/dist-types/commands/GetGatewayResponseCommand.d.ts +4 -0
  59. package/dist-types/commands/GetGatewayResponsesCommand.d.ts +5 -0
  60. package/dist-types/commands/GetIntegrationCommand.d.ts +5 -0
  61. package/dist-types/commands/GetIntegrationResponseCommand.d.ts +6 -0
  62. package/dist-types/commands/GetMethodCommand.d.ts +5 -0
  63. package/dist-types/commands/GetMethodResponseCommand.d.ts +6 -0
  64. package/dist-types/commands/GetModelCommand.d.ts +5 -0
  65. package/dist-types/commands/GetModelTemplateCommand.d.ts +4 -0
  66. package/dist-types/commands/GetModelsCommand.d.ts +5 -0
  67. package/dist-types/commands/GetRequestValidatorCommand.d.ts +4 -0
  68. package/dist-types/commands/GetRequestValidatorsCommand.d.ts +5 -0
  69. package/dist-types/commands/GetResourceCommand.d.ts +7 -0
  70. package/dist-types/commands/GetResourcesCommand.d.ts +8 -0
  71. package/dist-types/commands/GetRestApiCommand.d.ts +3 -0
  72. package/dist-types/commands/GetRestApisCommand.d.ts +4 -0
  73. package/dist-types/commands/GetSdkCommand.d.ts +8 -0
  74. package/dist-types/commands/GetSdkTypeCommand.d.ts +3 -0
  75. package/dist-types/commands/GetSdkTypesCommand.d.ts +4 -0
  76. package/dist-types/commands/GetStageCommand.d.ts +4 -0
  77. package/dist-types/commands/GetStagesCommand.d.ts +4 -0
  78. package/dist-types/commands/GetTagsCommand.d.ts +5 -0
  79. package/dist-types/commands/GetUsageCommand.d.ts +8 -0
  80. package/dist-types/commands/GetUsagePlanCommand.d.ts +3 -0
  81. package/dist-types/commands/GetUsagePlanKeyCommand.d.ts +4 -0
  82. package/dist-types/commands/GetUsagePlanKeysCommand.d.ts +6 -0
  83. package/dist-types/commands/GetUsagePlansCommand.d.ts +5 -0
  84. package/dist-types/commands/GetVpcLinkCommand.d.ts +3 -0
  85. package/dist-types/commands/GetVpcLinksCommand.d.ts +4 -0
  86. package/dist-types/commands/ImportApiKeysCommand.d.ts +5 -0
  87. package/dist-types/commands/ImportDocumentationPartsCommand.d.ts +6 -0
  88. package/dist-types/commands/ImportRestApiCommand.d.ts +7 -0
  89. package/dist-types/commands/PutGatewayResponseCommand.d.ts +11 -0
  90. package/dist-types/commands/PutIntegrationCommand.d.ts +27 -0
  91. package/dist-types/commands/PutIntegrationResponseCommand.d.ts +14 -0
  92. package/dist-types/commands/PutMethodCommand.d.ts +19 -0
  93. package/dist-types/commands/PutMethodResponseCommand.d.ts +12 -0
  94. package/dist-types/commands/PutRestApiCommand.d.ts +9 -0
  95. package/dist-types/commands/TagResourceCommand.d.ts +6 -0
  96. package/dist-types/commands/TestInvokeAuthorizerCommand.d.ts +20 -0
  97. package/dist-types/commands/TestInvokeMethodCommand.d.ts +19 -0
  98. package/dist-types/commands/UntagResourceCommand.d.ts +6 -0
  99. package/dist-types/commands/UpdateAccountCommand.d.ts +10 -0
  100. package/dist-types/commands/UpdateApiKeyCommand.d.ts +11 -0
  101. package/dist-types/commands/UpdateAuthorizerCommand.d.ts +12 -0
  102. package/dist-types/commands/UpdateBasePathMappingCommand.d.ts +12 -0
  103. package/dist-types/commands/UpdateClientCertificateCommand.d.ts +11 -0
  104. package/dist-types/commands/UpdateDeploymentCommand.d.ts +12 -0
  105. package/dist-types/commands/UpdateDocumentationPartCommand.d.ts +12 -0
  106. package/dist-types/commands/UpdateDocumentationVersionCommand.d.ts +12 -0
  107. package/dist-types/commands/UpdateDomainNameCommand.d.ts +11 -0
  108. package/dist-types/commands/UpdateGatewayResponseCommand.d.ts +12 -0
  109. package/dist-types/commands/UpdateIntegrationCommand.d.ts +13 -0
  110. package/dist-types/commands/UpdateIntegrationResponseCommand.d.ts +14 -0
  111. package/dist-types/commands/UpdateMethodCommand.d.ts +13 -0
  112. package/dist-types/commands/UpdateMethodResponseCommand.d.ts +14 -0
  113. package/dist-types/commands/UpdateModelCommand.d.ts +12 -0
  114. package/dist-types/commands/UpdateRequestValidatorCommand.d.ts +12 -0
  115. package/dist-types/commands/UpdateResourceCommand.d.ts +12 -0
  116. package/dist-types/commands/UpdateRestApiCommand.d.ts +11 -0
  117. package/dist-types/commands/UpdateStageCommand.d.ts +12 -0
  118. package/dist-types/commands/UpdateUsageCommand.d.ts +12 -0
  119. package/dist-types/commands/UpdateUsagePlanCommand.d.ts +11 -0
  120. package/dist-types/commands/UpdateVpcLinkCommand.d.ts +11 -0
  121. package/package.json +12 -12
@@ -26,6 +26,23 @@ export interface CreateApiKeyCommandOutput extends ApiKey, __MetadataBearer {
26
26
  * import { APIGatewayClient, CreateApiKeyCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, CreateApiKeyCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * name: "STRING_VALUE",
31
+ * description: "STRING_VALUE",
32
+ * enabled: true || false,
33
+ * generateDistinctId: true || false,
34
+ * value: "STRING_VALUE",
35
+ * stageKeys: [
36
+ * {
37
+ * restApiId: "STRING_VALUE",
38
+ * stageName: "STRING_VALUE",
39
+ * },
40
+ * ],
41
+ * customerId: "STRING_VALUE",
42
+ * tags: {
43
+ * "<keys>": "STRING_VALUE",
44
+ * },
45
+ * };
29
46
  * const command = new CreateApiKeyCommand(input);
30
47
  * const response = await client.send(command);
31
48
  * ```
@@ -26,6 +26,20 @@ export interface CreateAuthorizerCommandOutput extends Authorizer, __MetadataBea
26
26
  * import { APIGatewayClient, CreateAuthorizerCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, CreateAuthorizerCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * restApiId: "STRING_VALUE", // required
31
+ * name: "STRING_VALUE", // required
32
+ * type: "TOKEN" || "REQUEST" || "COGNITO_USER_POOLS", // required
33
+ * providerARNs: [
34
+ * "STRING_VALUE",
35
+ * ],
36
+ * authType: "STRING_VALUE",
37
+ * authorizerUri: "STRING_VALUE",
38
+ * authorizerCredentials: "STRING_VALUE",
39
+ * identitySource: "STRING_VALUE",
40
+ * identityValidationExpression: "STRING_VALUE",
41
+ * authorizerResultTtlInSeconds: Number("int"),
42
+ * };
29
43
  * const command = new CreateAuthorizerCommand(input);
30
44
  * const response = await client.send(command);
31
45
  * ```
@@ -26,6 +26,12 @@ export interface CreateBasePathMappingCommandOutput extends BasePathMapping, __M
26
26
  * import { APIGatewayClient, CreateBasePathMappingCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, CreateBasePathMappingCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * domainName: "STRING_VALUE", // required
31
+ * basePath: "STRING_VALUE",
32
+ * restApiId: "STRING_VALUE", // required
33
+ * stage: "STRING_VALUE",
34
+ * };
29
35
  * const command = new CreateBasePathMappingCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -26,6 +26,25 @@ export interface CreateDeploymentCommandOutput extends Deployment, __MetadataBea
26
26
  * import { APIGatewayClient, CreateDeploymentCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, CreateDeploymentCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * restApiId: "STRING_VALUE", // required
31
+ * stageName: "STRING_VALUE",
32
+ * stageDescription: "STRING_VALUE",
33
+ * description: "STRING_VALUE",
34
+ * cacheClusterEnabled: true || false,
35
+ * cacheClusterSize: "0.5" || "1.6" || "6.1" || "13.5" || "28.4" || "58.2" || "118" || "237",
36
+ * variables: {
37
+ * "<keys>": "STRING_VALUE",
38
+ * },
39
+ * canarySettings: {
40
+ * percentTraffic: Number("double"),
41
+ * stageVariableOverrides: {
42
+ * "<keys>": "STRING_VALUE",
43
+ * },
44
+ * useStageCache: true || false,
45
+ * },
46
+ * tracingEnabled: true || false,
47
+ * };
29
48
  * const command = new CreateDeploymentCommand(input);
30
49
  * const response = await client.send(command);
31
50
  * ```
@@ -26,6 +26,17 @@ export interface CreateDocumentationPartCommandOutput extends DocumentationPart,
26
26
  * import { APIGatewayClient, CreateDocumentationPartCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, CreateDocumentationPartCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * restApiId: "STRING_VALUE", // required
31
+ * location: {
32
+ * type: "API" || "AUTHORIZER" || "MODEL" || "RESOURCE" || "METHOD" || "PATH_PARAMETER" || "QUERY_PARAMETER" || "REQUEST_HEADER" || "REQUEST_BODY" || "RESPONSE" || "RESPONSE_HEADER" || "RESPONSE_BODY", // required
33
+ * path: "STRING_VALUE",
34
+ * method: "STRING_VALUE",
35
+ * statusCode: "STRING_VALUE",
36
+ * name: "STRING_VALUE",
37
+ * },
38
+ * properties: "STRING_VALUE", // required
39
+ * };
29
40
  * const command = new CreateDocumentationPartCommand(input);
30
41
  * const response = await client.send(command);
31
42
  * ```
@@ -26,6 +26,12 @@ export interface CreateDocumentationVersionCommandOutput extends DocumentationVe
26
26
  * import { APIGatewayClient, CreateDocumentationVersionCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, CreateDocumentationVersionCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * restApiId: "STRING_VALUE", // required
31
+ * documentationVersion: "STRING_VALUE", // required
32
+ * stageName: "STRING_VALUE",
33
+ * description: "STRING_VALUE",
34
+ * };
29
35
  * const command = new CreateDocumentationVersionCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -26,6 +26,33 @@ export interface CreateDomainNameCommandOutput extends DomainName, __MetadataBea
26
26
  * import { APIGatewayClient, CreateDomainNameCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, CreateDomainNameCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * domainName: "STRING_VALUE", // required
31
+ * certificateName: "STRING_VALUE",
32
+ * certificateBody: "STRING_VALUE",
33
+ * certificatePrivateKey: "STRING_VALUE",
34
+ * certificateChain: "STRING_VALUE",
35
+ * certificateArn: "STRING_VALUE",
36
+ * regionalCertificateName: "STRING_VALUE",
37
+ * regionalCertificateArn: "STRING_VALUE",
38
+ * endpointConfiguration: {
39
+ * types: [
40
+ * "REGIONAL" || "EDGE" || "PRIVATE",
41
+ * ],
42
+ * vpcEndpointIds: [
43
+ * "STRING_VALUE",
44
+ * ],
45
+ * },
46
+ * tags: {
47
+ * "<keys>": "STRING_VALUE",
48
+ * },
49
+ * securityPolicy: "TLS_1_0" || "TLS_1_2",
50
+ * mutualTlsAuthentication: {
51
+ * truststoreUri: "STRING_VALUE",
52
+ * truststoreVersion: "STRING_VALUE",
53
+ * },
54
+ * ownershipVerificationCertificateArn: "STRING_VALUE",
55
+ * };
29
56
  * const command = new CreateDomainNameCommand(input);
30
57
  * const response = await client.send(command);
31
58
  * ```
@@ -26,6 +26,13 @@ export interface CreateModelCommandOutput extends Model, __MetadataBearer {
26
26
  * import { APIGatewayClient, CreateModelCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, CreateModelCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * restApiId: "STRING_VALUE", // required
31
+ * name: "STRING_VALUE", // required
32
+ * description: "STRING_VALUE",
33
+ * schema: "STRING_VALUE",
34
+ * contentType: "STRING_VALUE", // required
35
+ * };
29
36
  * const command = new CreateModelCommand(input);
30
37
  * const response = await client.send(command);
31
38
  * ```
@@ -26,6 +26,12 @@ export interface CreateRequestValidatorCommandOutput extends RequestValidator, _
26
26
  * import { APIGatewayClient, CreateRequestValidatorCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, CreateRequestValidatorCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * restApiId: "STRING_VALUE", // required
31
+ * name: "STRING_VALUE",
32
+ * validateRequestBody: true || false,
33
+ * validateRequestParameters: true || false,
34
+ * };
29
35
  * const command = new CreateRequestValidatorCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -26,6 +26,11 @@ export interface CreateResourceCommandOutput extends Resource, __MetadataBearer
26
26
  * import { APIGatewayClient, CreateResourceCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, CreateResourceCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * restApiId: "STRING_VALUE", // required
31
+ * parentId: "STRING_VALUE", // required
32
+ * pathPart: "STRING_VALUE", // required
33
+ * };
29
34
  * const command = new CreateResourceCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,30 @@ export interface CreateRestApiCommandOutput extends RestApi, __MetadataBearer {
26
26
  * import { APIGatewayClient, CreateRestApiCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, CreateRestApiCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * name: "STRING_VALUE", // required
31
+ * description: "STRING_VALUE",
32
+ * version: "STRING_VALUE",
33
+ * cloneFrom: "STRING_VALUE",
34
+ * binaryMediaTypes: [
35
+ * "STRING_VALUE",
36
+ * ],
37
+ * minimumCompressionSize: Number("int"),
38
+ * apiKeySource: "HEADER" || "AUTHORIZER",
39
+ * endpointConfiguration: {
40
+ * types: [
41
+ * "REGIONAL" || "EDGE" || "PRIVATE",
42
+ * ],
43
+ * vpcEndpointIds: [
44
+ * "STRING_VALUE",
45
+ * ],
46
+ * },
47
+ * policy: "STRING_VALUE",
48
+ * tags: {
49
+ * "<keys>": "STRING_VALUE",
50
+ * },
51
+ * disableExecuteApiEndpoint: true || false,
52
+ * };
29
53
  * const command = new CreateRestApiCommand(input);
30
54
  * const response = await client.send(command);
31
55
  * ```
@@ -26,6 +26,30 @@ export interface CreateStageCommandOutput extends Stage, __MetadataBearer {
26
26
  * import { APIGatewayClient, CreateStageCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, CreateStageCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * restApiId: "STRING_VALUE", // required
31
+ * stageName: "STRING_VALUE", // required
32
+ * deploymentId: "STRING_VALUE", // required
33
+ * description: "STRING_VALUE",
34
+ * cacheClusterEnabled: true || false,
35
+ * cacheClusterSize: "0.5" || "1.6" || "6.1" || "13.5" || "28.4" || "58.2" || "118" || "237",
36
+ * variables: {
37
+ * "<keys>": "STRING_VALUE",
38
+ * },
39
+ * documentationVersion: "STRING_VALUE",
40
+ * canarySettings: {
41
+ * percentTraffic: Number("double"),
42
+ * deploymentId: "STRING_VALUE",
43
+ * stageVariableOverrides: {
44
+ * "<keys>": "STRING_VALUE",
45
+ * },
46
+ * useStageCache: true || false,
47
+ * },
48
+ * tracingEnabled: true || false,
49
+ * tags: {
50
+ * "<keys>": "STRING_VALUE",
51
+ * },
52
+ * };
29
53
  * const command = new CreateStageCommand(input);
30
54
  * const response = await client.send(command);
31
55
  * ```
@@ -26,6 +26,34 @@ export interface CreateUsagePlanCommandOutput extends UsagePlan, __MetadataBeare
26
26
  * import { APIGatewayClient, CreateUsagePlanCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, CreateUsagePlanCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * name: "STRING_VALUE", // required
31
+ * description: "STRING_VALUE",
32
+ * apiStages: [
33
+ * {
34
+ * apiId: "STRING_VALUE",
35
+ * stage: "STRING_VALUE",
36
+ * throttle: {
37
+ * "<keys>": {
38
+ * burstLimit: Number("int"),
39
+ * rateLimit: Number("double"),
40
+ * },
41
+ * },
42
+ * },
43
+ * ],
44
+ * throttle: {
45
+ * burstLimit: Number("int"),
46
+ * rateLimit: Number("double"),
47
+ * },
48
+ * quota: {
49
+ * limit: Number("int"),
50
+ * offset: Number("int"),
51
+ * period: "DAY" || "WEEK" || "MONTH",
52
+ * },
53
+ * tags: {
54
+ * "<keys>": "STRING_VALUE",
55
+ * },
56
+ * };
29
57
  * const command = new CreateUsagePlanCommand(input);
30
58
  * const response = await client.send(command);
31
59
  * ```
@@ -26,6 +26,11 @@ export interface CreateUsagePlanKeyCommandOutput extends UsagePlanKey, __Metadat
26
26
  * import { APIGatewayClient, CreateUsagePlanKeyCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, CreateUsagePlanKeyCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * usagePlanId: "STRING_VALUE", // required
31
+ * keyId: "STRING_VALUE", // required
32
+ * keyType: "STRING_VALUE", // required
33
+ * };
29
34
  * const command = new CreateUsagePlanKeyCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,16 @@ export interface CreateVpcLinkCommandOutput extends VpcLink, __MetadataBearer {
26
26
  * import { APIGatewayClient, CreateVpcLinkCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, CreateVpcLinkCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * name: "STRING_VALUE", // required
31
+ * description: "STRING_VALUE",
32
+ * targetArns: [ // required
33
+ * "STRING_VALUE",
34
+ * ],
35
+ * tags: {
36
+ * "<keys>": "STRING_VALUE",
37
+ * },
38
+ * };
29
39
  * const command = new CreateVpcLinkCommand(input);
30
40
  * const response = await client.send(command);
31
41
  * ```
@@ -26,6 +26,9 @@ export interface DeleteApiKeyCommandOutput extends __MetadataBearer {
26
26
  * import { APIGatewayClient, DeleteApiKeyCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, DeleteApiKeyCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * apiKey: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new DeleteApiKeyCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,10 @@ export interface DeleteAuthorizerCommandOutput extends __MetadataBearer {
26
26
  * import { APIGatewayClient, DeleteAuthorizerCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, DeleteAuthorizerCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * restApiId: "STRING_VALUE", // required
31
+ * authorizerId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new DeleteAuthorizerCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,10 @@ export interface DeleteBasePathMappingCommandOutput extends __MetadataBearer {
26
26
  * import { APIGatewayClient, DeleteBasePathMappingCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, DeleteBasePathMappingCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * domainName: "STRING_VALUE", // required
31
+ * basePath: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new DeleteBasePathMappingCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,9 @@ export interface DeleteClientCertificateCommandOutput extends __MetadataBearer {
26
26
  * import { APIGatewayClient, DeleteClientCertificateCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, DeleteClientCertificateCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * clientCertificateId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new DeleteClientCertificateCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,10 @@ export interface DeleteDeploymentCommandOutput extends __MetadataBearer {
26
26
  * import { APIGatewayClient, DeleteDeploymentCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, DeleteDeploymentCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * restApiId: "STRING_VALUE", // required
31
+ * deploymentId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new DeleteDeploymentCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,10 @@ export interface DeleteDocumentationPartCommandOutput extends __MetadataBearer {
26
26
  * import { APIGatewayClient, DeleteDocumentationPartCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, DeleteDocumentationPartCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * restApiId: "STRING_VALUE", // required
31
+ * documentationPartId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new DeleteDocumentationPartCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,10 @@ export interface DeleteDocumentationVersionCommandOutput extends __MetadataBeare
26
26
  * import { APIGatewayClient, DeleteDocumentationVersionCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, DeleteDocumentationVersionCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * restApiId: "STRING_VALUE", // required
31
+ * documentationVersion: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new DeleteDocumentationVersionCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,9 @@ export interface DeleteDomainNameCommandOutput extends __MetadataBearer {
26
26
  * import { APIGatewayClient, DeleteDomainNameCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, DeleteDomainNameCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * domainName: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new DeleteDomainNameCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,10 @@ export interface DeleteGatewayResponseCommandOutput extends __MetadataBearer {
26
26
  * import { APIGatewayClient, DeleteGatewayResponseCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, DeleteGatewayResponseCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * restApiId: "STRING_VALUE", // required
31
+ * responseType: "DEFAULT_4XX" || "DEFAULT_5XX" || "RESOURCE_NOT_FOUND" || "UNAUTHORIZED" || "INVALID_API_KEY" || "ACCESS_DENIED" || "AUTHORIZER_FAILURE" || "AUTHORIZER_CONFIGURATION_ERROR" || "INVALID_SIGNATURE" || "EXPIRED_TOKEN" || "MISSING_AUTHENTICATION_TOKEN" || "INTEGRATION_FAILURE" || "INTEGRATION_TIMEOUT" || "API_CONFIGURATION_ERROR" || "UNSUPPORTED_MEDIA_TYPE" || "BAD_REQUEST_PARAMETERS" || "BAD_REQUEST_BODY" || "REQUEST_TOO_LARGE" || "THROTTLED" || "QUOTA_EXCEEDED" || "WAF_FILTERED", // required
32
+ * };
29
33
  * const command = new DeleteGatewayResponseCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,11 @@ export interface DeleteIntegrationCommandOutput extends __MetadataBearer {
26
26
  * import { APIGatewayClient, DeleteIntegrationCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, DeleteIntegrationCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * restApiId: "STRING_VALUE", // required
31
+ * resourceId: "STRING_VALUE", // required
32
+ * httpMethod: "STRING_VALUE", // required
33
+ * };
29
34
  * const command = new DeleteIntegrationCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,12 @@ export interface DeleteIntegrationResponseCommandOutput extends __MetadataBearer
26
26
  * import { APIGatewayClient, DeleteIntegrationResponseCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, DeleteIntegrationResponseCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * restApiId: "STRING_VALUE", // required
31
+ * resourceId: "STRING_VALUE", // required
32
+ * httpMethod: "STRING_VALUE", // required
33
+ * statusCode: "STRING_VALUE", // required
34
+ * };
29
35
  * const command = new DeleteIntegrationResponseCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -26,6 +26,11 @@ export interface DeleteMethodCommandOutput extends __MetadataBearer {
26
26
  * import { APIGatewayClient, DeleteMethodCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, DeleteMethodCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * restApiId: "STRING_VALUE", // required
31
+ * resourceId: "STRING_VALUE", // required
32
+ * httpMethod: "STRING_VALUE", // required
33
+ * };
29
34
  * const command = new DeleteMethodCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,12 @@ export interface DeleteMethodResponseCommandOutput extends __MetadataBearer {
26
26
  * import { APIGatewayClient, DeleteMethodResponseCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, DeleteMethodResponseCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * restApiId: "STRING_VALUE", // required
31
+ * resourceId: "STRING_VALUE", // required
32
+ * httpMethod: "STRING_VALUE", // required
33
+ * statusCode: "STRING_VALUE", // required
34
+ * };
29
35
  * const command = new DeleteMethodResponseCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -26,6 +26,10 @@ export interface DeleteModelCommandOutput extends __MetadataBearer {
26
26
  * import { APIGatewayClient, DeleteModelCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, DeleteModelCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * restApiId: "STRING_VALUE", // required
31
+ * modelName: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new DeleteModelCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,10 @@ export interface DeleteRequestValidatorCommandOutput extends __MetadataBearer {
26
26
  * import { APIGatewayClient, DeleteRequestValidatorCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, DeleteRequestValidatorCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * restApiId: "STRING_VALUE", // required
31
+ * requestValidatorId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new DeleteRequestValidatorCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,10 @@ export interface DeleteResourceCommandOutput extends __MetadataBearer {
26
26
  * import { APIGatewayClient, DeleteResourceCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, DeleteResourceCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * restApiId: "STRING_VALUE", // required
31
+ * resourceId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new DeleteResourceCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,9 @@ export interface DeleteRestApiCommandOutput extends __MetadataBearer {
26
26
  * import { APIGatewayClient, DeleteRestApiCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, DeleteRestApiCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * restApiId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new DeleteRestApiCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,10 @@ export interface DeleteStageCommandOutput extends __MetadataBearer {
26
26
  * import { APIGatewayClient, DeleteStageCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, DeleteStageCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * restApiId: "STRING_VALUE", // required
31
+ * stageName: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new DeleteStageCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,9 @@ export interface DeleteUsagePlanCommandOutput extends __MetadataBearer {
26
26
  * import { APIGatewayClient, DeleteUsagePlanCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, DeleteUsagePlanCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * usagePlanId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new DeleteUsagePlanCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,10 @@ export interface DeleteUsagePlanKeyCommandOutput extends __MetadataBearer {
26
26
  * import { APIGatewayClient, DeleteUsagePlanKeyCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, DeleteUsagePlanKeyCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * usagePlanId: "STRING_VALUE", // required
31
+ * keyId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new DeleteUsagePlanKeyCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,9 @@ export interface DeleteVpcLinkCommandOutput extends __MetadataBearer {
26
26
  * import { APIGatewayClient, DeleteVpcLinkCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, DeleteVpcLinkCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * vpcLinkId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new DeleteVpcLinkCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,10 @@ export interface FlushStageAuthorizersCacheCommandOutput extends __MetadataBeare
26
26
  * import { APIGatewayClient, FlushStageAuthorizersCacheCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, FlushStageAuthorizersCacheCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * restApiId: "STRING_VALUE", // required
31
+ * stageName: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new FlushStageAuthorizersCacheCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,10 @@ export interface FlushStageCacheCommandOutput extends __MetadataBearer {
26
26
  * import { APIGatewayClient, FlushStageCacheCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, FlushStageCacheCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * restApiId: "STRING_VALUE", // required
31
+ * stageName: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new FlushStageCacheCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,12 @@ export interface GenerateClientCertificateCommandOutput extends ClientCertificat
26
26
  * import { APIGatewayClient, GenerateClientCertificateCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GenerateClientCertificateCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {
30
+ * description: "STRING_VALUE",
31
+ * tags: {
32
+ * "<keys>": "STRING_VALUE",
33
+ * },
34
+ * };
29
35
  * const command = new GenerateClientCertificateCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -26,6 +26,7 @@ export interface GetAccountCommandOutput extends Account, __MetadataBearer {
26
26
  * import { APIGatewayClient, GetAccountCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetAccountCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = {};
29
30
  * const command = new GetAccountCommand(input);
30
31
  * const response = await client.send(command);
31
32
  * ```