@aws-sdk/client-api-gateway 3.321.1 → 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 +17 -17
@@ -35,6 +35,20 @@ export interface GetDeploymentCommandOutput extends Deployment, __MetadataBearer
35
35
  * };
36
36
  * const command = new GetDeploymentCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // Deployment
39
+ * // id: "STRING_VALUE",
40
+ * // description: "STRING_VALUE",
41
+ * // createdDate: new Date("TIMESTAMP"),
42
+ * // apiSummary: { // PathToMapOfMethodSnapshot
43
+ * // "<keys>": { // MapOfMethodSnapshot
44
+ * // "<keys>": { // MethodSnapshot
45
+ * // authorizationType: "STRING_VALUE",
46
+ * // apiKeyRequired: true || false,
47
+ * // },
48
+ * // },
49
+ * // },
50
+ * // };
51
+ *
38
52
  * ```
39
53
  *
40
54
  * @param GetDeploymentCommandInput - {@link GetDeploymentCommandInput}
@@ -58,6 +72,8 @@ export interface GetDeploymentCommandOutput extends Deployment, __MetadataBearer
58
72
  * @throws {@link UnauthorizedException} (client fault)
59
73
  * <p>The request is denied because the caller has insufficient permissions.</p>
60
74
  *
75
+ * @throws {@link APIGatewayServiceException}
76
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
61
77
  *
62
78
  */
63
79
  export declare class GetDeploymentCommand extends $Command<GetDeploymentCommandInput, GetDeploymentCommandOutput, APIGatewayClientResolvedConfig> {
@@ -33,6 +33,25 @@ export interface GetDeploymentsCommandOutput extends Deployments, __MetadataBear
33
33
  * };
34
34
  * const command = new GetDeploymentsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // Deployments
37
+ * // items: [ // ListOfDeployment
38
+ * // { // Deployment
39
+ * // id: "STRING_VALUE",
40
+ * // description: "STRING_VALUE",
41
+ * // createdDate: new Date("TIMESTAMP"),
42
+ * // apiSummary: { // PathToMapOfMethodSnapshot
43
+ * // "<keys>": { // MapOfMethodSnapshot
44
+ * // "<keys>": { // MethodSnapshot
45
+ * // authorizationType: "STRING_VALUE",
46
+ * // apiKeyRequired: true || false,
47
+ * // },
48
+ * // },
49
+ * // },
50
+ * // },
51
+ * // ],
52
+ * // position: "STRING_VALUE",
53
+ * // };
54
+ *
36
55
  * ```
37
56
  *
38
57
  * @param GetDeploymentsCommandInput - {@link GetDeploymentsCommandInput}
@@ -56,6 +75,8 @@ export interface GetDeploymentsCommandOutput extends Deployments, __MetadataBear
56
75
  * @throws {@link UnauthorizedException} (client fault)
57
76
  * <p>The request is denied because the caller has insufficient permissions.</p>
58
77
  *
78
+ * @throws {@link APIGatewayServiceException}
79
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
59
80
  *
60
81
  */
61
82
  export declare class GetDeploymentsCommand extends $Command<GetDeploymentsCommandInput, GetDeploymentsCommandOutput, APIGatewayClientResolvedConfig> {
@@ -32,6 +32,18 @@ export interface GetDocumentationPartCommandOutput extends DocumentationPart, __
32
32
  * };
33
33
  * const command = new GetDocumentationPartCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DocumentationPart
36
+ * // id: "STRING_VALUE",
37
+ * // location: { // DocumentationPartLocation
38
+ * // type: "API" || "AUTHORIZER" || "MODEL" || "RESOURCE" || "METHOD" || "PATH_PARAMETER" || "QUERY_PARAMETER" || "REQUEST_HEADER" || "REQUEST_BODY" || "RESPONSE" || "RESPONSE_HEADER" || "RESPONSE_BODY", // required
39
+ * // path: "STRING_VALUE",
40
+ * // method: "STRING_VALUE",
41
+ * // statusCode: "STRING_VALUE",
42
+ * // name: "STRING_VALUE",
43
+ * // },
44
+ * // properties: "STRING_VALUE",
45
+ * // };
46
+ *
35
47
  * ```
36
48
  *
37
49
  * @param GetDocumentationPartCommandInput - {@link GetDocumentationPartCommandInput}
@@ -52,6 +64,8 @@ export interface GetDocumentationPartCommandOutput extends DocumentationPart, __
52
64
  * @throws {@link UnauthorizedException} (client fault)
53
65
  * <p>The request is denied because the caller has insufficient permissions.</p>
54
66
  *
67
+ * @throws {@link APIGatewayServiceException}
68
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
55
69
  *
56
70
  */
57
71
  export declare class GetDocumentationPartCommand extends $Command<GetDocumentationPartCommandInput, GetDocumentationPartCommandOutput, APIGatewayClientResolvedConfig> {
@@ -37,6 +37,23 @@ export interface GetDocumentationPartsCommandOutput extends DocumentationParts,
37
37
  * };
38
38
  * const command = new GetDocumentationPartsCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // DocumentationParts
41
+ * // items: [ // ListOfDocumentationPart
42
+ * // { // DocumentationPart
43
+ * // id: "STRING_VALUE",
44
+ * // location: { // DocumentationPartLocation
45
+ * // type: "API" || "AUTHORIZER" || "MODEL" || "RESOURCE" || "METHOD" || "PATH_PARAMETER" || "QUERY_PARAMETER" || "REQUEST_HEADER" || "REQUEST_BODY" || "RESPONSE" || "RESPONSE_HEADER" || "RESPONSE_BODY", // required
46
+ * // path: "STRING_VALUE",
47
+ * // method: "STRING_VALUE",
48
+ * // statusCode: "STRING_VALUE",
49
+ * // name: "STRING_VALUE",
50
+ * // },
51
+ * // properties: "STRING_VALUE",
52
+ * // },
53
+ * // ],
54
+ * // position: "STRING_VALUE",
55
+ * // };
56
+ *
40
57
  * ```
41
58
  *
42
59
  * @param GetDocumentationPartsCommandInput - {@link GetDocumentationPartsCommandInput}
@@ -57,6 +74,8 @@ export interface GetDocumentationPartsCommandOutput extends DocumentationParts,
57
74
  * @throws {@link UnauthorizedException} (client fault)
58
75
  * <p>The request is denied because the caller has insufficient permissions.</p>
59
76
  *
77
+ * @throws {@link APIGatewayServiceException}
78
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
60
79
  *
61
80
  */
62
81
  export declare class GetDocumentationPartsCommand extends $Command<GetDocumentationPartsCommandInput, GetDocumentationPartsCommandOutput, APIGatewayClientResolvedConfig> {
@@ -32,6 +32,12 @@ export interface GetDocumentationVersionCommandOutput extends DocumentationVersi
32
32
  * };
33
33
  * const command = new GetDocumentationVersionCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DocumentationVersion
36
+ * // version: "STRING_VALUE",
37
+ * // createdDate: new Date("TIMESTAMP"),
38
+ * // description: "STRING_VALUE",
39
+ * // };
40
+ *
35
41
  * ```
36
42
  *
37
43
  * @param GetDocumentationVersionCommandInput - {@link GetDocumentationVersionCommandInput}
@@ -49,6 +55,8 @@ export interface GetDocumentationVersionCommandOutput extends DocumentationVersi
49
55
  * @throws {@link UnauthorizedException} (client fault)
50
56
  * <p>The request is denied because the caller has insufficient permissions.</p>
51
57
  *
58
+ * @throws {@link APIGatewayServiceException}
59
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
52
60
  *
53
61
  */
54
62
  export declare class GetDocumentationVersionCommand extends $Command<GetDocumentationVersionCommandInput, GetDocumentationVersionCommandOutput, APIGatewayClientResolvedConfig> {
@@ -33,6 +33,17 @@ export interface GetDocumentationVersionsCommandOutput extends DocumentationVers
33
33
  * };
34
34
  * const command = new GetDocumentationVersionsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DocumentationVersions
37
+ * // items: [ // ListOfDocumentationVersion
38
+ * // { // DocumentationVersion
39
+ * // version: "STRING_VALUE",
40
+ * // createdDate: new Date("TIMESTAMP"),
41
+ * // description: "STRING_VALUE",
42
+ * // },
43
+ * // ],
44
+ * // position: "STRING_VALUE",
45
+ * // };
46
+ *
36
47
  * ```
37
48
  *
38
49
  * @param GetDocumentationVersionsCommandInput - {@link GetDocumentationVersionsCommandInput}
@@ -53,6 +64,8 @@ export interface GetDocumentationVersionsCommandOutput extends DocumentationVers
53
64
  * @throws {@link UnauthorizedException} (client fault)
54
65
  * <p>The request is denied because the caller has insufficient permissions.</p>
55
66
  *
67
+ * @throws {@link APIGatewayServiceException}
68
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
56
69
  *
57
70
  */
58
71
  export declare class GetDocumentationVersionsCommand extends $Command<GetDocumentationVersionsCommandInput, GetDocumentationVersionsCommandOutput, APIGatewayClientResolvedConfig> {
@@ -31,6 +31,41 @@ export interface GetDomainNameCommandOutput extends DomainName, __MetadataBearer
31
31
  * };
32
32
  * const command = new GetDomainNameCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DomainName
35
+ * // domainName: "STRING_VALUE",
36
+ * // certificateName: "STRING_VALUE",
37
+ * // certificateArn: "STRING_VALUE",
38
+ * // certificateUploadDate: new Date("TIMESTAMP"),
39
+ * // regionalDomainName: "STRING_VALUE",
40
+ * // regionalHostedZoneId: "STRING_VALUE",
41
+ * // regionalCertificateName: "STRING_VALUE",
42
+ * // regionalCertificateArn: "STRING_VALUE",
43
+ * // distributionDomainName: "STRING_VALUE",
44
+ * // distributionHostedZoneId: "STRING_VALUE",
45
+ * // endpointConfiguration: { // EndpointConfiguration
46
+ * // types: [ // ListOfEndpointType
47
+ * // "REGIONAL" || "EDGE" || "PRIVATE",
48
+ * // ],
49
+ * // vpcEndpointIds: [ // ListOfString
50
+ * // "STRING_VALUE",
51
+ * // ],
52
+ * // },
53
+ * // domainNameStatus: "AVAILABLE" || "UPDATING" || "PENDING" || "PENDING_CERTIFICATE_REIMPORT" || "PENDING_OWNERSHIP_VERIFICATION",
54
+ * // domainNameStatusMessage: "STRING_VALUE",
55
+ * // securityPolicy: "TLS_1_0" || "TLS_1_2",
56
+ * // tags: { // MapOfStringToString
57
+ * // "<keys>": "STRING_VALUE",
58
+ * // },
59
+ * // mutualTlsAuthentication: { // MutualTlsAuthentication
60
+ * // truststoreUri: "STRING_VALUE",
61
+ * // truststoreVersion: "STRING_VALUE",
62
+ * // truststoreWarnings: [
63
+ * // "STRING_VALUE",
64
+ * // ],
65
+ * // },
66
+ * // ownershipVerificationCertificateArn: "STRING_VALUE",
67
+ * // };
68
+ *
34
69
  * ```
35
70
  *
36
71
  * @param GetDomainNameCommandInput - {@link GetDomainNameCommandInput}
@@ -51,6 +86,8 @@ export interface GetDomainNameCommandOutput extends DomainName, __MetadataBearer
51
86
  * @throws {@link UnauthorizedException} (client fault)
52
87
  * <p>The request is denied because the caller has insufficient permissions.</p>
53
88
  *
89
+ * @throws {@link APIGatewayServiceException}
90
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
54
91
  *
55
92
  */
56
93
  export declare class GetDomainNameCommand extends $Command<GetDomainNameCommandInput, GetDomainNameCommandOutput, APIGatewayClientResolvedConfig> {
@@ -32,6 +32,46 @@ export interface GetDomainNamesCommandOutput extends DomainNames, __MetadataBear
32
32
  * };
33
33
  * const command = new GetDomainNamesCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DomainNames
36
+ * // items: [ // ListOfDomainName
37
+ * // { // DomainName
38
+ * // domainName: "STRING_VALUE",
39
+ * // certificateName: "STRING_VALUE",
40
+ * // certificateArn: "STRING_VALUE",
41
+ * // certificateUploadDate: new Date("TIMESTAMP"),
42
+ * // regionalDomainName: "STRING_VALUE",
43
+ * // regionalHostedZoneId: "STRING_VALUE",
44
+ * // regionalCertificateName: "STRING_VALUE",
45
+ * // regionalCertificateArn: "STRING_VALUE",
46
+ * // distributionDomainName: "STRING_VALUE",
47
+ * // distributionHostedZoneId: "STRING_VALUE",
48
+ * // endpointConfiguration: { // EndpointConfiguration
49
+ * // types: [ // ListOfEndpointType
50
+ * // "REGIONAL" || "EDGE" || "PRIVATE",
51
+ * // ],
52
+ * // vpcEndpointIds: [ // ListOfString
53
+ * // "STRING_VALUE",
54
+ * // ],
55
+ * // },
56
+ * // domainNameStatus: "AVAILABLE" || "UPDATING" || "PENDING" || "PENDING_CERTIFICATE_REIMPORT" || "PENDING_OWNERSHIP_VERIFICATION",
57
+ * // domainNameStatusMessage: "STRING_VALUE",
58
+ * // securityPolicy: "TLS_1_0" || "TLS_1_2",
59
+ * // tags: { // MapOfStringToString
60
+ * // "<keys>": "STRING_VALUE",
61
+ * // },
62
+ * // mutualTlsAuthentication: { // MutualTlsAuthentication
63
+ * // truststoreUri: "STRING_VALUE",
64
+ * // truststoreVersion: "STRING_VALUE",
65
+ * // truststoreWarnings: [
66
+ * // "STRING_VALUE",
67
+ * // ],
68
+ * // },
69
+ * // ownershipVerificationCertificateArn: "STRING_VALUE",
70
+ * // },
71
+ * // ],
72
+ * // position: "STRING_VALUE",
73
+ * // };
74
+ *
35
75
  * ```
36
76
  *
37
77
  * @param GetDomainNamesCommandInput - {@link GetDomainNamesCommandInput}
@@ -52,6 +92,8 @@ export interface GetDomainNamesCommandOutput extends DomainNames, __MetadataBear
52
92
  * @throws {@link UnauthorizedException} (client fault)
53
93
  * <p>The request is denied because the caller has insufficient permissions.</p>
54
94
  *
95
+ * @throws {@link APIGatewayServiceException}
96
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
55
97
  *
56
98
  */
57
99
  export declare class GetDomainNamesCommand extends $Command<GetDomainNamesCommandInput, GetDomainNamesCommandOutput, APIGatewayClientResolvedConfig> {
@@ -37,6 +37,12 @@ export interface GetExportCommandOutput extends ExportResponse, __MetadataBearer
37
37
  * };
38
38
  * const command = new GetExportCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // ExportResponse
41
+ * // contentType: "STRING_VALUE",
42
+ * // contentDisposition: "STRING_VALUE",
43
+ * // body: "BLOB_VALUE",
44
+ * // };
45
+ *
40
46
  * ```
41
47
  *
42
48
  * @param GetExportCommandInput - {@link GetExportCommandInput}
@@ -63,6 +69,8 @@ export interface GetExportCommandOutput extends ExportResponse, __MetadataBearer
63
69
  * @throws {@link UnauthorizedException} (client fault)
64
70
  * <p>The request is denied because the caller has insufficient permissions.</p>
65
71
  *
72
+ * @throws {@link APIGatewayServiceException}
73
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
66
74
  *
67
75
  */
68
76
  export declare class GetExportCommand extends $Command<GetExportCommandInput, GetExportCommandOutput, APIGatewayClientResolvedConfig> {
@@ -32,6 +32,18 @@ export interface GetGatewayResponseCommandOutput extends GatewayResponse, __Meta
32
32
  * };
33
33
  * const command = new GetGatewayResponseCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GatewayResponse
36
+ * // 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",
37
+ * // statusCode: "STRING_VALUE",
38
+ * // responseParameters: { // MapOfStringToString
39
+ * // "<keys>": "STRING_VALUE",
40
+ * // },
41
+ * // responseTemplates: {
42
+ * // "<keys>": "STRING_VALUE",
43
+ * // },
44
+ * // defaultResponse: true || false,
45
+ * // };
46
+ *
35
47
  * ```
36
48
  *
37
49
  * @param GetGatewayResponseCommandInput - {@link GetGatewayResponseCommandInput}
@@ -52,6 +64,8 @@ export interface GetGatewayResponseCommandOutput extends GatewayResponse, __Meta
52
64
  * @throws {@link UnauthorizedException} (client fault)
53
65
  * <p>The request is denied because the caller has insufficient permissions.</p>
54
66
  *
67
+ * @throws {@link APIGatewayServiceException}
68
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
55
69
  *
56
70
  */
57
71
  export declare class GetGatewayResponseCommand extends $Command<GetGatewayResponseCommandInput, GetGatewayResponseCommandOutput, APIGatewayClientResolvedConfig> {
@@ -33,6 +33,23 @@ export interface GetGatewayResponsesCommandOutput extends GatewayResponses, __Me
33
33
  * };
34
34
  * const command = new GetGatewayResponsesCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // GatewayResponses
37
+ * // items: [ // ListOfGatewayResponse
38
+ * // { // GatewayResponse
39
+ * // 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",
40
+ * // statusCode: "STRING_VALUE",
41
+ * // responseParameters: { // MapOfStringToString
42
+ * // "<keys>": "STRING_VALUE",
43
+ * // },
44
+ * // responseTemplates: {
45
+ * // "<keys>": "STRING_VALUE",
46
+ * // },
47
+ * // defaultResponse: true || false,
48
+ * // },
49
+ * // ],
50
+ * // position: "STRING_VALUE",
51
+ * // };
52
+ *
36
53
  * ```
37
54
  *
38
55
  * @param GetGatewayResponsesCommandInput - {@link GetGatewayResponsesCommandInput}
@@ -53,6 +70,8 @@ export interface GetGatewayResponsesCommandOutput extends GatewayResponses, __Me
53
70
  * @throws {@link UnauthorizedException} (client fault)
54
71
  * <p>The request is denied because the caller has insufficient permissions.</p>
55
72
  *
73
+ * @throws {@link APIGatewayServiceException}
74
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
56
75
  *
57
76
  */
58
77
  export declare class GetGatewayResponsesCommand extends $Command<GetGatewayResponsesCommandInput, GetGatewayResponsesCommandOutput, APIGatewayClientResolvedConfig> {
@@ -33,6 +33,44 @@ export interface GetIntegrationCommandOutput extends Integration, __MetadataBear
33
33
  * };
34
34
  * const command = new GetIntegrationCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // Integration
37
+ * // type: "HTTP" || "AWS" || "MOCK" || "HTTP_PROXY" || "AWS_PROXY",
38
+ * // httpMethod: "STRING_VALUE",
39
+ * // uri: "STRING_VALUE",
40
+ * // connectionType: "INTERNET" || "VPC_LINK",
41
+ * // connectionId: "STRING_VALUE",
42
+ * // credentials: "STRING_VALUE",
43
+ * // requestParameters: { // MapOfStringToString
44
+ * // "<keys>": "STRING_VALUE",
45
+ * // },
46
+ * // requestTemplates: {
47
+ * // "<keys>": "STRING_VALUE",
48
+ * // },
49
+ * // passthroughBehavior: "STRING_VALUE",
50
+ * // contentHandling: "CONVERT_TO_BINARY" || "CONVERT_TO_TEXT",
51
+ * // timeoutInMillis: Number("int"),
52
+ * // cacheNamespace: "STRING_VALUE",
53
+ * // cacheKeyParameters: [ // ListOfString
54
+ * // "STRING_VALUE",
55
+ * // ],
56
+ * // integrationResponses: { // MapOfIntegrationResponse
57
+ * // "<keys>": { // IntegrationResponse
58
+ * // statusCode: "STRING_VALUE",
59
+ * // selectionPattern: "STRING_VALUE",
60
+ * // responseParameters: {
61
+ * // "<keys>": "STRING_VALUE",
62
+ * // },
63
+ * // responseTemplates: {
64
+ * // "<keys>": "STRING_VALUE",
65
+ * // },
66
+ * // contentHandling: "CONVERT_TO_BINARY" || "CONVERT_TO_TEXT",
67
+ * // },
68
+ * // },
69
+ * // tlsConfig: { // TlsConfig
70
+ * // insecureSkipVerification: true || false,
71
+ * // },
72
+ * // };
73
+ *
36
74
  * ```
37
75
  *
38
76
  * @param GetIntegrationCommandInput - {@link GetIntegrationCommandInput}
@@ -53,6 +91,8 @@ export interface GetIntegrationCommandOutput extends Integration, __MetadataBear
53
91
  * @throws {@link UnauthorizedException} (client fault)
54
92
  * <p>The request is denied because the caller has insufficient permissions.</p>
55
93
  *
94
+ * @throws {@link APIGatewayServiceException}
95
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
56
96
  *
57
97
  */
58
98
  export declare class GetIntegrationCommand extends $Command<GetIntegrationCommandInput, GetIntegrationCommandOutput, APIGatewayClientResolvedConfig> {
@@ -34,6 +34,18 @@ export interface GetIntegrationResponseCommandOutput extends IntegrationResponse
34
34
  * };
35
35
  * const command = new GetIntegrationResponseCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // IntegrationResponse
38
+ * // statusCode: "STRING_VALUE",
39
+ * // selectionPattern: "STRING_VALUE",
40
+ * // responseParameters: { // MapOfStringToString
41
+ * // "<keys>": "STRING_VALUE",
42
+ * // },
43
+ * // responseTemplates: {
44
+ * // "<keys>": "STRING_VALUE",
45
+ * // },
46
+ * // contentHandling: "CONVERT_TO_BINARY" || "CONVERT_TO_TEXT",
47
+ * // };
48
+ *
37
49
  * ```
38
50
  *
39
51
  * @param GetIntegrationResponseCommandInput - {@link GetIntegrationResponseCommandInput}
@@ -54,6 +66,8 @@ export interface GetIntegrationResponseCommandOutput extends IntegrationResponse
54
66
  * @throws {@link UnauthorizedException} (client fault)
55
67
  * <p>The request is denied because the caller has insufficient permissions.</p>
56
68
  *
69
+ * @throws {@link APIGatewayServiceException}
70
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
57
71
  *
58
72
  */
59
73
  export declare class GetIntegrationResponseCommand extends $Command<GetIntegrationResponseCommandInput, GetIntegrationResponseCommandOutput, APIGatewayClientResolvedConfig> {
@@ -33,6 +33,64 @@ export interface GetMethodCommandOutput extends Method, __MetadataBearer {
33
33
  * };
34
34
  * const command = new GetMethodCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // Method
37
+ * // httpMethod: "STRING_VALUE",
38
+ * // authorizationType: "STRING_VALUE",
39
+ * // authorizerId: "STRING_VALUE",
40
+ * // apiKeyRequired: true || false,
41
+ * // requestValidatorId: "STRING_VALUE",
42
+ * // operationName: "STRING_VALUE",
43
+ * // requestParameters: { // MapOfStringToBoolean
44
+ * // "<keys>": true || false,
45
+ * // },
46
+ * // requestModels: { // MapOfStringToString
47
+ * // "<keys>": "STRING_VALUE",
48
+ * // },
49
+ * // methodResponses: { // MapOfMethodResponse
50
+ * // "<keys>": { // MethodResponse
51
+ * // statusCode: "STRING_VALUE",
52
+ * // responseParameters: {
53
+ * // "<keys>": true || false,
54
+ * // },
55
+ * // responseModels: {
56
+ * // "<keys>": "STRING_VALUE",
57
+ * // },
58
+ * // },
59
+ * // },
60
+ * // methodIntegration: { // Integration
61
+ * // type: "HTTP" || "AWS" || "MOCK" || "HTTP_PROXY" || "AWS_PROXY",
62
+ * // httpMethod: "STRING_VALUE",
63
+ * // uri: "STRING_VALUE",
64
+ * // connectionType: "INTERNET" || "VPC_LINK",
65
+ * // connectionId: "STRING_VALUE",
66
+ * // credentials: "STRING_VALUE",
67
+ * // requestParameters: "<MapOfStringToString>",
68
+ * // requestTemplates: "<MapOfStringToString>",
69
+ * // passthroughBehavior: "STRING_VALUE",
70
+ * // contentHandling: "CONVERT_TO_BINARY" || "CONVERT_TO_TEXT",
71
+ * // timeoutInMillis: Number("int"),
72
+ * // cacheNamespace: "STRING_VALUE",
73
+ * // cacheKeyParameters: [ // ListOfString
74
+ * // "STRING_VALUE",
75
+ * // ],
76
+ * // integrationResponses: { // MapOfIntegrationResponse
77
+ * // "<keys>": { // IntegrationResponse
78
+ * // statusCode: "STRING_VALUE",
79
+ * // selectionPattern: "STRING_VALUE",
80
+ * // responseParameters: "<MapOfStringToString>",
81
+ * // responseTemplates: "<MapOfStringToString>",
82
+ * // contentHandling: "CONVERT_TO_BINARY" || "CONVERT_TO_TEXT",
83
+ * // },
84
+ * // },
85
+ * // tlsConfig: { // TlsConfig
86
+ * // insecureSkipVerification: true || false,
87
+ * // },
88
+ * // },
89
+ * // authorizationScopes: [
90
+ * // "STRING_VALUE",
91
+ * // ],
92
+ * // };
93
+ *
36
94
  * ```
37
95
  *
38
96
  * @param GetMethodCommandInput - {@link GetMethodCommandInput}
@@ -50,6 +108,8 @@ export interface GetMethodCommandOutput extends Method, __MetadataBearer {
50
108
  * @throws {@link UnauthorizedException} (client fault)
51
109
  * <p>The request is denied because the caller has insufficient permissions.</p>
52
110
  *
111
+ * @throws {@link APIGatewayServiceException}
112
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
53
113
  *
54
114
  */
55
115
  export declare class GetMethodCommand extends $Command<GetMethodCommandInput, GetMethodCommandOutput, APIGatewayClientResolvedConfig> {
@@ -34,6 +34,16 @@ export interface GetMethodResponseCommandOutput extends MethodResponse, __Metada
34
34
  * };
35
35
  * const command = new GetMethodResponseCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // MethodResponse
38
+ * // statusCode: "STRING_VALUE",
39
+ * // responseParameters: { // MapOfStringToBoolean
40
+ * // "<keys>": true || false,
41
+ * // },
42
+ * // responseModels: { // MapOfStringToString
43
+ * // "<keys>": "STRING_VALUE",
44
+ * // },
45
+ * // };
46
+ *
37
47
  * ```
38
48
  *
39
49
  * @param GetMethodResponseCommandInput - {@link GetMethodResponseCommandInput}
@@ -51,6 +61,8 @@ export interface GetMethodResponseCommandOutput extends MethodResponse, __Metada
51
61
  * @throws {@link UnauthorizedException} (client fault)
52
62
  * <p>The request is denied because the caller has insufficient permissions.</p>
53
63
  *
64
+ * @throws {@link APIGatewayServiceException}
65
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
54
66
  *
55
67
  */
56
68
  export declare class GetMethodResponseCommand extends $Command<GetMethodResponseCommandInput, GetMethodResponseCommandOutput, APIGatewayClientResolvedConfig> {
@@ -33,6 +33,14 @@ export interface GetModelCommandOutput extends Model, __MetadataBearer {
33
33
  * };
34
34
  * const command = new GetModelCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // Model
37
+ * // id: "STRING_VALUE",
38
+ * // name: "STRING_VALUE",
39
+ * // description: "STRING_VALUE",
40
+ * // schema: "STRING_VALUE",
41
+ * // contentType: "STRING_VALUE",
42
+ * // };
43
+ *
36
44
  * ```
37
45
  *
38
46
  * @param GetModelCommandInput - {@link GetModelCommandInput}
@@ -53,6 +61,8 @@ export interface GetModelCommandOutput extends Model, __MetadataBearer {
53
61
  * @throws {@link UnauthorizedException} (client fault)
54
62
  * <p>The request is denied because the caller has insufficient permissions.</p>
55
63
  *
64
+ * @throws {@link APIGatewayServiceException}
65
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
56
66
  *
57
67
  */
58
68
  export declare class GetModelCommand extends $Command<GetModelCommandInput, GetModelCommandOutput, APIGatewayClientResolvedConfig> {
@@ -32,6 +32,10 @@ export interface GetModelTemplateCommandOutput extends Template, __MetadataBeare
32
32
  * };
33
33
  * const command = new GetModelTemplateCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // Template
36
+ * // value: "STRING_VALUE",
37
+ * // };
38
+ *
35
39
  * ```
36
40
  *
37
41
  * @param GetModelTemplateCommandInput - {@link GetModelTemplateCommandInput}
@@ -52,6 +56,8 @@ export interface GetModelTemplateCommandOutput extends Template, __MetadataBeare
52
56
  * @throws {@link UnauthorizedException} (client fault)
53
57
  * <p>The request is denied because the caller has insufficient permissions.</p>
54
58
  *
59
+ * @throws {@link APIGatewayServiceException}
60
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
55
61
  *
56
62
  */
57
63
  export declare class GetModelTemplateCommand extends $Command<GetModelTemplateCommandInput, GetModelTemplateCommandOutput, APIGatewayClientResolvedConfig> {
@@ -33,6 +33,19 @@ export interface GetModelsCommandOutput extends Models, __MetadataBearer {
33
33
  * };
34
34
  * const command = new GetModelsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // Models
37
+ * // items: [ // ListOfModel
38
+ * // { // Model
39
+ * // id: "STRING_VALUE",
40
+ * // name: "STRING_VALUE",
41
+ * // description: "STRING_VALUE",
42
+ * // schema: "STRING_VALUE",
43
+ * // contentType: "STRING_VALUE",
44
+ * // },
45
+ * // ],
46
+ * // position: "STRING_VALUE",
47
+ * // };
48
+ *
36
49
  * ```
37
50
  *
38
51
  * @param GetModelsCommandInput - {@link GetModelsCommandInput}
@@ -53,6 +66,8 @@ export interface GetModelsCommandOutput extends Models, __MetadataBearer {
53
66
  * @throws {@link UnauthorizedException} (client fault)
54
67
  * <p>The request is denied because the caller has insufficient permissions.</p>
55
68
  *
69
+ * @throws {@link APIGatewayServiceException}
70
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
56
71
  *
57
72
  */
58
73
  export declare class GetModelsCommand extends $Command<GetModelsCommandInput, GetModelsCommandOutput, APIGatewayClientResolvedConfig> {
@@ -32,6 +32,13 @@ export interface GetRequestValidatorCommandOutput extends RequestValidator, __Me
32
32
  * };
33
33
  * const command = new GetRequestValidatorCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // RequestValidator
36
+ * // id: "STRING_VALUE",
37
+ * // name: "STRING_VALUE",
38
+ * // validateRequestBody: true || false,
39
+ * // validateRequestParameters: true || false,
40
+ * // };
41
+ *
35
42
  * ```
36
43
  *
37
44
  * @param GetRequestValidatorCommandInput - {@link GetRequestValidatorCommandInput}
@@ -52,6 +59,8 @@ export interface GetRequestValidatorCommandOutput extends RequestValidator, __Me
52
59
  * @throws {@link UnauthorizedException} (client fault)
53
60
  * <p>The request is denied because the caller has insufficient permissions.</p>
54
61
  *
62
+ * @throws {@link APIGatewayServiceException}
63
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
55
64
  *
56
65
  */
57
66
  export declare class GetRequestValidatorCommand extends $Command<GetRequestValidatorCommandInput, GetRequestValidatorCommandOutput, APIGatewayClientResolvedConfig> {