@aws-sdk/client-api-gateway 3.325.0 → 3.326.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 +19 -0
  2. package/dist-types/commands/CreateAuthorizerCommand.d.ts +17 -0
  3. package/dist-types/commands/CreateBasePathMappingCommand.d.ts +8 -0
  4. package/dist-types/commands/CreateDeploymentCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateDocumentationPartCommand.d.ts +14 -0
  6. package/dist-types/commands/CreateDocumentationVersionCommand.d.ts +8 -0
  7. package/dist-types/commands/CreateDomainNameCommand.d.ts +37 -0
  8. package/dist-types/commands/CreateModelCommand.d.ts +10 -0
  9. package/dist-types/commands/CreateRequestValidatorCommand.d.ts +9 -0
  10. package/dist-types/commands/CreateResourceCommand.d.ts +68 -0
  11. package/dist-types/commands/CreateRestApiCommand.d.ts +31 -0
  12. package/dist-types/commands/CreateStageCommand.d.ts +49 -0
  13. package/dist-types/commands/CreateUsagePlanCommand.d.ts +33 -0
  14. package/dist-types/commands/CreateUsagePlanKeyCommand.d.ts +9 -0
  15. package/dist-types/commands/CreateVpcLinkCommand.d.ts +16 -0
  16. package/dist-types/commands/DeleteApiKeyCommand.d.ts +4 -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 +4 -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 +4 -0
  24. package/dist-types/commands/DeleteGatewayResponseCommand.d.ts +4 -0
  25. package/dist-types/commands/DeleteIntegrationCommand.d.ts +4 -0
  26. package/dist-types/commands/DeleteIntegrationResponseCommand.d.ts +4 -0
  27. package/dist-types/commands/DeleteMethodCommand.d.ts +4 -0
  28. package/dist-types/commands/DeleteMethodResponseCommand.d.ts +4 -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 +4 -0
  33. package/dist-types/commands/DeleteStageCommand.d.ts +4 -0
  34. package/dist-types/commands/DeleteUsagePlanCommand.d.ts +4 -0
  35. package/dist-types/commands/DeleteUsagePlanKeyCommand.d.ts +4 -0
  36. package/dist-types/commands/DeleteVpcLinkCommand.d.ts +4 -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 +13 -0
  40. package/dist-types/commands/GetAccountCommand.d.ts +14 -0
  41. package/dist-types/commands/GetApiKeyCommand.d.ts +19 -0
  42. package/dist-types/commands/GetApiKeysCommand.d.ts +27 -0
  43. package/dist-types/commands/GetAuthorizerCommand.d.ts +17 -0
  44. package/dist-types/commands/GetAuthorizersCommand.d.ts +22 -0
  45. package/dist-types/commands/GetBasePathMappingCommand.d.ts +8 -0
  46. package/dist-types/commands/GetBasePathMappingsCommand.d.ts +13 -0
  47. package/dist-types/commands/GetClientCertificateCommand.d.ts +13 -0
  48. package/dist-types/commands/GetClientCertificatesCommand.d.ts +18 -0
  49. package/dist-types/commands/GetDeploymentCommand.d.ts +16 -0
  50. package/dist-types/commands/GetDeploymentsCommand.d.ts +21 -0
  51. package/dist-types/commands/GetDocumentationPartCommand.d.ts +14 -0
  52. package/dist-types/commands/GetDocumentationPartsCommand.d.ts +19 -0
  53. package/dist-types/commands/GetDocumentationVersionCommand.d.ts +8 -0
  54. package/dist-types/commands/GetDocumentationVersionsCommand.d.ts +13 -0
  55. package/dist-types/commands/GetDomainNameCommand.d.ts +37 -0
  56. package/dist-types/commands/GetDomainNamesCommand.d.ts +42 -0
  57. package/dist-types/commands/GetExportCommand.d.ts +8 -0
  58. package/dist-types/commands/GetGatewayResponseCommand.d.ts +14 -0
  59. package/dist-types/commands/GetGatewayResponsesCommand.d.ts +19 -0
  60. package/dist-types/commands/GetIntegrationCommand.d.ts +40 -0
  61. package/dist-types/commands/GetIntegrationResponseCommand.d.ts +14 -0
  62. package/dist-types/commands/GetMethodCommand.d.ts +60 -0
  63. package/dist-types/commands/GetMethodResponseCommand.d.ts +12 -0
  64. package/dist-types/commands/GetModelCommand.d.ts +10 -0
  65. package/dist-types/commands/GetModelTemplateCommand.d.ts +6 -0
  66. package/dist-types/commands/GetModelsCommand.d.ts +15 -0
  67. package/dist-types/commands/GetRequestValidatorCommand.d.ts +9 -0
  68. package/dist-types/commands/GetRequestValidatorsCommand.d.ts +14 -0
  69. package/dist-types/commands/GetResourceCommand.d.ts +68 -0
  70. package/dist-types/commands/GetResourcesCommand.d.ts +73 -0
  71. package/dist-types/commands/GetRestApiCommand.d.ts +31 -0
  72. package/dist-types/commands/GetRestApisCommand.d.ts +36 -0
  73. package/dist-types/commands/GetSdkCommand.d.ts +8 -0
  74. package/dist-types/commands/GetSdkTypeCommand.d.ts +17 -0
  75. package/dist-types/commands/GetSdkTypesCommand.d.ts +21 -0
  76. package/dist-types/commands/GetStageCommand.d.ts +49 -0
  77. package/dist-types/commands/GetStagesCommand.d.ts +53 -0
  78. package/dist-types/commands/GetTagsCommand.d.ts +8 -0
  79. package/dist-types/commands/GetUsageCommand.d.ts +16 -0
  80. package/dist-types/commands/GetUsagePlanCommand.d.ts +33 -0
  81. package/dist-types/commands/GetUsagePlanKeyCommand.d.ts +9 -0
  82. package/dist-types/commands/GetUsagePlanKeysCommand.d.ts +14 -0
  83. package/dist-types/commands/GetUsagePlansCommand.d.ts +38 -0
  84. package/dist-types/commands/GetVpcLinkCommand.d.ts +16 -0
  85. package/dist-types/commands/GetVpcLinksCommand.d.ts +21 -0
  86. package/dist-types/commands/ImportApiKeysCommand.d.ts +11 -0
  87. package/dist-types/commands/ImportDocumentationPartsCommand.d.ts +11 -0
  88. package/dist-types/commands/ImportRestApiCommand.d.ts +31 -0
  89. package/dist-types/commands/PutGatewayResponseCommand.d.ts +14 -0
  90. package/dist-types/commands/PutIntegrationCommand.d.ts +40 -0
  91. package/dist-types/commands/PutIntegrationResponseCommand.d.ts +14 -0
  92. package/dist-types/commands/PutMethodCommand.d.ts +60 -0
  93. package/dist-types/commands/PutMethodResponseCommand.d.ts +12 -0
  94. package/dist-types/commands/PutRestApiCommand.d.ts +31 -0
  95. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  96. package/dist-types/commands/TestInvokeAuthorizerCommand.d.ts +18 -0
  97. package/dist-types/commands/TestInvokeMethodCommand.d.ts +17 -0
  98. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  99. package/dist-types/commands/UpdateAccountCommand.d.ts +14 -0
  100. package/dist-types/commands/UpdateApiKeyCommand.d.ts +19 -0
  101. package/dist-types/commands/UpdateAuthorizerCommand.d.ts +17 -0
  102. package/dist-types/commands/UpdateBasePathMappingCommand.d.ts +8 -0
  103. package/dist-types/commands/UpdateClientCertificateCommand.d.ts +13 -0
  104. package/dist-types/commands/UpdateDeploymentCommand.d.ts +16 -0
  105. package/dist-types/commands/UpdateDocumentationPartCommand.d.ts +14 -0
  106. package/dist-types/commands/UpdateDocumentationVersionCommand.d.ts +8 -0
  107. package/dist-types/commands/UpdateDomainNameCommand.d.ts +37 -0
  108. package/dist-types/commands/UpdateGatewayResponseCommand.d.ts +14 -0
  109. package/dist-types/commands/UpdateIntegrationCommand.d.ts +40 -0
  110. package/dist-types/commands/UpdateIntegrationResponseCommand.d.ts +14 -0
  111. package/dist-types/commands/UpdateMethodCommand.d.ts +60 -0
  112. package/dist-types/commands/UpdateMethodResponseCommand.d.ts +12 -0
  113. package/dist-types/commands/UpdateModelCommand.d.ts +10 -0
  114. package/dist-types/commands/UpdateRequestValidatorCommand.d.ts +9 -0
  115. package/dist-types/commands/UpdateResourceCommand.d.ts +68 -0
  116. package/dist-types/commands/UpdateRestApiCommand.d.ts +31 -0
  117. package/dist-types/commands/UpdateStageCommand.d.ts +49 -0
  118. package/dist-types/commands/UpdateUsageCommand.d.ts +16 -0
  119. package/dist-types/commands/UpdateUsagePlanCommand.d.ts +33 -0
  120. package/dist-types/commands/UpdateVpcLinkCommand.d.ts +16 -0
  121. package/package.json +4 -4
@@ -40,6 +40,21 @@ export interface UpdateAuthorizerCommandOutput extends Authorizer, __MetadataBea
40
40
  * };
41
41
  * const command = new UpdateAuthorizerCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // Authorizer
44
+ * // id: "STRING_VALUE",
45
+ * // name: "STRING_VALUE",
46
+ * // type: "TOKEN" || "REQUEST" || "COGNITO_USER_POOLS",
47
+ * // providerARNs: [ // ListOfARNs
48
+ * // "STRING_VALUE",
49
+ * // ],
50
+ * // authType: "STRING_VALUE",
51
+ * // authorizerUri: "STRING_VALUE",
52
+ * // authorizerCredentials: "STRING_VALUE",
53
+ * // identitySource: "STRING_VALUE",
54
+ * // identityValidationExpression: "STRING_VALUE",
55
+ * // authorizerResultTtlInSeconds: Number("int"),
56
+ * // };
57
+ *
43
58
  * ```
44
59
  *
45
60
  * @param UpdateAuthorizerCommandInput - {@link UpdateAuthorizerCommandInput}
@@ -66,6 +81,8 @@ export interface UpdateAuthorizerCommandOutput extends Authorizer, __MetadataBea
66
81
  * @throws {@link UnauthorizedException} (client fault)
67
82
  * <p>The request is denied because the caller has insufficient permissions.</p>
68
83
  *
84
+ * @throws {@link APIGatewayServiceException}
85
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
69
86
  *
70
87
  */
71
88
  export declare class UpdateAuthorizerCommand extends $Command<UpdateAuthorizerCommandInput, UpdateAuthorizerCommandOutput, APIGatewayClientResolvedConfig> {
@@ -40,6 +40,12 @@ export interface UpdateBasePathMappingCommandOutput extends BasePathMapping, __M
40
40
  * };
41
41
  * const command = new UpdateBasePathMappingCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // BasePathMapping
44
+ * // basePath: "STRING_VALUE",
45
+ * // restApiId: "STRING_VALUE",
46
+ * // stage: "STRING_VALUE",
47
+ * // };
48
+ *
43
49
  * ```
44
50
  *
45
51
  * @param UpdateBasePathMappingCommandInput - {@link UpdateBasePathMappingCommandInput}
@@ -66,6 +72,8 @@ export interface UpdateBasePathMappingCommandOutput extends BasePathMapping, __M
66
72
  * @throws {@link UnauthorizedException} (client fault)
67
73
  * <p>The request is denied because the caller has insufficient permissions.</p>
68
74
  *
75
+ * @throws {@link APIGatewayServiceException}
76
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
69
77
  *
70
78
  */
71
79
  export declare class UpdateBasePathMappingCommand extends $Command<UpdateBasePathMappingCommandInput, UpdateBasePathMappingCommandOutput, APIGatewayClientResolvedConfig> {
@@ -39,6 +39,17 @@ export interface UpdateClientCertificateCommandOutput extends ClientCertificate,
39
39
  * };
40
40
  * const command = new UpdateClientCertificateCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // ClientCertificate
43
+ * // clientCertificateId: "STRING_VALUE",
44
+ * // description: "STRING_VALUE",
45
+ * // pemEncodedCertificate: "STRING_VALUE",
46
+ * // createdDate: new Date("TIMESTAMP"),
47
+ * // expirationDate: new Date("TIMESTAMP"),
48
+ * // tags: { // MapOfStringToString
49
+ * // "<keys>": "STRING_VALUE",
50
+ * // },
51
+ * // };
52
+ *
42
53
  * ```
43
54
  *
44
55
  * @param UpdateClientCertificateCommandInput - {@link UpdateClientCertificateCommandInput}
@@ -65,6 +76,8 @@ export interface UpdateClientCertificateCommandOutput extends ClientCertificate,
65
76
  * @throws {@link UnauthorizedException} (client fault)
66
77
  * <p>The request is denied because the caller has insufficient permissions.</p>
67
78
  *
79
+ * @throws {@link APIGatewayServiceException}
80
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
68
81
  *
69
82
  */
70
83
  export declare class UpdateClientCertificateCommand extends $Command<UpdateClientCertificateCommandInput, UpdateClientCertificateCommandOutput, APIGatewayClientResolvedConfig> {
@@ -40,6 +40,20 @@ export interface UpdateDeploymentCommandOutput extends Deployment, __MetadataBea
40
40
  * };
41
41
  * const command = new UpdateDeploymentCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // Deployment
44
+ * // id: "STRING_VALUE",
45
+ * // description: "STRING_VALUE",
46
+ * // createdDate: new Date("TIMESTAMP"),
47
+ * // apiSummary: { // PathToMapOfMethodSnapshot
48
+ * // "<keys>": { // MapOfMethodSnapshot
49
+ * // "<keys>": { // MethodSnapshot
50
+ * // authorizationType: "STRING_VALUE",
51
+ * // apiKeyRequired: true || false,
52
+ * // },
53
+ * // },
54
+ * // },
55
+ * // };
56
+ *
43
57
  * ```
44
58
  *
45
59
  * @param UpdateDeploymentCommandInput - {@link UpdateDeploymentCommandInput}
@@ -69,6 +83,8 @@ export interface UpdateDeploymentCommandOutput extends Deployment, __MetadataBea
69
83
  * @throws {@link UnauthorizedException} (client fault)
70
84
  * <p>The request is denied because the caller has insufficient permissions.</p>
71
85
  *
86
+ * @throws {@link APIGatewayServiceException}
87
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
72
88
  *
73
89
  */
74
90
  export declare class UpdateDeploymentCommand extends $Command<UpdateDeploymentCommandInput, UpdateDeploymentCommandOutput, APIGatewayClientResolvedConfig> {
@@ -40,6 +40,18 @@ export interface UpdateDocumentationPartCommandOutput extends DocumentationPart,
40
40
  * };
41
41
  * const command = new UpdateDocumentationPartCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // DocumentationPart
44
+ * // id: "STRING_VALUE",
45
+ * // location: { // DocumentationPartLocation
46
+ * // type: "API" || "AUTHORIZER" || "MODEL" || "RESOURCE" || "METHOD" || "PATH_PARAMETER" || "QUERY_PARAMETER" || "REQUEST_HEADER" || "REQUEST_BODY" || "RESPONSE" || "RESPONSE_HEADER" || "RESPONSE_BODY", // required
47
+ * // path: "STRING_VALUE",
48
+ * // method: "STRING_VALUE",
49
+ * // statusCode: "STRING_VALUE",
50
+ * // name: "STRING_VALUE",
51
+ * // },
52
+ * // properties: "STRING_VALUE",
53
+ * // };
54
+ *
43
55
  * ```
44
56
  *
45
57
  * @param UpdateDocumentationPartCommandInput - {@link UpdateDocumentationPartCommandInput}
@@ -66,6 +78,8 @@ export interface UpdateDocumentationPartCommandOutput extends DocumentationPart,
66
78
  * @throws {@link UnauthorizedException} (client fault)
67
79
  * <p>The request is denied because the caller has insufficient permissions.</p>
68
80
  *
81
+ * @throws {@link APIGatewayServiceException}
82
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
69
83
  *
70
84
  */
71
85
  export declare class UpdateDocumentationPartCommand extends $Command<UpdateDocumentationPartCommandInput, UpdateDocumentationPartCommandOutput, APIGatewayClientResolvedConfig> {
@@ -40,6 +40,12 @@ export interface UpdateDocumentationVersionCommandOutput extends DocumentationVe
40
40
  * };
41
41
  * const command = new UpdateDocumentationVersionCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // DocumentationVersion
44
+ * // version: "STRING_VALUE",
45
+ * // createdDate: new Date("TIMESTAMP"),
46
+ * // description: "STRING_VALUE",
47
+ * // };
48
+ *
43
49
  * ```
44
50
  *
45
51
  * @param UpdateDocumentationVersionCommandInput - {@link UpdateDocumentationVersionCommandInput}
@@ -66,6 +72,8 @@ export interface UpdateDocumentationVersionCommandOutput extends DocumentationVe
66
72
  * @throws {@link UnauthorizedException} (client fault)
67
73
  * <p>The request is denied because the caller has insufficient permissions.</p>
68
74
  *
75
+ * @throws {@link APIGatewayServiceException}
76
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
69
77
  *
70
78
  */
71
79
  export declare class UpdateDocumentationVersionCommand extends $Command<UpdateDocumentationVersionCommandInput, UpdateDocumentationVersionCommandOutput, APIGatewayClientResolvedConfig> {
@@ -39,6 +39,41 @@ export interface UpdateDomainNameCommandOutput extends DomainName, __MetadataBea
39
39
  * };
40
40
  * const command = new UpdateDomainNameCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // DomainName
43
+ * // domainName: "STRING_VALUE",
44
+ * // certificateName: "STRING_VALUE",
45
+ * // certificateArn: "STRING_VALUE",
46
+ * // certificateUploadDate: new Date("TIMESTAMP"),
47
+ * // regionalDomainName: "STRING_VALUE",
48
+ * // regionalHostedZoneId: "STRING_VALUE",
49
+ * // regionalCertificateName: "STRING_VALUE",
50
+ * // regionalCertificateArn: "STRING_VALUE",
51
+ * // distributionDomainName: "STRING_VALUE",
52
+ * // distributionHostedZoneId: "STRING_VALUE",
53
+ * // endpointConfiguration: { // EndpointConfiguration
54
+ * // types: [ // ListOfEndpointType
55
+ * // "REGIONAL" || "EDGE" || "PRIVATE",
56
+ * // ],
57
+ * // vpcEndpointIds: [ // ListOfString
58
+ * // "STRING_VALUE",
59
+ * // ],
60
+ * // },
61
+ * // domainNameStatus: "AVAILABLE" || "UPDATING" || "PENDING" || "PENDING_CERTIFICATE_REIMPORT" || "PENDING_OWNERSHIP_VERIFICATION",
62
+ * // domainNameStatusMessage: "STRING_VALUE",
63
+ * // securityPolicy: "TLS_1_0" || "TLS_1_2",
64
+ * // tags: { // MapOfStringToString
65
+ * // "<keys>": "STRING_VALUE",
66
+ * // },
67
+ * // mutualTlsAuthentication: { // MutualTlsAuthentication
68
+ * // truststoreUri: "STRING_VALUE",
69
+ * // truststoreVersion: "STRING_VALUE",
70
+ * // truststoreWarnings: [
71
+ * // "STRING_VALUE",
72
+ * // ],
73
+ * // },
74
+ * // ownershipVerificationCertificateArn: "STRING_VALUE",
75
+ * // };
76
+ *
42
77
  * ```
43
78
  *
44
79
  * @param UpdateDomainNameCommandInput - {@link UpdateDomainNameCommandInput}
@@ -65,6 +100,8 @@ export interface UpdateDomainNameCommandOutput extends DomainName, __MetadataBea
65
100
  * @throws {@link UnauthorizedException} (client fault)
66
101
  * <p>The request is denied because the caller has insufficient permissions.</p>
67
102
  *
103
+ * @throws {@link APIGatewayServiceException}
104
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
68
105
  *
69
106
  */
70
107
  export declare class UpdateDomainNameCommand extends $Command<UpdateDomainNameCommandInput, UpdateDomainNameCommandOutput, APIGatewayClientResolvedConfig> {
@@ -40,6 +40,18 @@ export interface UpdateGatewayResponseCommandOutput extends GatewayResponse, __M
40
40
  * };
41
41
  * const command = new UpdateGatewayResponseCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // GatewayResponse
44
+ * // 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",
45
+ * // statusCode: "STRING_VALUE",
46
+ * // responseParameters: { // MapOfStringToString
47
+ * // "<keys>": "STRING_VALUE",
48
+ * // },
49
+ * // responseTemplates: {
50
+ * // "<keys>": "STRING_VALUE",
51
+ * // },
52
+ * // defaultResponse: true || false,
53
+ * // };
54
+ *
43
55
  * ```
44
56
  *
45
57
  * @param UpdateGatewayResponseCommandInput - {@link UpdateGatewayResponseCommandInput}
@@ -66,6 +78,8 @@ export interface UpdateGatewayResponseCommandOutput extends GatewayResponse, __M
66
78
  * @throws {@link UnauthorizedException} (client fault)
67
79
  * <p>The request is denied because the caller has insufficient permissions.</p>
68
80
  *
81
+ * @throws {@link APIGatewayServiceException}
82
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
69
83
  *
70
84
  */
71
85
  export declare class UpdateGatewayResponseCommand extends $Command<UpdateGatewayResponseCommandInput, UpdateGatewayResponseCommandOutput, APIGatewayClientResolvedConfig> {
@@ -41,6 +41,44 @@ export interface UpdateIntegrationCommandOutput extends Integration, __MetadataB
41
41
  * };
42
42
  * const command = new UpdateIntegrationCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // { // Integration
45
+ * // type: "HTTP" || "AWS" || "MOCK" || "HTTP_PROXY" || "AWS_PROXY",
46
+ * // httpMethod: "STRING_VALUE",
47
+ * // uri: "STRING_VALUE",
48
+ * // connectionType: "INTERNET" || "VPC_LINK",
49
+ * // connectionId: "STRING_VALUE",
50
+ * // credentials: "STRING_VALUE",
51
+ * // requestParameters: { // MapOfStringToString
52
+ * // "<keys>": "STRING_VALUE",
53
+ * // },
54
+ * // requestTemplates: {
55
+ * // "<keys>": "STRING_VALUE",
56
+ * // },
57
+ * // passthroughBehavior: "STRING_VALUE",
58
+ * // contentHandling: "CONVERT_TO_BINARY" || "CONVERT_TO_TEXT",
59
+ * // timeoutInMillis: Number("int"),
60
+ * // cacheNamespace: "STRING_VALUE",
61
+ * // cacheKeyParameters: [ // ListOfString
62
+ * // "STRING_VALUE",
63
+ * // ],
64
+ * // integrationResponses: { // MapOfIntegrationResponse
65
+ * // "<keys>": { // IntegrationResponse
66
+ * // statusCode: "STRING_VALUE",
67
+ * // selectionPattern: "STRING_VALUE",
68
+ * // responseParameters: {
69
+ * // "<keys>": "STRING_VALUE",
70
+ * // },
71
+ * // responseTemplates: {
72
+ * // "<keys>": "STRING_VALUE",
73
+ * // },
74
+ * // contentHandling: "CONVERT_TO_BINARY" || "CONVERT_TO_TEXT",
75
+ * // },
76
+ * // },
77
+ * // tlsConfig: { // TlsConfig
78
+ * // insecureSkipVerification: true || false,
79
+ * // },
80
+ * // };
81
+ *
44
82
  * ```
45
83
  *
46
84
  * @param UpdateIntegrationCommandInput - {@link UpdateIntegrationCommandInput}
@@ -67,6 +105,8 @@ export interface UpdateIntegrationCommandOutput extends Integration, __MetadataB
67
105
  * @throws {@link UnauthorizedException} (client fault)
68
106
  * <p>The request is denied because the caller has insufficient permissions.</p>
69
107
  *
108
+ * @throws {@link APIGatewayServiceException}
109
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
70
110
  *
71
111
  */
72
112
  export declare class UpdateIntegrationCommand extends $Command<UpdateIntegrationCommandInput, UpdateIntegrationCommandOutput, APIGatewayClientResolvedConfig> {
@@ -42,6 +42,18 @@ export interface UpdateIntegrationResponseCommandOutput extends IntegrationRespo
42
42
  * };
43
43
  * const command = new UpdateIntegrationResponseCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // IntegrationResponse
46
+ * // statusCode: "STRING_VALUE",
47
+ * // selectionPattern: "STRING_VALUE",
48
+ * // responseParameters: { // MapOfStringToString
49
+ * // "<keys>": "STRING_VALUE",
50
+ * // },
51
+ * // responseTemplates: {
52
+ * // "<keys>": "STRING_VALUE",
53
+ * // },
54
+ * // contentHandling: "CONVERT_TO_BINARY" || "CONVERT_TO_TEXT",
55
+ * // };
56
+ *
45
57
  * ```
46
58
  *
47
59
  * @param UpdateIntegrationResponseCommandInput - {@link UpdateIntegrationResponseCommandInput}
@@ -68,6 +80,8 @@ export interface UpdateIntegrationResponseCommandOutput extends IntegrationRespo
68
80
  * @throws {@link UnauthorizedException} (client fault)
69
81
  * <p>The request is denied because the caller has insufficient permissions.</p>
70
82
  *
83
+ * @throws {@link APIGatewayServiceException}
84
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
71
85
  *
72
86
  */
73
87
  export declare class UpdateIntegrationResponseCommand extends $Command<UpdateIntegrationResponseCommandInput, UpdateIntegrationResponseCommandOutput, APIGatewayClientResolvedConfig> {
@@ -41,6 +41,64 @@ export interface UpdateMethodCommandOutput extends Method, __MetadataBearer {
41
41
  * };
42
42
  * const command = new UpdateMethodCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // { // Method
45
+ * // httpMethod: "STRING_VALUE",
46
+ * // authorizationType: "STRING_VALUE",
47
+ * // authorizerId: "STRING_VALUE",
48
+ * // apiKeyRequired: true || false,
49
+ * // requestValidatorId: "STRING_VALUE",
50
+ * // operationName: "STRING_VALUE",
51
+ * // requestParameters: { // MapOfStringToBoolean
52
+ * // "<keys>": true || false,
53
+ * // },
54
+ * // requestModels: { // MapOfStringToString
55
+ * // "<keys>": "STRING_VALUE",
56
+ * // },
57
+ * // methodResponses: { // MapOfMethodResponse
58
+ * // "<keys>": { // MethodResponse
59
+ * // statusCode: "STRING_VALUE",
60
+ * // responseParameters: {
61
+ * // "<keys>": true || false,
62
+ * // },
63
+ * // responseModels: {
64
+ * // "<keys>": "STRING_VALUE",
65
+ * // },
66
+ * // },
67
+ * // },
68
+ * // methodIntegration: { // Integration
69
+ * // type: "HTTP" || "AWS" || "MOCK" || "HTTP_PROXY" || "AWS_PROXY",
70
+ * // httpMethod: "STRING_VALUE",
71
+ * // uri: "STRING_VALUE",
72
+ * // connectionType: "INTERNET" || "VPC_LINK",
73
+ * // connectionId: "STRING_VALUE",
74
+ * // credentials: "STRING_VALUE",
75
+ * // requestParameters: "<MapOfStringToString>",
76
+ * // requestTemplates: "<MapOfStringToString>",
77
+ * // passthroughBehavior: "STRING_VALUE",
78
+ * // contentHandling: "CONVERT_TO_BINARY" || "CONVERT_TO_TEXT",
79
+ * // timeoutInMillis: Number("int"),
80
+ * // cacheNamespace: "STRING_VALUE",
81
+ * // cacheKeyParameters: [ // ListOfString
82
+ * // "STRING_VALUE",
83
+ * // ],
84
+ * // integrationResponses: { // MapOfIntegrationResponse
85
+ * // "<keys>": { // IntegrationResponse
86
+ * // statusCode: "STRING_VALUE",
87
+ * // selectionPattern: "STRING_VALUE",
88
+ * // responseParameters: "<MapOfStringToString>",
89
+ * // responseTemplates: "<MapOfStringToString>",
90
+ * // contentHandling: "CONVERT_TO_BINARY" || "CONVERT_TO_TEXT",
91
+ * // },
92
+ * // },
93
+ * // tlsConfig: { // TlsConfig
94
+ * // insecureSkipVerification: true || false,
95
+ * // },
96
+ * // },
97
+ * // authorizationScopes: [
98
+ * // "STRING_VALUE",
99
+ * // ],
100
+ * // };
101
+ *
44
102
  * ```
45
103
  *
46
104
  * @param UpdateMethodCommandInput - {@link UpdateMethodCommandInput}
@@ -64,6 +122,8 @@ export interface UpdateMethodCommandOutput extends Method, __MetadataBearer {
64
122
  * @throws {@link UnauthorizedException} (client fault)
65
123
  * <p>The request is denied because the caller has insufficient permissions.</p>
66
124
  *
125
+ * @throws {@link APIGatewayServiceException}
126
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
67
127
  *
68
128
  */
69
129
  export declare class UpdateMethodCommand extends $Command<UpdateMethodCommandInput, UpdateMethodCommandOutput, APIGatewayClientResolvedConfig> {
@@ -42,6 +42,16 @@ export interface UpdateMethodResponseCommandOutput extends MethodResponse, __Met
42
42
  * };
43
43
  * const command = new UpdateMethodResponseCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // MethodResponse
46
+ * // statusCode: "STRING_VALUE",
47
+ * // responseParameters: { // MapOfStringToBoolean
48
+ * // "<keys>": true || false,
49
+ * // },
50
+ * // responseModels: { // MapOfStringToString
51
+ * // "<keys>": "STRING_VALUE",
52
+ * // },
53
+ * // };
54
+ *
45
55
  * ```
46
56
  *
47
57
  * @param UpdateMethodResponseCommandInput - {@link UpdateMethodResponseCommandInput}
@@ -68,6 +78,8 @@ export interface UpdateMethodResponseCommandOutput extends MethodResponse, __Met
68
78
  * @throws {@link UnauthorizedException} (client fault)
69
79
  * <p>The request is denied because the caller has insufficient permissions.</p>
70
80
  *
81
+ * @throws {@link APIGatewayServiceException}
82
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
71
83
  *
72
84
  */
73
85
  export declare class UpdateMethodResponseCommand extends $Command<UpdateMethodResponseCommandInput, UpdateMethodResponseCommandOutput, APIGatewayClientResolvedConfig> {
@@ -40,6 +40,14 @@ export interface UpdateModelCommandOutput extends Model, __MetadataBearer {
40
40
  * };
41
41
  * const command = new UpdateModelCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // Model
44
+ * // id: "STRING_VALUE",
45
+ * // name: "STRING_VALUE",
46
+ * // description: "STRING_VALUE",
47
+ * // schema: "STRING_VALUE",
48
+ * // contentType: "STRING_VALUE",
49
+ * // };
50
+ *
43
51
  * ```
44
52
  *
45
53
  * @param UpdateModelCommandInput - {@link UpdateModelCommandInput}
@@ -66,6 +74,8 @@ export interface UpdateModelCommandOutput extends Model, __MetadataBearer {
66
74
  * @throws {@link UnauthorizedException} (client fault)
67
75
  * <p>The request is denied because the caller has insufficient permissions.</p>
68
76
  *
77
+ * @throws {@link APIGatewayServiceException}
78
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
69
79
  *
70
80
  */
71
81
  export declare class UpdateModelCommand extends $Command<UpdateModelCommandInput, UpdateModelCommandOutput, APIGatewayClientResolvedConfig> {
@@ -40,6 +40,13 @@ export interface UpdateRequestValidatorCommandOutput extends RequestValidator, _
40
40
  * };
41
41
  * const command = new UpdateRequestValidatorCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // RequestValidator
44
+ * // id: "STRING_VALUE",
45
+ * // name: "STRING_VALUE",
46
+ * // validateRequestBody: true || false,
47
+ * // validateRequestParameters: true || false,
48
+ * // };
49
+ *
43
50
  * ```
44
51
  *
45
52
  * @param UpdateRequestValidatorCommandInput - {@link UpdateRequestValidatorCommandInput}
@@ -66,6 +73,8 @@ export interface UpdateRequestValidatorCommandOutput extends RequestValidator, _
66
73
  * @throws {@link UnauthorizedException} (client fault)
67
74
  * <p>The request is denied because the caller has insufficient permissions.</p>
68
75
  *
76
+ * @throws {@link APIGatewayServiceException}
77
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
69
78
  *
70
79
  */
71
80
  export declare class UpdateRequestValidatorCommand extends $Command<UpdateRequestValidatorCommandInput, UpdateRequestValidatorCommandOutput, APIGatewayClientResolvedConfig> {
@@ -40,6 +40,72 @@ export interface UpdateResourceCommandOutput extends Resource, __MetadataBearer
40
40
  * };
41
41
  * const command = new UpdateResourceCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // Resource
44
+ * // id: "STRING_VALUE",
45
+ * // parentId: "STRING_VALUE",
46
+ * // pathPart: "STRING_VALUE",
47
+ * // path: "STRING_VALUE",
48
+ * // resourceMethods: { // MapOfMethod
49
+ * // "<keys>": { // Method
50
+ * // httpMethod: "STRING_VALUE",
51
+ * // authorizationType: "STRING_VALUE",
52
+ * // authorizerId: "STRING_VALUE",
53
+ * // apiKeyRequired: true || false,
54
+ * // requestValidatorId: "STRING_VALUE",
55
+ * // operationName: "STRING_VALUE",
56
+ * // requestParameters: { // MapOfStringToBoolean
57
+ * // "<keys>": true || false,
58
+ * // },
59
+ * // requestModels: { // MapOfStringToString
60
+ * // "<keys>": "STRING_VALUE",
61
+ * // },
62
+ * // methodResponses: { // MapOfMethodResponse
63
+ * // "<keys>": { // MethodResponse
64
+ * // statusCode: "STRING_VALUE",
65
+ * // responseParameters: {
66
+ * // "<keys>": true || false,
67
+ * // },
68
+ * // responseModels: {
69
+ * // "<keys>": "STRING_VALUE",
70
+ * // },
71
+ * // },
72
+ * // },
73
+ * // methodIntegration: { // Integration
74
+ * // type: "HTTP" || "AWS" || "MOCK" || "HTTP_PROXY" || "AWS_PROXY",
75
+ * // httpMethod: "STRING_VALUE",
76
+ * // uri: "STRING_VALUE",
77
+ * // connectionType: "INTERNET" || "VPC_LINK",
78
+ * // connectionId: "STRING_VALUE",
79
+ * // credentials: "STRING_VALUE",
80
+ * // requestParameters: "<MapOfStringToString>",
81
+ * // requestTemplates: "<MapOfStringToString>",
82
+ * // passthroughBehavior: "STRING_VALUE",
83
+ * // contentHandling: "CONVERT_TO_BINARY" || "CONVERT_TO_TEXT",
84
+ * // timeoutInMillis: Number("int"),
85
+ * // cacheNamespace: "STRING_VALUE",
86
+ * // cacheKeyParameters: [ // ListOfString
87
+ * // "STRING_VALUE",
88
+ * // ],
89
+ * // integrationResponses: { // MapOfIntegrationResponse
90
+ * // "<keys>": { // IntegrationResponse
91
+ * // statusCode: "STRING_VALUE",
92
+ * // selectionPattern: "STRING_VALUE",
93
+ * // responseParameters: "<MapOfStringToString>",
94
+ * // responseTemplates: "<MapOfStringToString>",
95
+ * // contentHandling: "CONVERT_TO_BINARY" || "CONVERT_TO_TEXT",
96
+ * // },
97
+ * // },
98
+ * // tlsConfig: { // TlsConfig
99
+ * // insecureSkipVerification: true || false,
100
+ * // },
101
+ * // },
102
+ * // authorizationScopes: [
103
+ * // "STRING_VALUE",
104
+ * // ],
105
+ * // },
106
+ * // },
107
+ * // };
108
+ *
43
109
  * ```
44
110
  *
45
111
  * @param UpdateResourceCommandInput - {@link UpdateResourceCommandInput}
@@ -63,6 +129,8 @@ export interface UpdateResourceCommandOutput extends Resource, __MetadataBearer
63
129
  * @throws {@link UnauthorizedException} (client fault)
64
130
  * <p>The request is denied because the caller has insufficient permissions.</p>
65
131
  *
132
+ * @throws {@link APIGatewayServiceException}
133
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
66
134
  *
67
135
  */
68
136
  export declare class UpdateResourceCommand extends $Command<UpdateResourceCommandInput, UpdateResourceCommandOutput, APIGatewayClientResolvedConfig> {
@@ -39,6 +39,35 @@ export interface UpdateRestApiCommandOutput extends RestApi, __MetadataBearer {
39
39
  * };
40
40
  * const command = new UpdateRestApiCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // RestApi
43
+ * // id: "STRING_VALUE",
44
+ * // name: "STRING_VALUE",
45
+ * // description: "STRING_VALUE",
46
+ * // createdDate: new Date("TIMESTAMP"),
47
+ * // version: "STRING_VALUE",
48
+ * // warnings: [ // ListOfString
49
+ * // "STRING_VALUE",
50
+ * // ],
51
+ * // binaryMediaTypes: [
52
+ * // "STRING_VALUE",
53
+ * // ],
54
+ * // minimumCompressionSize: Number("int"),
55
+ * // apiKeySource: "HEADER" || "AUTHORIZER",
56
+ * // endpointConfiguration: { // EndpointConfiguration
57
+ * // types: [ // ListOfEndpointType
58
+ * // "REGIONAL" || "EDGE" || "PRIVATE",
59
+ * // ],
60
+ * // vpcEndpointIds: [
61
+ * // "STRING_VALUE",
62
+ * // ],
63
+ * // },
64
+ * // policy: "STRING_VALUE",
65
+ * // tags: { // MapOfStringToString
66
+ * // "<keys>": "STRING_VALUE",
67
+ * // },
68
+ * // disableExecuteApiEndpoint: true || false,
69
+ * // };
70
+ *
42
71
  * ```
43
72
  *
44
73
  * @param UpdateRestApiCommandInput - {@link UpdateRestApiCommandInput}
@@ -65,6 +94,8 @@ export interface UpdateRestApiCommandOutput extends RestApi, __MetadataBearer {
65
94
  * @throws {@link UnauthorizedException} (client fault)
66
95
  * <p>The request is denied because the caller has insufficient permissions.</p>
67
96
  *
97
+ * @throws {@link APIGatewayServiceException}
98
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
68
99
  *
69
100
  */
70
101
  export declare class UpdateRestApiCommand extends $Command<UpdateRestApiCommandInput, UpdateRestApiCommandOutput, APIGatewayClientResolvedConfig> {