@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,12 @@ export interface ImportDocumentationPartsCommandOutput extends DocumentationPart
26
26
  * import { APIGatewayClient, ImportDocumentationPartsCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, ImportDocumentationPartsCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // ImportDocumentationPartsRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * mode: "merge" || "overwrite",
32
+ * failOnWarnings: true || false,
33
+ * body: "BLOB_VALUE", // required
34
+ * };
29
35
  * const command = new ImportDocumentationPartsCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -26,6 +26,13 @@ export interface ImportRestApiCommandOutput extends RestApi, __MetadataBearer {
26
26
  * import { APIGatewayClient, ImportRestApiCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, ImportRestApiCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // ImportRestApiRequest
30
+ * failOnWarnings: true || false,
31
+ * parameters: { // MapOfStringToString
32
+ * "<keys>": "STRING_VALUE",
33
+ * },
34
+ * body: "BLOB_VALUE", // required
35
+ * };
29
36
  * const command = new ImportRestApiCommand(input);
30
37
  * const response = await client.send(command);
31
38
  * ```
@@ -26,6 +26,17 @@ export interface PutGatewayResponseCommandOutput extends GatewayResponse, __Meta
26
26
  * import { APIGatewayClient, PutGatewayResponseCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, PutGatewayResponseCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // PutGatewayResponseRequest
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
+ * statusCode: "STRING_VALUE",
33
+ * responseParameters: { // MapOfStringToString
34
+ * "<keys>": "STRING_VALUE",
35
+ * },
36
+ * responseTemplates: {
37
+ * "<keys>": "STRING_VALUE",
38
+ * },
39
+ * };
29
40
  * const command = new PutGatewayResponseCommand(input);
30
41
  * const response = await client.send(command);
31
42
  * ```
@@ -26,6 +26,33 @@ export interface PutIntegrationCommandOutput extends Integration, __MetadataBear
26
26
  * import { APIGatewayClient, PutIntegrationCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, PutIntegrationCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // PutIntegrationRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * resourceId: "STRING_VALUE", // required
32
+ * httpMethod: "STRING_VALUE", // required
33
+ * type: "HTTP" || "AWS" || "MOCK" || "HTTP_PROXY" || "AWS_PROXY", // required
34
+ * integrationHttpMethod: "STRING_VALUE",
35
+ * uri: "STRING_VALUE",
36
+ * connectionType: "INTERNET" || "VPC_LINK",
37
+ * connectionId: "STRING_VALUE",
38
+ * credentials: "STRING_VALUE",
39
+ * requestParameters: { // MapOfStringToString
40
+ * "<keys>": "STRING_VALUE",
41
+ * },
42
+ * requestTemplates: {
43
+ * "<keys>": "STRING_VALUE",
44
+ * },
45
+ * passthroughBehavior: "STRING_VALUE",
46
+ * cacheNamespace: "STRING_VALUE",
47
+ * cacheKeyParameters: [ // ListOfString
48
+ * "STRING_VALUE",
49
+ * ],
50
+ * contentHandling: "CONVERT_TO_BINARY" || "CONVERT_TO_TEXT",
51
+ * timeoutInMillis: Number("int"),
52
+ * tlsConfig: { // TlsConfig
53
+ * insecureSkipVerification: true || false,
54
+ * },
55
+ * };
29
56
  * const command = new PutIntegrationCommand(input);
30
57
  * const response = await client.send(command);
31
58
  * ```
@@ -26,6 +26,20 @@ export interface PutIntegrationResponseCommandOutput extends IntegrationResponse
26
26
  * import { APIGatewayClient, PutIntegrationResponseCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, PutIntegrationResponseCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // PutIntegrationResponseRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * resourceId: "STRING_VALUE", // required
32
+ * httpMethod: "STRING_VALUE", // required
33
+ * statusCode: "STRING_VALUE", // required
34
+ * selectionPattern: "STRING_VALUE",
35
+ * responseParameters: { // MapOfStringToString
36
+ * "<keys>": "STRING_VALUE",
37
+ * },
38
+ * responseTemplates: {
39
+ * "<keys>": "STRING_VALUE",
40
+ * },
41
+ * contentHandling: "CONVERT_TO_BINARY" || "CONVERT_TO_TEXT",
42
+ * };
29
43
  * const command = new PutIntegrationResponseCommand(input);
30
44
  * const response = await client.send(command);
31
45
  * ```
@@ -26,6 +26,25 @@ export interface PutMethodCommandOutput extends Method, __MetadataBearer {
26
26
  * import { APIGatewayClient, PutMethodCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, PutMethodCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // PutMethodRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * resourceId: "STRING_VALUE", // required
32
+ * httpMethod: "STRING_VALUE", // required
33
+ * authorizationType: "STRING_VALUE", // required
34
+ * authorizerId: "STRING_VALUE",
35
+ * apiKeyRequired: true || false,
36
+ * operationName: "STRING_VALUE",
37
+ * requestParameters: { // MapOfStringToBoolean
38
+ * "<keys>": true || false,
39
+ * },
40
+ * requestModels: { // MapOfStringToString
41
+ * "<keys>": "STRING_VALUE",
42
+ * },
43
+ * requestValidatorId: "STRING_VALUE",
44
+ * authorizationScopes: [ // ListOfString
45
+ * "STRING_VALUE",
46
+ * ],
47
+ * };
29
48
  * const command = new PutMethodCommand(input);
30
49
  * const response = await client.send(command);
31
50
  * ```
@@ -26,6 +26,18 @@ export interface PutMethodResponseCommandOutput extends MethodResponse, __Metada
26
26
  * import { APIGatewayClient, PutMethodResponseCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, PutMethodResponseCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // PutMethodResponseRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * resourceId: "STRING_VALUE", // required
32
+ * httpMethod: "STRING_VALUE", // required
33
+ * statusCode: "STRING_VALUE", // required
34
+ * responseParameters: { // MapOfStringToBoolean
35
+ * "<keys>": true || false,
36
+ * },
37
+ * responseModels: { // MapOfStringToString
38
+ * "<keys>": "STRING_VALUE",
39
+ * },
40
+ * };
29
41
  * const command = new PutMethodResponseCommand(input);
30
42
  * const response = await client.send(command);
31
43
  * ```
@@ -27,6 +27,15 @@ export interface PutRestApiCommandOutput extends RestApi, __MetadataBearer {
27
27
  * import { APIGatewayClient, PutRestApiCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
28
28
  * // const { APIGatewayClient, PutRestApiCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
29
29
  * const client = new APIGatewayClient(config);
30
+ * const input = { // PutRestApiRequest
31
+ * restApiId: "STRING_VALUE", // required
32
+ * mode: "merge" || "overwrite",
33
+ * failOnWarnings: true || false,
34
+ * parameters: { // MapOfStringToString
35
+ * "<keys>": "STRING_VALUE",
36
+ * },
37
+ * body: "BLOB_VALUE", // required
38
+ * };
30
39
  * const command = new PutRestApiCommand(input);
31
40
  * const response = await client.send(command);
32
41
  * ```
@@ -26,6 +26,12 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
26
26
  * import { APIGatewayClient, TagResourceCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, TagResourceCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // TagResourceRequest
30
+ * resourceArn: "STRING_VALUE", // required
31
+ * tags: { // MapOfStringToString // required
32
+ * "<keys>": "STRING_VALUE",
33
+ * },
34
+ * };
29
35
  * const command = new TagResourceCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -26,6 +26,26 @@ export interface TestInvokeAuthorizerCommandOutput extends TestInvokeAuthorizerR
26
26
  * import { APIGatewayClient, TestInvokeAuthorizerCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, TestInvokeAuthorizerCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // TestInvokeAuthorizerRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * authorizerId: "STRING_VALUE", // required
32
+ * headers: { // MapOfStringToString
33
+ * "<keys>": "STRING_VALUE",
34
+ * },
35
+ * multiValueHeaders: { // MapOfStringToList
36
+ * "<keys>": [ // ListOfString
37
+ * "STRING_VALUE",
38
+ * ],
39
+ * },
40
+ * pathWithQueryString: "STRING_VALUE",
41
+ * body: "STRING_VALUE",
42
+ * stageVariables: {
43
+ * "<keys>": "STRING_VALUE",
44
+ * },
45
+ * additionalContext: {
46
+ * "<keys>": "STRING_VALUE",
47
+ * },
48
+ * };
29
49
  * const command = new TestInvokeAuthorizerCommand(input);
30
50
  * const response = await client.send(command);
31
51
  * ```
@@ -26,6 +26,25 @@ export interface TestInvokeMethodCommandOutput extends TestInvokeMethodResponse,
26
26
  * import { APIGatewayClient, TestInvokeMethodCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, TestInvokeMethodCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // TestInvokeMethodRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * resourceId: "STRING_VALUE", // required
32
+ * httpMethod: "STRING_VALUE", // required
33
+ * pathWithQueryString: "STRING_VALUE",
34
+ * body: "STRING_VALUE",
35
+ * headers: { // MapOfStringToString
36
+ * "<keys>": "STRING_VALUE",
37
+ * },
38
+ * multiValueHeaders: { // MapOfStringToList
39
+ * "<keys>": [ // ListOfString
40
+ * "STRING_VALUE",
41
+ * ],
42
+ * },
43
+ * clientCertificateId: "STRING_VALUE",
44
+ * stageVariables: {
45
+ * "<keys>": "STRING_VALUE",
46
+ * },
47
+ * };
29
48
  * const command = new TestInvokeMethodCommand(input);
30
49
  * const response = await client.send(command);
31
50
  * ```
@@ -26,6 +26,12 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
26
26
  * import { APIGatewayClient, UntagResourceCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, UntagResourceCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // UntagResourceRequest
30
+ * resourceArn: "STRING_VALUE", // required
31
+ * tagKeys: [ // ListOfString // required
32
+ * "STRING_VALUE",
33
+ * ],
34
+ * };
29
35
  * const command = new UntagResourceCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -26,6 +26,16 @@ export interface UpdateAccountCommandOutput extends Account, __MetadataBearer {
26
26
  * import { APIGatewayClient, UpdateAccountCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, UpdateAccountCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // UpdateAccountRequest
30
+ * patchOperations: [ // ListOfPatchOperation
31
+ * { // PatchOperation
32
+ * op: "add" || "remove" || "replace" || "move" || "copy" || "test",
33
+ * path: "STRING_VALUE",
34
+ * value: "STRING_VALUE",
35
+ * from: "STRING_VALUE",
36
+ * },
37
+ * ],
38
+ * };
29
39
  * const command = new UpdateAccountCommand(input);
30
40
  * const response = await client.send(command);
31
41
  * ```
@@ -26,6 +26,17 @@ export interface UpdateApiKeyCommandOutput extends ApiKey, __MetadataBearer {
26
26
  * import { APIGatewayClient, UpdateApiKeyCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, UpdateApiKeyCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // UpdateApiKeyRequest
30
+ * apiKey: "STRING_VALUE", // required
31
+ * patchOperations: [ // ListOfPatchOperation
32
+ * { // PatchOperation
33
+ * op: "add" || "remove" || "replace" || "move" || "copy" || "test",
34
+ * path: "STRING_VALUE",
35
+ * value: "STRING_VALUE",
36
+ * from: "STRING_VALUE",
37
+ * },
38
+ * ],
39
+ * };
29
40
  * const command = new UpdateApiKeyCommand(input);
30
41
  * const response = await client.send(command);
31
42
  * ```
@@ -26,6 +26,18 @@ export interface UpdateAuthorizerCommandOutput extends Authorizer, __MetadataBea
26
26
  * import { APIGatewayClient, UpdateAuthorizerCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, UpdateAuthorizerCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // UpdateAuthorizerRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * authorizerId: "STRING_VALUE", // required
32
+ * patchOperations: [ // ListOfPatchOperation
33
+ * { // PatchOperation
34
+ * op: "add" || "remove" || "replace" || "move" || "copy" || "test",
35
+ * path: "STRING_VALUE",
36
+ * value: "STRING_VALUE",
37
+ * from: "STRING_VALUE",
38
+ * },
39
+ * ],
40
+ * };
29
41
  * const command = new UpdateAuthorizerCommand(input);
30
42
  * const response = await client.send(command);
31
43
  * ```
@@ -26,6 +26,18 @@ export interface UpdateBasePathMappingCommandOutput extends BasePathMapping, __M
26
26
  * import { APIGatewayClient, UpdateBasePathMappingCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, UpdateBasePathMappingCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // UpdateBasePathMappingRequest
30
+ * domainName: "STRING_VALUE", // required
31
+ * basePath: "STRING_VALUE", // required
32
+ * patchOperations: [ // ListOfPatchOperation
33
+ * { // PatchOperation
34
+ * op: "add" || "remove" || "replace" || "move" || "copy" || "test",
35
+ * path: "STRING_VALUE",
36
+ * value: "STRING_VALUE",
37
+ * from: "STRING_VALUE",
38
+ * },
39
+ * ],
40
+ * };
29
41
  * const command = new UpdateBasePathMappingCommand(input);
30
42
  * const response = await client.send(command);
31
43
  * ```
@@ -26,6 +26,17 @@ export interface UpdateClientCertificateCommandOutput extends ClientCertificate,
26
26
  * import { APIGatewayClient, UpdateClientCertificateCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, UpdateClientCertificateCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // UpdateClientCertificateRequest
30
+ * clientCertificateId: "STRING_VALUE", // required
31
+ * patchOperations: [ // ListOfPatchOperation
32
+ * { // PatchOperation
33
+ * op: "add" || "remove" || "replace" || "move" || "copy" || "test",
34
+ * path: "STRING_VALUE",
35
+ * value: "STRING_VALUE",
36
+ * from: "STRING_VALUE",
37
+ * },
38
+ * ],
39
+ * };
29
40
  * const command = new UpdateClientCertificateCommand(input);
30
41
  * const response = await client.send(command);
31
42
  * ```
@@ -26,6 +26,18 @@ export interface UpdateDeploymentCommandOutput extends Deployment, __MetadataBea
26
26
  * import { APIGatewayClient, UpdateDeploymentCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, UpdateDeploymentCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // UpdateDeploymentRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * deploymentId: "STRING_VALUE", // required
32
+ * patchOperations: [ // ListOfPatchOperation
33
+ * { // PatchOperation
34
+ * op: "add" || "remove" || "replace" || "move" || "copy" || "test",
35
+ * path: "STRING_VALUE",
36
+ * value: "STRING_VALUE",
37
+ * from: "STRING_VALUE",
38
+ * },
39
+ * ],
40
+ * };
29
41
  * const command = new UpdateDeploymentCommand(input);
30
42
  * const response = await client.send(command);
31
43
  * ```
@@ -26,6 +26,18 @@ export interface UpdateDocumentationPartCommandOutput extends DocumentationPart,
26
26
  * import { APIGatewayClient, UpdateDocumentationPartCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, UpdateDocumentationPartCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // UpdateDocumentationPartRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * documentationPartId: "STRING_VALUE", // required
32
+ * patchOperations: [ // ListOfPatchOperation
33
+ * { // PatchOperation
34
+ * op: "add" || "remove" || "replace" || "move" || "copy" || "test",
35
+ * path: "STRING_VALUE",
36
+ * value: "STRING_VALUE",
37
+ * from: "STRING_VALUE",
38
+ * },
39
+ * ],
40
+ * };
29
41
  * const command = new UpdateDocumentationPartCommand(input);
30
42
  * const response = await client.send(command);
31
43
  * ```
@@ -26,6 +26,18 @@ export interface UpdateDocumentationVersionCommandOutput extends DocumentationVe
26
26
  * import { APIGatewayClient, UpdateDocumentationVersionCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, UpdateDocumentationVersionCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // UpdateDocumentationVersionRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * documentationVersion: "STRING_VALUE", // required
32
+ * patchOperations: [ // ListOfPatchOperation
33
+ * { // PatchOperation
34
+ * op: "add" || "remove" || "replace" || "move" || "copy" || "test",
35
+ * path: "STRING_VALUE",
36
+ * value: "STRING_VALUE",
37
+ * from: "STRING_VALUE",
38
+ * },
39
+ * ],
40
+ * };
29
41
  * const command = new UpdateDocumentationVersionCommand(input);
30
42
  * const response = await client.send(command);
31
43
  * ```
@@ -26,6 +26,17 @@ export interface UpdateDomainNameCommandOutput extends DomainName, __MetadataBea
26
26
  * import { APIGatewayClient, UpdateDomainNameCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, UpdateDomainNameCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // UpdateDomainNameRequest
30
+ * domainName: "STRING_VALUE", // required
31
+ * patchOperations: [ // ListOfPatchOperation
32
+ * { // PatchOperation
33
+ * op: "add" || "remove" || "replace" || "move" || "copy" || "test",
34
+ * path: "STRING_VALUE",
35
+ * value: "STRING_VALUE",
36
+ * from: "STRING_VALUE",
37
+ * },
38
+ * ],
39
+ * };
29
40
  * const command = new UpdateDomainNameCommand(input);
30
41
  * const response = await client.send(command);
31
42
  * ```
@@ -26,6 +26,18 @@ export interface UpdateGatewayResponseCommandOutput extends GatewayResponse, __M
26
26
  * import { APIGatewayClient, UpdateGatewayResponseCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, UpdateGatewayResponseCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // UpdateGatewayResponseRequest
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
+ * patchOperations: [ // ListOfPatchOperation
33
+ * { // PatchOperation
34
+ * op: "add" || "remove" || "replace" || "move" || "copy" || "test",
35
+ * path: "STRING_VALUE",
36
+ * value: "STRING_VALUE",
37
+ * from: "STRING_VALUE",
38
+ * },
39
+ * ],
40
+ * };
29
41
  * const command = new UpdateGatewayResponseCommand(input);
30
42
  * const response = await client.send(command);
31
43
  * ```
@@ -26,6 +26,19 @@ export interface UpdateIntegrationCommandOutput extends Integration, __MetadataB
26
26
  * import { APIGatewayClient, UpdateIntegrationCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, UpdateIntegrationCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // UpdateIntegrationRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * resourceId: "STRING_VALUE", // required
32
+ * httpMethod: "STRING_VALUE", // required
33
+ * patchOperations: [ // ListOfPatchOperation
34
+ * { // PatchOperation
35
+ * op: "add" || "remove" || "replace" || "move" || "copy" || "test",
36
+ * path: "STRING_VALUE",
37
+ * value: "STRING_VALUE",
38
+ * from: "STRING_VALUE",
39
+ * },
40
+ * ],
41
+ * };
29
42
  * const command = new UpdateIntegrationCommand(input);
30
43
  * const response = await client.send(command);
31
44
  * ```
@@ -26,6 +26,20 @@ export interface UpdateIntegrationResponseCommandOutput extends IntegrationRespo
26
26
  * import { APIGatewayClient, UpdateIntegrationResponseCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, UpdateIntegrationResponseCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // UpdateIntegrationResponseRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * resourceId: "STRING_VALUE", // required
32
+ * httpMethod: "STRING_VALUE", // required
33
+ * statusCode: "STRING_VALUE", // required
34
+ * patchOperations: [ // ListOfPatchOperation
35
+ * { // PatchOperation
36
+ * op: "add" || "remove" || "replace" || "move" || "copy" || "test",
37
+ * path: "STRING_VALUE",
38
+ * value: "STRING_VALUE",
39
+ * from: "STRING_VALUE",
40
+ * },
41
+ * ],
42
+ * };
29
43
  * const command = new UpdateIntegrationResponseCommand(input);
30
44
  * const response = await client.send(command);
31
45
  * ```
@@ -26,6 +26,19 @@ export interface UpdateMethodCommandOutput extends Method, __MetadataBearer {
26
26
  * import { APIGatewayClient, UpdateMethodCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, UpdateMethodCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // UpdateMethodRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * resourceId: "STRING_VALUE", // required
32
+ * httpMethod: "STRING_VALUE", // required
33
+ * patchOperations: [ // ListOfPatchOperation
34
+ * { // PatchOperation
35
+ * op: "add" || "remove" || "replace" || "move" || "copy" || "test",
36
+ * path: "STRING_VALUE",
37
+ * value: "STRING_VALUE",
38
+ * from: "STRING_VALUE",
39
+ * },
40
+ * ],
41
+ * };
29
42
  * const command = new UpdateMethodCommand(input);
30
43
  * const response = await client.send(command);
31
44
  * ```
@@ -26,6 +26,20 @@ export interface UpdateMethodResponseCommandOutput extends MethodResponse, __Met
26
26
  * import { APIGatewayClient, UpdateMethodResponseCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, UpdateMethodResponseCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // UpdateMethodResponseRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * resourceId: "STRING_VALUE", // required
32
+ * httpMethod: "STRING_VALUE", // required
33
+ * statusCode: "STRING_VALUE", // required
34
+ * patchOperations: [ // ListOfPatchOperation
35
+ * { // PatchOperation
36
+ * op: "add" || "remove" || "replace" || "move" || "copy" || "test",
37
+ * path: "STRING_VALUE",
38
+ * value: "STRING_VALUE",
39
+ * from: "STRING_VALUE",
40
+ * },
41
+ * ],
42
+ * };
29
43
  * const command = new UpdateMethodResponseCommand(input);
30
44
  * const response = await client.send(command);
31
45
  * ```
@@ -26,6 +26,18 @@ export interface UpdateModelCommandOutput extends Model, __MetadataBearer {
26
26
  * import { APIGatewayClient, UpdateModelCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, UpdateModelCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // UpdateModelRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * modelName: "STRING_VALUE", // required
32
+ * patchOperations: [ // ListOfPatchOperation
33
+ * { // PatchOperation
34
+ * op: "add" || "remove" || "replace" || "move" || "copy" || "test",
35
+ * path: "STRING_VALUE",
36
+ * value: "STRING_VALUE",
37
+ * from: "STRING_VALUE",
38
+ * },
39
+ * ],
40
+ * };
29
41
  * const command = new UpdateModelCommand(input);
30
42
  * const response = await client.send(command);
31
43
  * ```
@@ -26,6 +26,18 @@ export interface UpdateRequestValidatorCommandOutput extends RequestValidator, _
26
26
  * import { APIGatewayClient, UpdateRequestValidatorCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, UpdateRequestValidatorCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // UpdateRequestValidatorRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * requestValidatorId: "STRING_VALUE", // required
32
+ * patchOperations: [ // ListOfPatchOperation
33
+ * { // PatchOperation
34
+ * op: "add" || "remove" || "replace" || "move" || "copy" || "test",
35
+ * path: "STRING_VALUE",
36
+ * value: "STRING_VALUE",
37
+ * from: "STRING_VALUE",
38
+ * },
39
+ * ],
40
+ * };
29
41
  * const command = new UpdateRequestValidatorCommand(input);
30
42
  * const response = await client.send(command);
31
43
  * ```
@@ -26,6 +26,18 @@ export interface UpdateResourceCommandOutput extends Resource, __MetadataBearer
26
26
  * import { APIGatewayClient, UpdateResourceCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, UpdateResourceCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // UpdateResourceRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * resourceId: "STRING_VALUE", // required
32
+ * patchOperations: [ // ListOfPatchOperation
33
+ * { // PatchOperation
34
+ * op: "add" || "remove" || "replace" || "move" || "copy" || "test",
35
+ * path: "STRING_VALUE",
36
+ * value: "STRING_VALUE",
37
+ * from: "STRING_VALUE",
38
+ * },
39
+ * ],
40
+ * };
29
41
  * const command = new UpdateResourceCommand(input);
30
42
  * const response = await client.send(command);
31
43
  * ```
@@ -26,6 +26,17 @@ export interface UpdateRestApiCommandOutput extends RestApi, __MetadataBearer {
26
26
  * import { APIGatewayClient, UpdateRestApiCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, UpdateRestApiCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // UpdateRestApiRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * patchOperations: [ // ListOfPatchOperation
32
+ * { // PatchOperation
33
+ * op: "add" || "remove" || "replace" || "move" || "copy" || "test",
34
+ * path: "STRING_VALUE",
35
+ * value: "STRING_VALUE",
36
+ * from: "STRING_VALUE",
37
+ * },
38
+ * ],
39
+ * };
29
40
  * const command = new UpdateRestApiCommand(input);
30
41
  * const response = await client.send(command);
31
42
  * ```
@@ -26,6 +26,18 @@ export interface UpdateStageCommandOutput extends Stage, __MetadataBearer {
26
26
  * import { APIGatewayClient, UpdateStageCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
27
27
  * // const { APIGatewayClient, UpdateStageCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
28
28
  * const client = new APIGatewayClient(config);
29
+ * const input = { // UpdateStageRequest
30
+ * restApiId: "STRING_VALUE", // required
31
+ * stageName: "STRING_VALUE", // required
32
+ * patchOperations: [ // ListOfPatchOperation
33
+ * { // PatchOperation
34
+ * op: "add" || "remove" || "replace" || "move" || "copy" || "test",
35
+ * path: "STRING_VALUE",
36
+ * value: "STRING_VALUE",
37
+ * from: "STRING_VALUE",
38
+ * },
39
+ * ],
40
+ * };
29
41
  * const command = new UpdateStageCommand(input);
30
42
  * const response = await client.send(command);
31
43
  * ```