@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
@@ -33,6 +33,18 @@ export interface GetRequestValidatorsCommandOutput extends RequestValidators, __
33
33
  * };
34
34
  * const command = new GetRequestValidatorsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // RequestValidators
37
+ * // items: [ // ListOfRequestValidator
38
+ * // { // RequestValidator
39
+ * // id: "STRING_VALUE",
40
+ * // name: "STRING_VALUE",
41
+ * // validateRequestBody: true || false,
42
+ * // validateRequestParameters: true || false,
43
+ * // },
44
+ * // ],
45
+ * // position: "STRING_VALUE",
46
+ * // };
47
+ *
36
48
  * ```
37
49
  *
38
50
  * @param GetRequestValidatorsCommandInput - {@link GetRequestValidatorsCommandInput}
@@ -53,6 +65,8 @@ export interface GetRequestValidatorsCommandOutput extends RequestValidators, __
53
65
  * @throws {@link UnauthorizedException} (client fault)
54
66
  * <p>The request is denied because the caller has insufficient permissions.</p>
55
67
  *
68
+ * @throws {@link APIGatewayServiceException}
69
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
56
70
  *
57
71
  */
58
72
  export declare class GetRequestValidatorsCommand extends $Command<GetRequestValidatorsCommandInput, GetRequestValidatorsCommandOutput, APIGatewayClientResolvedConfig> {
@@ -35,6 +35,72 @@ export interface GetResourceCommandOutput extends Resource, __MetadataBearer {
35
35
  * };
36
36
  * const command = new GetResourceCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // Resource
39
+ * // id: "STRING_VALUE",
40
+ * // parentId: "STRING_VALUE",
41
+ * // pathPart: "STRING_VALUE",
42
+ * // path: "STRING_VALUE",
43
+ * // resourceMethods: { // MapOfMethod
44
+ * // "<keys>": { // 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
+ * // },
102
+ * // };
103
+ *
38
104
  * ```
39
105
  *
40
106
  * @param GetResourceCommandInput - {@link GetResourceCommandInput}
@@ -52,6 +118,8 @@ export interface GetResourceCommandOutput extends Resource, __MetadataBearer {
52
118
  * @throws {@link UnauthorizedException} (client fault)
53
119
  * <p>The request is denied because the caller has insufficient permissions.</p>
54
120
  *
121
+ * @throws {@link APIGatewayServiceException}
122
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
55
123
  *
56
124
  */
57
125
  export declare class GetResourceCommand extends $Command<GetResourceCommandInput, GetResourceCommandOutput, APIGatewayClientResolvedConfig> {
@@ -36,6 +36,77 @@ export interface GetResourcesCommandOutput extends Resources, __MetadataBearer {
36
36
  * };
37
37
  * const command = new GetResourcesCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // Resources
40
+ * // items: [ // ListOfResource
41
+ * // { // Resource
42
+ * // id: "STRING_VALUE",
43
+ * // parentId: "STRING_VALUE",
44
+ * // pathPart: "STRING_VALUE",
45
+ * // path: "STRING_VALUE",
46
+ * // resourceMethods: { // MapOfMethod
47
+ * // "<keys>": { // Method
48
+ * // httpMethod: "STRING_VALUE",
49
+ * // authorizationType: "STRING_VALUE",
50
+ * // authorizerId: "STRING_VALUE",
51
+ * // apiKeyRequired: true || false,
52
+ * // requestValidatorId: "STRING_VALUE",
53
+ * // operationName: "STRING_VALUE",
54
+ * // requestParameters: { // MapOfStringToBoolean
55
+ * // "<keys>": true || false,
56
+ * // },
57
+ * // requestModels: { // MapOfStringToString
58
+ * // "<keys>": "STRING_VALUE",
59
+ * // },
60
+ * // methodResponses: { // MapOfMethodResponse
61
+ * // "<keys>": { // MethodResponse
62
+ * // statusCode: "STRING_VALUE",
63
+ * // responseParameters: {
64
+ * // "<keys>": true || false,
65
+ * // },
66
+ * // responseModels: {
67
+ * // "<keys>": "STRING_VALUE",
68
+ * // },
69
+ * // },
70
+ * // },
71
+ * // methodIntegration: { // Integration
72
+ * // type: "HTTP" || "AWS" || "MOCK" || "HTTP_PROXY" || "AWS_PROXY",
73
+ * // httpMethod: "STRING_VALUE",
74
+ * // uri: "STRING_VALUE",
75
+ * // connectionType: "INTERNET" || "VPC_LINK",
76
+ * // connectionId: "STRING_VALUE",
77
+ * // credentials: "STRING_VALUE",
78
+ * // requestParameters: "<MapOfStringToString>",
79
+ * // requestTemplates: "<MapOfStringToString>",
80
+ * // passthroughBehavior: "STRING_VALUE",
81
+ * // contentHandling: "CONVERT_TO_BINARY" || "CONVERT_TO_TEXT",
82
+ * // timeoutInMillis: Number("int"),
83
+ * // cacheNamespace: "STRING_VALUE",
84
+ * // cacheKeyParameters: [ // ListOfString
85
+ * // "STRING_VALUE",
86
+ * // ],
87
+ * // integrationResponses: { // MapOfIntegrationResponse
88
+ * // "<keys>": { // IntegrationResponse
89
+ * // statusCode: "STRING_VALUE",
90
+ * // selectionPattern: "STRING_VALUE",
91
+ * // responseParameters: "<MapOfStringToString>",
92
+ * // responseTemplates: "<MapOfStringToString>",
93
+ * // contentHandling: "CONVERT_TO_BINARY" || "CONVERT_TO_TEXT",
94
+ * // },
95
+ * // },
96
+ * // tlsConfig: { // TlsConfig
97
+ * // insecureSkipVerification: true || false,
98
+ * // },
99
+ * // },
100
+ * // authorizationScopes: [
101
+ * // "STRING_VALUE",
102
+ * // ],
103
+ * // },
104
+ * // },
105
+ * // },
106
+ * // ],
107
+ * // position: "STRING_VALUE",
108
+ * // };
109
+ *
39
110
  * ```
40
111
  *
41
112
  * @param GetResourcesCommandInput - {@link GetResourcesCommandInput}
@@ -56,6 +127,8 @@ export interface GetResourcesCommandOutput extends Resources, __MetadataBearer {
56
127
  * @throws {@link UnauthorizedException} (client fault)
57
128
  * <p>The request is denied because the caller has insufficient permissions.</p>
58
129
  *
130
+ * @throws {@link APIGatewayServiceException}
131
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
59
132
  *
60
133
  */
61
134
  export declare class GetResourcesCommand extends $Command<GetResourcesCommandInput, GetResourcesCommandOutput, APIGatewayClientResolvedConfig> {
@@ -31,6 +31,35 @@ export interface GetRestApiCommandOutput extends RestApi, __MetadataBearer {
31
31
  * };
32
32
  * const command = new GetRestApiCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // RestApi
35
+ * // id: "STRING_VALUE",
36
+ * // name: "STRING_VALUE",
37
+ * // description: "STRING_VALUE",
38
+ * // createdDate: new Date("TIMESTAMP"),
39
+ * // version: "STRING_VALUE",
40
+ * // warnings: [ // ListOfString
41
+ * // "STRING_VALUE",
42
+ * // ],
43
+ * // binaryMediaTypes: [
44
+ * // "STRING_VALUE",
45
+ * // ],
46
+ * // minimumCompressionSize: Number("int"),
47
+ * // apiKeySource: "HEADER" || "AUTHORIZER",
48
+ * // endpointConfiguration: { // EndpointConfiguration
49
+ * // types: [ // ListOfEndpointType
50
+ * // "REGIONAL" || "EDGE" || "PRIVATE",
51
+ * // ],
52
+ * // vpcEndpointIds: [
53
+ * // "STRING_VALUE",
54
+ * // ],
55
+ * // },
56
+ * // policy: "STRING_VALUE",
57
+ * // tags: { // MapOfStringToString
58
+ * // "<keys>": "STRING_VALUE",
59
+ * // },
60
+ * // disableExecuteApiEndpoint: true || false,
61
+ * // };
62
+ *
34
63
  * ```
35
64
  *
36
65
  * @param GetRestApiCommandInput - {@link GetRestApiCommandInput}
@@ -51,6 +80,8 @@ export interface GetRestApiCommandOutput extends RestApi, __MetadataBearer {
51
80
  * @throws {@link UnauthorizedException} (client fault)
52
81
  * <p>The request is denied because the caller has insufficient permissions.</p>
53
82
  *
83
+ * @throws {@link APIGatewayServiceException}
84
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
54
85
  *
55
86
  */
56
87
  export declare class GetRestApiCommand extends $Command<GetRestApiCommandInput, GetRestApiCommandOutput, APIGatewayClientResolvedConfig> {
@@ -32,6 +32,40 @@ export interface GetRestApisCommandOutput extends RestApis, __MetadataBearer {
32
32
  * };
33
33
  * const command = new GetRestApisCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // RestApis
36
+ * // items: [ // ListOfRestApi
37
+ * // { // RestApi
38
+ * // id: "STRING_VALUE",
39
+ * // name: "STRING_VALUE",
40
+ * // description: "STRING_VALUE",
41
+ * // createdDate: new Date("TIMESTAMP"),
42
+ * // version: "STRING_VALUE",
43
+ * // warnings: [ // ListOfString
44
+ * // "STRING_VALUE",
45
+ * // ],
46
+ * // binaryMediaTypes: [
47
+ * // "STRING_VALUE",
48
+ * // ],
49
+ * // minimumCompressionSize: Number("int"),
50
+ * // apiKeySource: "HEADER" || "AUTHORIZER",
51
+ * // endpointConfiguration: { // EndpointConfiguration
52
+ * // types: [ // ListOfEndpointType
53
+ * // "REGIONAL" || "EDGE" || "PRIVATE",
54
+ * // ],
55
+ * // vpcEndpointIds: [
56
+ * // "STRING_VALUE",
57
+ * // ],
58
+ * // },
59
+ * // policy: "STRING_VALUE",
60
+ * // tags: { // MapOfStringToString
61
+ * // "<keys>": "STRING_VALUE",
62
+ * // },
63
+ * // disableExecuteApiEndpoint: true || false,
64
+ * // },
65
+ * // ],
66
+ * // position: "STRING_VALUE",
67
+ * // };
68
+ *
35
69
  * ```
36
70
  *
37
71
  * @param GetRestApisCommandInput - {@link GetRestApisCommandInput}
@@ -52,6 +86,8 @@ export interface GetRestApisCommandOutput extends RestApis, __MetadataBearer {
52
86
  * @throws {@link UnauthorizedException} (client fault)
53
87
  * <p>The request is denied because the caller has insufficient permissions.</p>
54
88
  *
89
+ * @throws {@link APIGatewayServiceException}
90
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
55
91
  *
56
92
  */
57
93
  export declare class GetRestApisCommand extends $Command<GetRestApisCommandInput, GetRestApisCommandOutput, APIGatewayClientResolvedConfig> {
@@ -36,6 +36,12 @@ export interface GetSdkCommandOutput extends SdkResponse, __MetadataBearer {
36
36
  * };
37
37
  * const command = new GetSdkCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // SdkResponse
40
+ * // contentType: "STRING_VALUE",
41
+ * // contentDisposition: "STRING_VALUE",
42
+ * // body: "BLOB_VALUE",
43
+ * // };
44
+ *
39
45
  * ```
40
46
  *
41
47
  * @param GetSdkCommandInput - {@link GetSdkCommandInput}
@@ -62,6 +68,8 @@ export interface GetSdkCommandOutput extends SdkResponse, __MetadataBearer {
62
68
  * @throws {@link UnauthorizedException} (client fault)
63
69
  * <p>The request is denied because the caller has insufficient permissions.</p>
64
70
  *
71
+ * @throws {@link APIGatewayServiceException}
72
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
65
73
  *
66
74
  */
67
75
  export declare class GetSdkCommand extends $Command<GetSdkCommandInput, GetSdkCommandOutput, APIGatewayClientResolvedConfig> {
@@ -31,6 +31,21 @@ export interface GetSdkTypeCommandOutput extends SdkType, __MetadataBearer {
31
31
  * };
32
32
  * const command = new GetSdkTypeCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // SdkType
35
+ * // id: "STRING_VALUE",
36
+ * // friendlyName: "STRING_VALUE",
37
+ * // description: "STRING_VALUE",
38
+ * // configurationProperties: [ // ListOfSdkConfigurationProperty
39
+ * // { // SdkConfigurationProperty
40
+ * // name: "STRING_VALUE",
41
+ * // friendlyName: "STRING_VALUE",
42
+ * // description: "STRING_VALUE",
43
+ * // required: true || false,
44
+ * // defaultValue: "STRING_VALUE",
45
+ * // },
46
+ * // ],
47
+ * // };
48
+ *
34
49
  * ```
35
50
  *
36
51
  * @param GetSdkTypeCommandInput - {@link GetSdkTypeCommandInput}
@@ -51,6 +66,8 @@ export interface GetSdkTypeCommandOutput extends SdkType, __MetadataBearer {
51
66
  * @throws {@link UnauthorizedException} (client fault)
52
67
  * <p>The request is denied because the caller has insufficient permissions.</p>
53
68
  *
69
+ * @throws {@link APIGatewayServiceException}
70
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
54
71
  *
55
72
  */
56
73
  export declare class GetSdkTypeCommand extends $Command<GetSdkTypeCommandInput, GetSdkTypeCommandOutput, APIGatewayClientResolvedConfig> {
@@ -32,6 +32,25 @@ export interface GetSdkTypesCommandOutput extends SdkTypes, __MetadataBearer {
32
32
  * };
33
33
  * const command = new GetSdkTypesCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // SdkTypes
36
+ * // items: [ // ListOfSdkType
37
+ * // { // SdkType
38
+ * // id: "STRING_VALUE",
39
+ * // friendlyName: "STRING_VALUE",
40
+ * // description: "STRING_VALUE",
41
+ * // configurationProperties: [ // ListOfSdkConfigurationProperty
42
+ * // { // SdkConfigurationProperty
43
+ * // name: "STRING_VALUE",
44
+ * // friendlyName: "STRING_VALUE",
45
+ * // description: "STRING_VALUE",
46
+ * // required: true || false,
47
+ * // defaultValue: "STRING_VALUE",
48
+ * // },
49
+ * // ],
50
+ * // },
51
+ * // ],
52
+ * // };
53
+ *
35
54
  * ```
36
55
  *
37
56
  * @param GetSdkTypesCommandInput - {@link GetSdkTypesCommandInput}
@@ -52,6 +71,8 @@ export interface GetSdkTypesCommandOutput extends SdkTypes, __MetadataBearer {
52
71
  * @throws {@link UnauthorizedException} (client fault)
53
72
  * <p>The request is denied because the caller has insufficient permissions.</p>
54
73
  *
74
+ * @throws {@link APIGatewayServiceException}
75
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
55
76
  *
56
77
  */
57
78
  export declare class GetSdkTypesCommand extends $Command<GetSdkTypesCommandInput, GetSdkTypesCommandOutput, APIGatewayClientResolvedConfig> {
@@ -32,6 +32,53 @@ export interface GetStageCommandOutput extends Stage, __MetadataBearer {
32
32
  * };
33
33
  * const command = new GetStageCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // Stage
36
+ * // deploymentId: "STRING_VALUE",
37
+ * // clientCertificateId: "STRING_VALUE",
38
+ * // stageName: "STRING_VALUE",
39
+ * // description: "STRING_VALUE",
40
+ * // cacheClusterEnabled: true || false,
41
+ * // cacheClusterSize: "0.5" || "1.6" || "6.1" || "13.5" || "28.4" || "58.2" || "118" || "237",
42
+ * // cacheClusterStatus: "CREATE_IN_PROGRESS" || "AVAILABLE" || "DELETE_IN_PROGRESS" || "NOT_AVAILABLE" || "FLUSH_IN_PROGRESS",
43
+ * // methodSettings: { // MapOfMethodSettings
44
+ * // "<keys>": { // MethodSetting
45
+ * // metricsEnabled: true || false,
46
+ * // loggingLevel: "STRING_VALUE",
47
+ * // dataTraceEnabled: true || false,
48
+ * // throttlingBurstLimit: Number("int"),
49
+ * // throttlingRateLimit: Number("double"),
50
+ * // cachingEnabled: true || false,
51
+ * // cacheTtlInSeconds: Number("int"),
52
+ * // cacheDataEncrypted: true || false,
53
+ * // requireAuthorizationForCacheControl: true || false,
54
+ * // unauthorizedCacheControlHeaderStrategy: "FAIL_WITH_403" || "SUCCEED_WITH_RESPONSE_HEADER" || "SUCCEED_WITHOUT_RESPONSE_HEADER",
55
+ * // },
56
+ * // },
57
+ * // variables: { // MapOfStringToString
58
+ * // "<keys>": "STRING_VALUE",
59
+ * // },
60
+ * // documentationVersion: "STRING_VALUE",
61
+ * // accessLogSettings: { // AccessLogSettings
62
+ * // format: "STRING_VALUE",
63
+ * // destinationArn: "STRING_VALUE",
64
+ * // },
65
+ * // canarySettings: { // CanarySettings
66
+ * // percentTraffic: Number("double"),
67
+ * // deploymentId: "STRING_VALUE",
68
+ * // stageVariableOverrides: {
69
+ * // "<keys>": "STRING_VALUE",
70
+ * // },
71
+ * // useStageCache: true || false,
72
+ * // },
73
+ * // tracingEnabled: true || false,
74
+ * // webAclArn: "STRING_VALUE",
75
+ * // tags: {
76
+ * // "<keys>": "STRING_VALUE",
77
+ * // },
78
+ * // createdDate: new Date("TIMESTAMP"),
79
+ * // lastUpdatedDate: new Date("TIMESTAMP"),
80
+ * // };
81
+ *
35
82
  * ```
36
83
  *
37
84
  * @param GetStageCommandInput - {@link GetStageCommandInput}
@@ -58,6 +105,8 @@ export interface GetStageCommandOutput extends Stage, __MetadataBearer {
58
105
  * @throws {@link UnauthorizedException} (client fault)
59
106
  * <p>The request is denied because the caller has insufficient permissions.</p>
60
107
  *
108
+ * @throws {@link APIGatewayServiceException}
109
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
61
110
  *
62
111
  */
63
112
  export declare class GetStageCommand extends $Command<GetStageCommandInput, GetStageCommandOutput, APIGatewayClientResolvedConfig> {
@@ -32,6 +32,57 @@ export interface GetStagesCommandOutput extends Stages, __MetadataBearer {
32
32
  * };
33
33
  * const command = new GetStagesCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // Stages
36
+ * // item: [ // ListOfStage
37
+ * // { // Stage
38
+ * // deploymentId: "STRING_VALUE",
39
+ * // clientCertificateId: "STRING_VALUE",
40
+ * // stageName: "STRING_VALUE",
41
+ * // description: "STRING_VALUE",
42
+ * // cacheClusterEnabled: true || false,
43
+ * // cacheClusterSize: "0.5" || "1.6" || "6.1" || "13.5" || "28.4" || "58.2" || "118" || "237",
44
+ * // cacheClusterStatus: "CREATE_IN_PROGRESS" || "AVAILABLE" || "DELETE_IN_PROGRESS" || "NOT_AVAILABLE" || "FLUSH_IN_PROGRESS",
45
+ * // methodSettings: { // MapOfMethodSettings
46
+ * // "<keys>": { // MethodSetting
47
+ * // metricsEnabled: true || false,
48
+ * // loggingLevel: "STRING_VALUE",
49
+ * // dataTraceEnabled: true || false,
50
+ * // throttlingBurstLimit: Number("int"),
51
+ * // throttlingRateLimit: Number("double"),
52
+ * // cachingEnabled: true || false,
53
+ * // cacheTtlInSeconds: Number("int"),
54
+ * // cacheDataEncrypted: true || false,
55
+ * // requireAuthorizationForCacheControl: true || false,
56
+ * // unauthorizedCacheControlHeaderStrategy: "FAIL_WITH_403" || "SUCCEED_WITH_RESPONSE_HEADER" || "SUCCEED_WITHOUT_RESPONSE_HEADER",
57
+ * // },
58
+ * // },
59
+ * // variables: { // MapOfStringToString
60
+ * // "<keys>": "STRING_VALUE",
61
+ * // },
62
+ * // documentationVersion: "STRING_VALUE",
63
+ * // accessLogSettings: { // AccessLogSettings
64
+ * // format: "STRING_VALUE",
65
+ * // destinationArn: "STRING_VALUE",
66
+ * // },
67
+ * // canarySettings: { // CanarySettings
68
+ * // percentTraffic: Number("double"),
69
+ * // deploymentId: "STRING_VALUE",
70
+ * // stageVariableOverrides: {
71
+ * // "<keys>": "STRING_VALUE",
72
+ * // },
73
+ * // useStageCache: true || false,
74
+ * // },
75
+ * // tracingEnabled: true || false,
76
+ * // webAclArn: "STRING_VALUE",
77
+ * // tags: {
78
+ * // "<keys>": "STRING_VALUE",
79
+ * // },
80
+ * // createdDate: new Date("TIMESTAMP"),
81
+ * // lastUpdatedDate: new Date("TIMESTAMP"),
82
+ * // },
83
+ * // ],
84
+ * // };
85
+ *
35
86
  * ```
36
87
  *
37
88
  * @param GetStagesCommandInput - {@link GetStagesCommandInput}
@@ -58,6 +109,8 @@ export interface GetStagesCommandOutput extends Stages, __MetadataBearer {
58
109
  * @throws {@link UnauthorizedException} (client fault)
59
110
  * <p>The request is denied because the caller has insufficient permissions.</p>
60
111
  *
112
+ * @throws {@link APIGatewayServiceException}
113
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
61
114
  *
62
115
  */
63
116
  export declare class GetStagesCommand extends $Command<GetStagesCommandInput, GetStagesCommandOutput, APIGatewayClientResolvedConfig> {
@@ -33,6 +33,12 @@ export interface GetTagsCommandOutput extends Tags, __MetadataBearer {
33
33
  * };
34
34
  * const command = new GetTagsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // Tags
37
+ * // tags: { // MapOfStringToString
38
+ * // "<keys>": "STRING_VALUE",
39
+ * // },
40
+ * // };
41
+ *
36
42
  * ```
37
43
  *
38
44
  * @param GetTagsCommandInput - {@link GetTagsCommandInput}
@@ -53,6 +59,8 @@ export interface GetTagsCommandOutput extends Tags, __MetadataBearer {
53
59
  * @throws {@link UnauthorizedException} (client fault)
54
60
  * <p>The request is denied because the caller has insufficient permissions.</p>
55
61
  *
62
+ * @throws {@link APIGatewayServiceException}
63
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
56
64
  *
57
65
  */
58
66
  export declare class GetTagsCommand extends $Command<GetTagsCommandInput, GetTagsCommandOutput, APIGatewayClientResolvedConfig> {
@@ -36,6 +36,20 @@ export interface GetUsageCommandOutput extends Usage, __MetadataBearer {
36
36
  * };
37
37
  * const command = new GetUsageCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // Usage
40
+ * // usagePlanId: "STRING_VALUE",
41
+ * // startDate: "STRING_VALUE",
42
+ * // endDate: "STRING_VALUE",
43
+ * // items: { // MapOfKeyUsages
44
+ * // "<keys>": [ // ListOfUsage
45
+ * // [ // ListOfLong
46
+ * // Number("long"),
47
+ * // ],
48
+ * // ],
49
+ * // },
50
+ * // position: "STRING_VALUE",
51
+ * // };
52
+ *
39
53
  * ```
40
54
  *
41
55
  * @param GetUsageCommandInput - {@link GetUsageCommandInput}
@@ -56,6 +70,8 @@ export interface GetUsageCommandOutput extends Usage, __MetadataBearer {
56
70
  * @throws {@link UnauthorizedException} (client fault)
57
71
  * <p>The request is denied because the caller has insufficient permissions.</p>
58
72
  *
73
+ * @throws {@link APIGatewayServiceException}
74
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
59
75
  *
60
76
  */
61
77
  export declare class GetUsageCommand extends $Command<GetUsageCommandInput, GetUsageCommandOutput, APIGatewayClientResolvedConfig> {
@@ -31,6 +31,37 @@ export interface GetUsagePlanCommandOutput extends UsagePlan, __MetadataBearer {
31
31
  * };
32
32
  * const command = new GetUsagePlanCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // UsagePlan
35
+ * // id: "STRING_VALUE",
36
+ * // name: "STRING_VALUE",
37
+ * // description: "STRING_VALUE",
38
+ * // apiStages: [ // ListOfApiStage
39
+ * // { // ApiStage
40
+ * // apiId: "STRING_VALUE",
41
+ * // stage: "STRING_VALUE",
42
+ * // throttle: { // MapOfApiStageThrottleSettings
43
+ * // "<keys>": { // ThrottleSettings
44
+ * // burstLimit: Number("int"),
45
+ * // rateLimit: Number("double"),
46
+ * // },
47
+ * // },
48
+ * // },
49
+ * // ],
50
+ * // throttle: {
51
+ * // burstLimit: Number("int"),
52
+ * // rateLimit: Number("double"),
53
+ * // },
54
+ * // quota: { // QuotaSettings
55
+ * // limit: Number("int"),
56
+ * // offset: Number("int"),
57
+ * // period: "DAY" || "WEEK" || "MONTH",
58
+ * // },
59
+ * // productCode: "STRING_VALUE",
60
+ * // tags: { // MapOfStringToString
61
+ * // "<keys>": "STRING_VALUE",
62
+ * // },
63
+ * // };
64
+ *
34
65
  * ```
35
66
  *
36
67
  * @param GetUsagePlanCommandInput - {@link GetUsagePlanCommandInput}
@@ -51,6 +82,8 @@ export interface GetUsagePlanCommandOutput extends UsagePlan, __MetadataBearer {
51
82
  * @throws {@link UnauthorizedException} (client fault)
52
83
  * <p>The request is denied because the caller has insufficient permissions.</p>
53
84
  *
85
+ * @throws {@link APIGatewayServiceException}
86
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
54
87
  *
55
88
  */
56
89
  export declare class GetUsagePlanCommand extends $Command<GetUsagePlanCommandInput, GetUsagePlanCommandOutput, APIGatewayClientResolvedConfig> {
@@ -32,6 +32,13 @@ export interface GetUsagePlanKeyCommandOutput extends UsagePlanKey, __MetadataBe
32
32
  * };
33
33
  * const command = new GetUsagePlanKeyCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // UsagePlanKey
36
+ * // id: "STRING_VALUE",
37
+ * // type: "STRING_VALUE",
38
+ * // value: "STRING_VALUE",
39
+ * // name: "STRING_VALUE",
40
+ * // };
41
+ *
35
42
  * ```
36
43
  *
37
44
  * @param GetUsagePlanKeyCommandInput - {@link GetUsagePlanKeyCommandInput}
@@ -52,6 +59,8 @@ export interface GetUsagePlanKeyCommandOutput extends UsagePlanKey, __MetadataBe
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 GetUsagePlanKeyCommand extends $Command<GetUsagePlanKeyCommandInput, GetUsagePlanKeyCommandOutput, APIGatewayClientResolvedConfig> {
@@ -34,6 +34,18 @@ export interface GetUsagePlanKeysCommandOutput extends UsagePlanKeys, __Metadata
34
34
  * };
35
35
  * const command = new GetUsagePlanKeysCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // UsagePlanKeys
38
+ * // items: [ // ListOfUsagePlanKey
39
+ * // { // UsagePlanKey
40
+ * // id: "STRING_VALUE",
41
+ * // type: "STRING_VALUE",
42
+ * // value: "STRING_VALUE",
43
+ * // name: "STRING_VALUE",
44
+ * // },
45
+ * // ],
46
+ * // position: "STRING_VALUE",
47
+ * // };
48
+ *
37
49
  * ```
38
50
  *
39
51
  * @param GetUsagePlanKeysCommandInput - {@link GetUsagePlanKeysCommandInput}
@@ -54,6 +66,8 @@ export interface GetUsagePlanKeysCommandOutput extends UsagePlanKeys, __Metadata
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 GetUsagePlanKeysCommand extends $Command<GetUsagePlanKeysCommandInput, GetUsagePlanKeysCommandOutput, APIGatewayClientResolvedConfig> {