@aws-sdk/client-api-gateway 3.299.0 → 3.301.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 +8 -8
@@ -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
  * ```
@@ -26,6 +26,10 @@ export interface GetApiKeyCommandOutput extends ApiKey, __MetadataBearer {
26
26
  * import { APIGatewayClient, GetApiKeyCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetApiKeyCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetApiKeyRequest
30
+ * apiKey: "STRING_VALUE", // required
31
+ * includeValue: true || false,
32
+ * };
29
33
  * const command = new GetApiKeyCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,13 @@ export interface GetApiKeysCommandOutput extends ApiKeys, __MetadataBearer {
26
26
  * import { APIGatewayClient, GetApiKeysCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetApiKeysCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetApiKeysRequest
30
+ * position: "STRING_VALUE",
31
+ * limit: Number("int"),
32
+ * nameQuery: "STRING_VALUE",
33
+ * customerId: "STRING_VALUE",
34
+ * includeValues: true || false,
35
+ * };
29
36
  * const command = new GetApiKeysCommand(input);
30
37
  * const response = await client.send(command);
31
38
  * ```
@@ -26,6 +26,10 @@ export interface GetAuthorizerCommandOutput extends Authorizer, __MetadataBearer
26
26
  * import { APIGatewayClient, GetAuthorizerCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetAuthorizerCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetAuthorizerRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * authorizerId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new GetAuthorizerCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,11 @@ export interface GetAuthorizersCommandOutput extends Authorizers, __MetadataBear
26
26
  * import { APIGatewayClient, GetAuthorizersCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetAuthorizersCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetAuthorizersRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * position: "STRING_VALUE",
32
+ * limit: Number("int"),
33
+ * };
29
34
  * const command = new GetAuthorizersCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,10 @@ export interface GetBasePathMappingCommandOutput extends BasePathMapping, __Meta
26
26
  * import { APIGatewayClient, GetBasePathMappingCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetBasePathMappingCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetBasePathMappingRequest
30
+ * domainName: "STRING_VALUE", // required
31
+ * basePath: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new GetBasePathMappingCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,11 @@ export interface GetBasePathMappingsCommandOutput extends BasePathMappings, __Me
26
26
  * import { APIGatewayClient, GetBasePathMappingsCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetBasePathMappingsCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetBasePathMappingsRequest
30
+ * domainName: "STRING_VALUE", // required
31
+ * position: "STRING_VALUE",
32
+ * limit: Number("int"),
33
+ * };
29
34
  * const command = new GetBasePathMappingsCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,9 @@ export interface GetClientCertificateCommandOutput extends ClientCertificate, __
26
26
  * import { APIGatewayClient, GetClientCertificateCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetClientCertificateCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetClientCertificateRequest
30
+ * clientCertificateId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new GetClientCertificateCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,10 @@ export interface GetClientCertificatesCommandOutput extends ClientCertificates,
26
26
  * import { APIGatewayClient, GetClientCertificatesCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetClientCertificatesCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetClientCertificatesRequest
30
+ * position: "STRING_VALUE",
31
+ * limit: Number("int"),
32
+ * };
29
33
  * const command = new GetClientCertificatesCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,13 @@ export interface GetDeploymentCommandOutput extends Deployment, __MetadataBearer
26
26
  * import { APIGatewayClient, GetDeploymentCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetDeploymentCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetDeploymentRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * deploymentId: "STRING_VALUE", // required
32
+ * embed: [ // ListOfString
33
+ * "STRING_VALUE",
34
+ * ],
35
+ * };
29
36
  * const command = new GetDeploymentCommand(input);
30
37
  * const response = await client.send(command);
31
38
  * ```
@@ -26,6 +26,11 @@ export interface GetDeploymentsCommandOutput extends Deployments, __MetadataBear
26
26
  * import { APIGatewayClient, GetDeploymentsCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetDeploymentsCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetDeploymentsRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * position: "STRING_VALUE",
32
+ * limit: Number("int"),
33
+ * };
29
34
  * const command = new GetDeploymentsCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,10 @@ export interface GetDocumentationPartCommandOutput extends DocumentationPart, __
26
26
  * import { APIGatewayClient, GetDocumentationPartCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetDocumentationPartCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetDocumentationPartRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * documentationPartId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new GetDocumentationPartCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,15 @@ export interface GetDocumentationPartsCommandOutput extends DocumentationParts,
26
26
  * import { APIGatewayClient, GetDocumentationPartsCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetDocumentationPartsCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetDocumentationPartsRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * type: "API" || "AUTHORIZER" || "MODEL" || "RESOURCE" || "METHOD" || "PATH_PARAMETER" || "QUERY_PARAMETER" || "REQUEST_HEADER" || "REQUEST_BODY" || "RESPONSE" || "RESPONSE_HEADER" || "RESPONSE_BODY",
32
+ * nameQuery: "STRING_VALUE",
33
+ * path: "STRING_VALUE",
34
+ * position: "STRING_VALUE",
35
+ * limit: Number("int"),
36
+ * locationStatus: "DOCUMENTED" || "UNDOCUMENTED",
37
+ * };
29
38
  * const command = new GetDocumentationPartsCommand(input);
30
39
  * const response = await client.send(command);
31
40
  * ```
@@ -26,6 +26,10 @@ export interface GetDocumentationVersionCommandOutput extends DocumentationVersi
26
26
  * import { APIGatewayClient, GetDocumentationVersionCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetDocumentationVersionCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetDocumentationVersionRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * documentationVersion: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new GetDocumentationVersionCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,11 @@ export interface GetDocumentationVersionsCommandOutput extends DocumentationVers
26
26
  * import { APIGatewayClient, GetDocumentationVersionsCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetDocumentationVersionsCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetDocumentationVersionsRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * position: "STRING_VALUE",
32
+ * limit: Number("int"),
33
+ * };
29
34
  * const command = new GetDocumentationVersionsCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,9 @@ export interface GetDomainNameCommandOutput extends DomainName, __MetadataBearer
26
26
  * import { APIGatewayClient, GetDomainNameCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetDomainNameCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetDomainNameRequest
30
+ * domainName: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new GetDomainNameCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,10 @@ export interface GetDomainNamesCommandOutput extends DomainNames, __MetadataBear
26
26
  * import { APIGatewayClient, GetDomainNamesCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetDomainNamesCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetDomainNamesRequest
30
+ * position: "STRING_VALUE",
31
+ * limit: Number("int"),
32
+ * };
29
33
  * const command = new GetDomainNamesCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,15 @@ export interface GetExportCommandOutput extends ExportResponse, __MetadataBearer
26
26
  * import { APIGatewayClient, GetExportCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetExportCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetExportRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * stageName: "STRING_VALUE", // required
32
+ * exportType: "STRING_VALUE", // required
33
+ * parameters: { // MapOfStringToString
34
+ * "<keys>": "STRING_VALUE",
35
+ * },
36
+ * accepts: "STRING_VALUE",
37
+ * };
29
38
  * const command = new GetExportCommand(input);
30
39
  * const response = await client.send(command);
31
40
  * ```
@@ -26,6 +26,10 @@ export interface GetGatewayResponseCommandOutput extends GatewayResponse, __Meta
26
26
  * import { APIGatewayClient, GetGatewayResponseCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetGatewayResponseCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetGatewayResponseRequest
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 GetGatewayResponseCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,11 @@ export interface GetGatewayResponsesCommandOutput extends GatewayResponses, __Me
26
26
  * import { APIGatewayClient, GetGatewayResponsesCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetGatewayResponsesCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetGatewayResponsesRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * position: "STRING_VALUE",
32
+ * limit: Number("int"),
33
+ * };
29
34
  * const command = new GetGatewayResponsesCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,11 @@ export interface GetIntegrationCommandOutput extends Integration, __MetadataBear
26
26
  * import { APIGatewayClient, GetIntegrationCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetIntegrationCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetIntegrationRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * resourceId: "STRING_VALUE", // required
32
+ * httpMethod: "STRING_VALUE", // required
33
+ * };
29
34
  * const command = new GetIntegrationCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,12 @@ export interface GetIntegrationResponseCommandOutput extends IntegrationResponse
26
26
  * import { APIGatewayClient, GetIntegrationResponseCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetIntegrationResponseCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetIntegrationResponseRequest
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 GetIntegrationResponseCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -26,6 +26,11 @@ export interface GetMethodCommandOutput extends Method, __MetadataBearer {
26
26
  * import { APIGatewayClient, GetMethodCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetMethodCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetMethodRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * resourceId: "STRING_VALUE", // required
32
+ * httpMethod: "STRING_VALUE", // required
33
+ * };
29
34
  * const command = new GetMethodCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,12 @@ export interface GetMethodResponseCommandOutput extends MethodResponse, __Metada
26
26
  * import { APIGatewayClient, GetMethodResponseCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetMethodResponseCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetMethodResponseRequest
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 GetMethodResponseCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -26,6 +26,11 @@ export interface GetModelCommandOutput extends Model, __MetadataBearer {
26
26
  * import { APIGatewayClient, GetModelCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetModelCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetModelRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * modelName: "STRING_VALUE", // required
32
+ * flatten: true || false,
33
+ * };
29
34
  * const command = new GetModelCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,10 @@ export interface GetModelTemplateCommandOutput extends Template, __MetadataBeare
26
26
  * import { APIGatewayClient, GetModelTemplateCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetModelTemplateCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetModelTemplateRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * modelName: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new GetModelTemplateCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,11 @@ export interface GetModelsCommandOutput extends Models, __MetadataBearer {
26
26
  * import { APIGatewayClient, GetModelsCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetModelsCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetModelsRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * position: "STRING_VALUE",
32
+ * limit: Number("int"),
33
+ * };
29
34
  * const command = new GetModelsCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,10 @@ export interface GetRequestValidatorCommandOutput extends RequestValidator, __Me
26
26
  * import { APIGatewayClient, GetRequestValidatorCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetRequestValidatorCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetRequestValidatorRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * requestValidatorId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new GetRequestValidatorCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,11 @@ export interface GetRequestValidatorsCommandOutput extends RequestValidators, __
26
26
  * import { APIGatewayClient, GetRequestValidatorsCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetRequestValidatorsCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetRequestValidatorsRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * position: "STRING_VALUE",
32
+ * limit: Number("int"),
33
+ * };
29
34
  * const command = new GetRequestValidatorsCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,13 @@ export interface GetResourceCommandOutput extends Resource, __MetadataBearer {
26
26
  * import { APIGatewayClient, GetResourceCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetResourceCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetResourceRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * resourceId: "STRING_VALUE", // required
32
+ * embed: [ // ListOfString
33
+ * "STRING_VALUE",
34
+ * ],
35
+ * };
29
36
  * const command = new GetResourceCommand(input);
30
37
  * const response = await client.send(command);
31
38
  * ```
@@ -26,6 +26,14 @@ export interface GetResourcesCommandOutput extends Resources, __MetadataBearer {
26
26
  * import { APIGatewayClient, GetResourcesCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetResourcesCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetResourcesRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * position: "STRING_VALUE",
32
+ * limit: Number("int"),
33
+ * embed: [ // ListOfString
34
+ * "STRING_VALUE",
35
+ * ],
36
+ * };
29
37
  * const command = new GetResourcesCommand(input);
30
38
  * const response = await client.send(command);
31
39
  * ```
@@ -26,6 +26,9 @@ export interface GetRestApiCommandOutput extends RestApi, __MetadataBearer {
26
26
  * import { APIGatewayClient, GetRestApiCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetRestApiCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetRestApiRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new GetRestApiCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,10 @@ export interface GetRestApisCommandOutput extends RestApis, __MetadataBearer {
26
26
  * import { APIGatewayClient, GetRestApisCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetRestApisCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetRestApisRequest
30
+ * position: "STRING_VALUE",
31
+ * limit: Number("int"),
32
+ * };
29
33
  * const command = new GetRestApisCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,14 @@ export interface GetSdkCommandOutput extends SdkResponse, __MetadataBearer {
26
26
  * import { APIGatewayClient, GetSdkCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetSdkCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetSdkRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * stageName: "STRING_VALUE", // required
32
+ * sdkType: "STRING_VALUE", // required
33
+ * parameters: { // MapOfStringToString
34
+ * "<keys>": "STRING_VALUE",
35
+ * },
36
+ * };
29
37
  * const command = new GetSdkCommand(input);
30
38
  * const response = await client.send(command);
31
39
  * ```
@@ -26,6 +26,9 @@ export interface GetSdkTypeCommandOutput extends SdkType, __MetadataBearer {
26
26
  * import { APIGatewayClient, GetSdkTypeCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetSdkTypeCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetSdkTypeRequest
30
+ * id: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new GetSdkTypeCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,10 @@ export interface GetSdkTypesCommandOutput extends SdkTypes, __MetadataBearer {
26
26
  * import { APIGatewayClient, GetSdkTypesCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetSdkTypesCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetSdkTypesRequest
30
+ * position: "STRING_VALUE",
31
+ * limit: Number("int"),
32
+ * };
29
33
  * const command = new GetSdkTypesCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,10 @@ export interface GetStageCommandOutput extends Stage, __MetadataBearer {
26
26
  * import { APIGatewayClient, GetStageCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetStageCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetStageRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * stageName: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new GetStageCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,10 @@ export interface GetStagesCommandOutput extends Stages, __MetadataBearer {
26
26
  * import { APIGatewayClient, GetStagesCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetStagesCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetStagesRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * deploymentId: "STRING_VALUE",
32
+ * };
29
33
  * const command = new GetStagesCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,11 @@ export interface GetTagsCommandOutput extends Tags, __MetadataBearer {
26
26
  * import { APIGatewayClient, GetTagsCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetTagsCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetTagsRequest
30
+ * resourceArn: "STRING_VALUE", // required
31
+ * position: "STRING_VALUE",
32
+ * limit: Number("int"),
33
+ * };
29
34
  * const command = new GetTagsCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,14 @@ export interface GetUsageCommandOutput extends Usage, __MetadataBearer {
26
26
  * import { APIGatewayClient, GetUsageCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetUsageCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetUsageRequest
30
+ * usagePlanId: "STRING_VALUE", // required
31
+ * keyId: "STRING_VALUE",
32
+ * startDate: "STRING_VALUE", // required
33
+ * endDate: "STRING_VALUE", // required
34
+ * position: "STRING_VALUE",
35
+ * limit: Number("int"),
36
+ * };
29
37
  * const command = new GetUsageCommand(input);
30
38
  * const response = await client.send(command);
31
39
  * ```
@@ -26,6 +26,9 @@ export interface GetUsagePlanCommandOutput extends UsagePlan, __MetadataBearer {
26
26
  * import { APIGatewayClient, GetUsagePlanCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetUsagePlanCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetUsagePlanRequest
30
+ * usagePlanId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new GetUsagePlanCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,10 @@ export interface GetUsagePlanKeyCommandOutput extends UsagePlanKey, __MetadataBe
26
26
  * import { APIGatewayClient, GetUsagePlanKeyCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetUsagePlanKeyCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetUsagePlanKeyRequest
30
+ * usagePlanId: "STRING_VALUE", // required
31
+ * keyId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new GetUsagePlanKeyCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,12 @@ export interface GetUsagePlanKeysCommandOutput extends UsagePlanKeys, __Metadata
26
26
  * import { APIGatewayClient, GetUsagePlanKeysCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetUsagePlanKeysCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetUsagePlanKeysRequest
30
+ * usagePlanId: "STRING_VALUE", // required
31
+ * position: "STRING_VALUE",
32
+ * limit: Number("int"),
33
+ * nameQuery: "STRING_VALUE",
34
+ * };
29
35
  * const command = new GetUsagePlanKeysCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -26,6 +26,11 @@ export interface GetUsagePlansCommandOutput extends UsagePlans, __MetadataBearer
26
26
  * import { APIGatewayClient, GetUsagePlansCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetUsagePlansCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetUsagePlansRequest
30
+ * position: "STRING_VALUE",
31
+ * keyId: "STRING_VALUE",
32
+ * limit: Number("int"),
33
+ * };
29
34
  * const command = new GetUsagePlansCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,9 @@ export interface GetVpcLinkCommandOutput extends VpcLink, __MetadataBearer {
26
26
  * import { APIGatewayClient, GetVpcLinkCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetVpcLinkCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetVpcLinkRequest
30
+ * vpcLinkId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new GetVpcLinkCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,10 @@ export interface GetVpcLinksCommandOutput extends VpcLinks, __MetadataBearer {
26
26
  * import { APIGatewayClient, GetVpcLinksCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, GetVpcLinksCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // GetVpcLinksRequest
30
+ * position: "STRING_VALUE",
31
+ * limit: Number("int"),
32
+ * };
29
33
  * const command = new GetVpcLinksCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,11 @@ export interface ImportApiKeysCommandOutput extends ApiKeyIds, __MetadataBearer
26
26
  * import { APIGatewayClient, ImportApiKeysCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, ImportApiKeysCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // ImportApiKeysRequest
30
+ * body: "BLOB_VALUE", // required
31
+ * format: "csv", // required
32
+ * failOnWarnings: true || false,
33
+ * };
29
34
  * const command = new ImportApiKeysCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```