aws-sdk-apigateway 1.107.0 → 1.109.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-apigateway/client.rb +44 -47
- data/lib/aws-sdk-apigateway/endpoint_parameters.rb +9 -6
- data/lib/aws-sdk-apigateway/endpoints.rb +2 -1318
- data/lib/aws-sdk-apigateway/plugins/endpoints.rb +1 -246
- data/lib/aws-sdk-apigateway/types.rb +85 -91
- data/lib/aws-sdk-apigateway.rb +1 -1
- metadata +4 -4
@@ -27,7 +27,7 @@ The endpoint provider used to resolve endpoints. Any object that responds to
|
|
27
27
|
class Handler < Seahorse::Client::Handler
|
28
28
|
def call(context)
|
29
29
|
unless context[:discovered_endpoint]
|
30
|
-
params = parameters_for_operation(context)
|
30
|
+
params = Aws::APIGateway::Endpoints.parameters_for_operation(context)
|
31
31
|
endpoint = context.config.endpoint_provider.resolve_endpoint(params)
|
32
32
|
|
33
33
|
context.http_request.endpoint = endpoint.url
|
@@ -67,251 +67,6 @@ The endpoint provider used to resolve endpoints. Any object that responds to
|
|
67
67
|
context.http_request.headers[key] = value
|
68
68
|
end
|
69
69
|
end
|
70
|
-
|
71
|
-
def parameters_for_operation(context)
|
72
|
-
case context.operation_name
|
73
|
-
when :create_api_key
|
74
|
-
Aws::APIGateway::Endpoints::CreateApiKey.build(context)
|
75
|
-
when :create_authorizer
|
76
|
-
Aws::APIGateway::Endpoints::CreateAuthorizer.build(context)
|
77
|
-
when :create_base_path_mapping
|
78
|
-
Aws::APIGateway::Endpoints::CreateBasePathMapping.build(context)
|
79
|
-
when :create_deployment
|
80
|
-
Aws::APIGateway::Endpoints::CreateDeployment.build(context)
|
81
|
-
when :create_documentation_part
|
82
|
-
Aws::APIGateway::Endpoints::CreateDocumentationPart.build(context)
|
83
|
-
when :create_documentation_version
|
84
|
-
Aws::APIGateway::Endpoints::CreateDocumentationVersion.build(context)
|
85
|
-
when :create_domain_name
|
86
|
-
Aws::APIGateway::Endpoints::CreateDomainName.build(context)
|
87
|
-
when :create_model
|
88
|
-
Aws::APIGateway::Endpoints::CreateModel.build(context)
|
89
|
-
when :create_request_validator
|
90
|
-
Aws::APIGateway::Endpoints::CreateRequestValidator.build(context)
|
91
|
-
when :create_resource
|
92
|
-
Aws::APIGateway::Endpoints::CreateResource.build(context)
|
93
|
-
when :create_rest_api
|
94
|
-
Aws::APIGateway::Endpoints::CreateRestApi.build(context)
|
95
|
-
when :create_stage
|
96
|
-
Aws::APIGateway::Endpoints::CreateStage.build(context)
|
97
|
-
when :create_usage_plan
|
98
|
-
Aws::APIGateway::Endpoints::CreateUsagePlan.build(context)
|
99
|
-
when :create_usage_plan_key
|
100
|
-
Aws::APIGateway::Endpoints::CreateUsagePlanKey.build(context)
|
101
|
-
when :create_vpc_link
|
102
|
-
Aws::APIGateway::Endpoints::CreateVpcLink.build(context)
|
103
|
-
when :delete_api_key
|
104
|
-
Aws::APIGateway::Endpoints::DeleteApiKey.build(context)
|
105
|
-
when :delete_authorizer
|
106
|
-
Aws::APIGateway::Endpoints::DeleteAuthorizer.build(context)
|
107
|
-
when :delete_base_path_mapping
|
108
|
-
Aws::APIGateway::Endpoints::DeleteBasePathMapping.build(context)
|
109
|
-
when :delete_client_certificate
|
110
|
-
Aws::APIGateway::Endpoints::DeleteClientCertificate.build(context)
|
111
|
-
when :delete_deployment
|
112
|
-
Aws::APIGateway::Endpoints::DeleteDeployment.build(context)
|
113
|
-
when :delete_documentation_part
|
114
|
-
Aws::APIGateway::Endpoints::DeleteDocumentationPart.build(context)
|
115
|
-
when :delete_documentation_version
|
116
|
-
Aws::APIGateway::Endpoints::DeleteDocumentationVersion.build(context)
|
117
|
-
when :delete_domain_name
|
118
|
-
Aws::APIGateway::Endpoints::DeleteDomainName.build(context)
|
119
|
-
when :delete_gateway_response
|
120
|
-
Aws::APIGateway::Endpoints::DeleteGatewayResponse.build(context)
|
121
|
-
when :delete_integration
|
122
|
-
Aws::APIGateway::Endpoints::DeleteIntegration.build(context)
|
123
|
-
when :delete_integration_response
|
124
|
-
Aws::APIGateway::Endpoints::DeleteIntegrationResponse.build(context)
|
125
|
-
when :delete_method
|
126
|
-
Aws::APIGateway::Endpoints::DeleteMethod.build(context)
|
127
|
-
when :delete_method_response
|
128
|
-
Aws::APIGateway::Endpoints::DeleteMethodResponse.build(context)
|
129
|
-
when :delete_model
|
130
|
-
Aws::APIGateway::Endpoints::DeleteModel.build(context)
|
131
|
-
when :delete_request_validator
|
132
|
-
Aws::APIGateway::Endpoints::DeleteRequestValidator.build(context)
|
133
|
-
when :delete_resource
|
134
|
-
Aws::APIGateway::Endpoints::DeleteResource.build(context)
|
135
|
-
when :delete_rest_api
|
136
|
-
Aws::APIGateway::Endpoints::DeleteRestApi.build(context)
|
137
|
-
when :delete_stage
|
138
|
-
Aws::APIGateway::Endpoints::DeleteStage.build(context)
|
139
|
-
when :delete_usage_plan
|
140
|
-
Aws::APIGateway::Endpoints::DeleteUsagePlan.build(context)
|
141
|
-
when :delete_usage_plan_key
|
142
|
-
Aws::APIGateway::Endpoints::DeleteUsagePlanKey.build(context)
|
143
|
-
when :delete_vpc_link
|
144
|
-
Aws::APIGateway::Endpoints::DeleteVpcLink.build(context)
|
145
|
-
when :flush_stage_authorizers_cache
|
146
|
-
Aws::APIGateway::Endpoints::FlushStageAuthorizersCache.build(context)
|
147
|
-
when :flush_stage_cache
|
148
|
-
Aws::APIGateway::Endpoints::FlushStageCache.build(context)
|
149
|
-
when :generate_client_certificate
|
150
|
-
Aws::APIGateway::Endpoints::GenerateClientCertificate.build(context)
|
151
|
-
when :get_account
|
152
|
-
Aws::APIGateway::Endpoints::GetAccount.build(context)
|
153
|
-
when :get_api_key
|
154
|
-
Aws::APIGateway::Endpoints::GetApiKey.build(context)
|
155
|
-
when :get_api_keys
|
156
|
-
Aws::APIGateway::Endpoints::GetApiKeys.build(context)
|
157
|
-
when :get_authorizer
|
158
|
-
Aws::APIGateway::Endpoints::GetAuthorizer.build(context)
|
159
|
-
when :get_authorizers
|
160
|
-
Aws::APIGateway::Endpoints::GetAuthorizers.build(context)
|
161
|
-
when :get_base_path_mapping
|
162
|
-
Aws::APIGateway::Endpoints::GetBasePathMapping.build(context)
|
163
|
-
when :get_base_path_mappings
|
164
|
-
Aws::APIGateway::Endpoints::GetBasePathMappings.build(context)
|
165
|
-
when :get_client_certificate
|
166
|
-
Aws::APIGateway::Endpoints::GetClientCertificate.build(context)
|
167
|
-
when :get_client_certificates
|
168
|
-
Aws::APIGateway::Endpoints::GetClientCertificates.build(context)
|
169
|
-
when :get_deployment
|
170
|
-
Aws::APIGateway::Endpoints::GetDeployment.build(context)
|
171
|
-
when :get_deployments
|
172
|
-
Aws::APIGateway::Endpoints::GetDeployments.build(context)
|
173
|
-
when :get_documentation_part
|
174
|
-
Aws::APIGateway::Endpoints::GetDocumentationPart.build(context)
|
175
|
-
when :get_documentation_parts
|
176
|
-
Aws::APIGateway::Endpoints::GetDocumentationParts.build(context)
|
177
|
-
when :get_documentation_version
|
178
|
-
Aws::APIGateway::Endpoints::GetDocumentationVersion.build(context)
|
179
|
-
when :get_documentation_versions
|
180
|
-
Aws::APIGateway::Endpoints::GetDocumentationVersions.build(context)
|
181
|
-
when :get_domain_name
|
182
|
-
Aws::APIGateway::Endpoints::GetDomainName.build(context)
|
183
|
-
when :get_domain_names
|
184
|
-
Aws::APIGateway::Endpoints::GetDomainNames.build(context)
|
185
|
-
when :get_export
|
186
|
-
Aws::APIGateway::Endpoints::GetExport.build(context)
|
187
|
-
when :get_gateway_response
|
188
|
-
Aws::APIGateway::Endpoints::GetGatewayResponse.build(context)
|
189
|
-
when :get_gateway_responses
|
190
|
-
Aws::APIGateway::Endpoints::GetGatewayResponses.build(context)
|
191
|
-
when :get_integration
|
192
|
-
Aws::APIGateway::Endpoints::GetIntegration.build(context)
|
193
|
-
when :get_integration_response
|
194
|
-
Aws::APIGateway::Endpoints::GetIntegrationResponse.build(context)
|
195
|
-
when :get_method
|
196
|
-
Aws::APIGateway::Endpoints::GetMethod.build(context)
|
197
|
-
when :get_method_response
|
198
|
-
Aws::APIGateway::Endpoints::GetMethodResponse.build(context)
|
199
|
-
when :get_model
|
200
|
-
Aws::APIGateway::Endpoints::GetModel.build(context)
|
201
|
-
when :get_model_template
|
202
|
-
Aws::APIGateway::Endpoints::GetModelTemplate.build(context)
|
203
|
-
when :get_models
|
204
|
-
Aws::APIGateway::Endpoints::GetModels.build(context)
|
205
|
-
when :get_request_validator
|
206
|
-
Aws::APIGateway::Endpoints::GetRequestValidator.build(context)
|
207
|
-
when :get_request_validators
|
208
|
-
Aws::APIGateway::Endpoints::GetRequestValidators.build(context)
|
209
|
-
when :get_resource
|
210
|
-
Aws::APIGateway::Endpoints::GetResource.build(context)
|
211
|
-
when :get_resources
|
212
|
-
Aws::APIGateway::Endpoints::GetResources.build(context)
|
213
|
-
when :get_rest_api
|
214
|
-
Aws::APIGateway::Endpoints::GetRestApi.build(context)
|
215
|
-
when :get_rest_apis
|
216
|
-
Aws::APIGateway::Endpoints::GetRestApis.build(context)
|
217
|
-
when :get_sdk
|
218
|
-
Aws::APIGateway::Endpoints::GetSdk.build(context)
|
219
|
-
when :get_sdk_type
|
220
|
-
Aws::APIGateway::Endpoints::GetSdkType.build(context)
|
221
|
-
when :get_sdk_types
|
222
|
-
Aws::APIGateway::Endpoints::GetSdkTypes.build(context)
|
223
|
-
when :get_stage
|
224
|
-
Aws::APIGateway::Endpoints::GetStage.build(context)
|
225
|
-
when :get_stages
|
226
|
-
Aws::APIGateway::Endpoints::GetStages.build(context)
|
227
|
-
when :get_tags
|
228
|
-
Aws::APIGateway::Endpoints::GetTags.build(context)
|
229
|
-
when :get_usage
|
230
|
-
Aws::APIGateway::Endpoints::GetUsage.build(context)
|
231
|
-
when :get_usage_plan
|
232
|
-
Aws::APIGateway::Endpoints::GetUsagePlan.build(context)
|
233
|
-
when :get_usage_plan_key
|
234
|
-
Aws::APIGateway::Endpoints::GetUsagePlanKey.build(context)
|
235
|
-
when :get_usage_plan_keys
|
236
|
-
Aws::APIGateway::Endpoints::GetUsagePlanKeys.build(context)
|
237
|
-
when :get_usage_plans
|
238
|
-
Aws::APIGateway::Endpoints::GetUsagePlans.build(context)
|
239
|
-
when :get_vpc_link
|
240
|
-
Aws::APIGateway::Endpoints::GetVpcLink.build(context)
|
241
|
-
when :get_vpc_links
|
242
|
-
Aws::APIGateway::Endpoints::GetVpcLinks.build(context)
|
243
|
-
when :import_api_keys
|
244
|
-
Aws::APIGateway::Endpoints::ImportApiKeys.build(context)
|
245
|
-
when :import_documentation_parts
|
246
|
-
Aws::APIGateway::Endpoints::ImportDocumentationParts.build(context)
|
247
|
-
when :import_rest_api
|
248
|
-
Aws::APIGateway::Endpoints::ImportRestApi.build(context)
|
249
|
-
when :put_gateway_response
|
250
|
-
Aws::APIGateway::Endpoints::PutGatewayResponse.build(context)
|
251
|
-
when :put_integration
|
252
|
-
Aws::APIGateway::Endpoints::PutIntegration.build(context)
|
253
|
-
when :put_integration_response
|
254
|
-
Aws::APIGateway::Endpoints::PutIntegrationResponse.build(context)
|
255
|
-
when :put_method
|
256
|
-
Aws::APIGateway::Endpoints::PutMethod.build(context)
|
257
|
-
when :put_method_response
|
258
|
-
Aws::APIGateway::Endpoints::PutMethodResponse.build(context)
|
259
|
-
when :put_rest_api
|
260
|
-
Aws::APIGateway::Endpoints::PutRestApi.build(context)
|
261
|
-
when :tag_resource
|
262
|
-
Aws::APIGateway::Endpoints::TagResource.build(context)
|
263
|
-
when :test_invoke_authorizer
|
264
|
-
Aws::APIGateway::Endpoints::TestInvokeAuthorizer.build(context)
|
265
|
-
when :test_invoke_method
|
266
|
-
Aws::APIGateway::Endpoints::TestInvokeMethod.build(context)
|
267
|
-
when :untag_resource
|
268
|
-
Aws::APIGateway::Endpoints::UntagResource.build(context)
|
269
|
-
when :update_account
|
270
|
-
Aws::APIGateway::Endpoints::UpdateAccount.build(context)
|
271
|
-
when :update_api_key
|
272
|
-
Aws::APIGateway::Endpoints::UpdateApiKey.build(context)
|
273
|
-
when :update_authorizer
|
274
|
-
Aws::APIGateway::Endpoints::UpdateAuthorizer.build(context)
|
275
|
-
when :update_base_path_mapping
|
276
|
-
Aws::APIGateway::Endpoints::UpdateBasePathMapping.build(context)
|
277
|
-
when :update_client_certificate
|
278
|
-
Aws::APIGateway::Endpoints::UpdateClientCertificate.build(context)
|
279
|
-
when :update_deployment
|
280
|
-
Aws::APIGateway::Endpoints::UpdateDeployment.build(context)
|
281
|
-
when :update_documentation_part
|
282
|
-
Aws::APIGateway::Endpoints::UpdateDocumentationPart.build(context)
|
283
|
-
when :update_documentation_version
|
284
|
-
Aws::APIGateway::Endpoints::UpdateDocumentationVersion.build(context)
|
285
|
-
when :update_domain_name
|
286
|
-
Aws::APIGateway::Endpoints::UpdateDomainName.build(context)
|
287
|
-
when :update_gateway_response
|
288
|
-
Aws::APIGateway::Endpoints::UpdateGatewayResponse.build(context)
|
289
|
-
when :update_integration
|
290
|
-
Aws::APIGateway::Endpoints::UpdateIntegration.build(context)
|
291
|
-
when :update_integration_response
|
292
|
-
Aws::APIGateway::Endpoints::UpdateIntegrationResponse.build(context)
|
293
|
-
when :update_method
|
294
|
-
Aws::APIGateway::Endpoints::UpdateMethod.build(context)
|
295
|
-
when :update_method_response
|
296
|
-
Aws::APIGateway::Endpoints::UpdateMethodResponse.build(context)
|
297
|
-
when :update_model
|
298
|
-
Aws::APIGateway::Endpoints::UpdateModel.build(context)
|
299
|
-
when :update_request_validator
|
300
|
-
Aws::APIGateway::Endpoints::UpdateRequestValidator.build(context)
|
301
|
-
when :update_resource
|
302
|
-
Aws::APIGateway::Endpoints::UpdateResource.build(context)
|
303
|
-
when :update_rest_api
|
304
|
-
Aws::APIGateway::Endpoints::UpdateRestApi.build(context)
|
305
|
-
when :update_stage
|
306
|
-
Aws::APIGateway::Endpoints::UpdateStage.build(context)
|
307
|
-
when :update_usage
|
308
|
-
Aws::APIGateway::Endpoints::UpdateUsage.build(context)
|
309
|
-
when :update_usage_plan
|
310
|
-
Aws::APIGateway::Endpoints::UpdateUsagePlan.build(context)
|
311
|
-
when :update_vpc_link
|
312
|
-
Aws::APIGateway::Endpoints::UpdateVpcLink.build(context)
|
313
|
-
end
|
314
|
-
end
|
315
70
|
end
|
316
71
|
|
317
72
|
def add_handlers(handlers, _config)
|
@@ -209,7 +209,7 @@ module Aws::APIGateway
|
|
209
209
|
# @!attribute [rw] provider_arns
|
210
210
|
# A list of the Amazon Cognito user pool ARNs for the
|
211
211
|
# `COGNITO_USER_POOLS` authorizer. Each element is of this format:
|
212
|
-
# `arn:aws:cognito-idp
|
212
|
+
# `arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}`.
|
213
213
|
# For a `TOKEN` or `REQUEST` authorizer, this is not defined.
|
214
214
|
# @return [Array<String>]
|
215
215
|
#
|
@@ -222,10 +222,10 @@ module Aws::APIGateway
|
|
222
222
|
# Specifies the authorizer's Uniform Resource Identifier (URI). For
|
223
223
|
# `TOKEN` or `REQUEST` authorizers, this must be a well-formed Lambda
|
224
224
|
# function URI, for example,
|
225
|
-
# `arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2
|
225
|
+
# `arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations`.
|
226
226
|
# In general, the URI has this form
|
227
|
-
# `arn:aws:apigateway
|
228
|
-
#
|
227
|
+
# `arn:aws:apigateway:{region}:lambda:path/{service_api}`, where
|
228
|
+
# `{region}` is the same as the region hosting the Lambda function,
|
229
229
|
# `path` indicates that the remaining substring in the URI should be
|
230
230
|
# treated as the path to the resource, including the initial `/`. For
|
231
231
|
# Lambda functions, this is usually of the form
|
@@ -538,7 +538,7 @@ module Aws::APIGateway
|
|
538
538
|
# @!attribute [rw] provider_arns
|
539
539
|
# A list of the Amazon Cognito user pool ARNs for the
|
540
540
|
# `COGNITO_USER_POOLS` authorizer. Each element is of this format:
|
541
|
-
# `arn:aws:cognito-idp
|
541
|
+
# `arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}`.
|
542
542
|
# For a `TOKEN` or `REQUEST` authorizer, this is not defined.
|
543
543
|
# @return [Array<String>]
|
544
544
|
#
|
@@ -551,10 +551,10 @@ module Aws::APIGateway
|
|
551
551
|
# Specifies the authorizer's Uniform Resource Identifier (URI). For
|
552
552
|
# `TOKEN` or `REQUEST` authorizers, this must be a well-formed Lambda
|
553
553
|
# function URI, for example,
|
554
|
-
# `arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2
|
554
|
+
# `arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations`.
|
555
555
|
# In general, the URI has this form
|
556
|
-
# `arn:aws:apigateway
|
557
|
-
#
|
556
|
+
# `arn:aws:apigateway:{region}:lambda:path/{service_api}`, where
|
557
|
+
# `{region}` is the same as the region hosting the Lambda function,
|
558
558
|
# `path` indicates that the remaining substring in the URI should be
|
559
559
|
# treated as the path to the resource, including the initial `/`. For
|
560
560
|
# Lambda functions, this is usually of the form
|
@@ -1018,10 +1018,9 @@ module Aws::APIGateway
|
|
1018
1018
|
# @!attribute [rw] disable_execute_api_endpoint
|
1019
1019
|
# Specifies whether clients can invoke your API by using the default
|
1020
1020
|
# `execute-api` endpoint. By default, clients can invoke your API with
|
1021
|
-
# the default
|
1022
|
-
#
|
1023
|
-
#
|
1024
|
-
# disable the default endpoint
|
1021
|
+
# the default `https://{api_id}.execute-api.{region}.amazonaws.com`
|
1022
|
+
# endpoint. To require that clients use a custom domain name to invoke
|
1023
|
+
# your API, disable the default endpoint
|
1025
1024
|
# @return [Boolean]
|
1026
1025
|
#
|
1027
1026
|
class CreateRestApiRequest < Struct.new(
|
@@ -1676,7 +1675,7 @@ module Aws::APIGateway
|
|
1676
1675
|
# @!attribute [rw] properties
|
1677
1676
|
# A content map of API-specific key-value pairs describing the
|
1678
1677
|
# targeted API entity. The map must be encoded as a JSON string, e.g.,
|
1679
|
-
# `"
|
1678
|
+
# `"{ "description": "The API does ..." }"`. Only
|
1680
1679
|
# OpenAPI-compliant documentation-related fields from the properties
|
1681
1680
|
# map are exported and, hence, published as part of the API entity
|
1682
1681
|
# definitions, while the original documentation parts are exported in
|
@@ -2315,13 +2314,13 @@ module Aws::APIGateway
|
|
2315
2314
|
# the returned Deployment resource in the response. In a REST API
|
2316
2315
|
# call, this `embed` parameter value is a list of comma-separated
|
2317
2316
|
# strings, as in `GET
|
2318
|
-
# /restapis
|
2317
|
+
# /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2`.
|
2319
2318
|
# The SDK and other platform-dependent libraries might use a different
|
2320
2319
|
# format for the list. Currently, this request supports only retrieval
|
2321
2320
|
# of the embedded API summary this way. Hence, the parameter value
|
2322
2321
|
# must be a single-valued list containing only the `"apisummary"`
|
2323
2322
|
# string. For example, `GET
|
2324
|
-
# /restapis
|
2323
|
+
# /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary`.
|
2325
2324
|
# @return [Array<String>]
|
2326
2325
|
#
|
2327
2326
|
class GetDeploymentRequest < Struct.new(
|
@@ -2803,7 +2802,7 @@ module Aws::APIGateway
|
|
2803
2802
|
# request supports only retrieval of the embedded Method resources
|
2804
2803
|
# this way. The query parameter value must be a single-valued list and
|
2805
2804
|
# contain the `"methods"` string. For example, `GET
|
2806
|
-
# /restapis
|
2805
|
+
# /restapis/{restapi_id}/resources/{resource_id}?embed=methods`.
|
2807
2806
|
# @return [Array<String>]
|
2808
2807
|
#
|
2809
2808
|
class GetResourceRequest < Struct.new(
|
@@ -2836,7 +2835,7 @@ module Aws::APIGateway
|
|
2836
2835
|
# request supports only retrieval of the embedded Method resources
|
2837
2836
|
# this way. The query parameter value must be a single-valued list and
|
2838
2837
|
# contain the `"methods"` string. For example, `GET
|
2839
|
-
# /restapis
|
2838
|
+
# /restapis/{restapi_id}/resources?embed=methods`.
|
2840
2839
|
# @return [Array<String>]
|
2841
2840
|
#
|
2842
2841
|
class GetResourcesRequest < Struct.new(
|
@@ -3293,23 +3292,22 @@ module Aws::APIGateway
|
|
3293
3292
|
# for standard integrations. If `connectionType` is `VPC_LINK` specify
|
3294
3293
|
# the Network Load Balancer DNS name. For `AWS` or `AWS_PROXY`
|
3295
3294
|
# integrations, the URI is of the form
|
3296
|
-
# `arn:aws:apigateway
|
3297
|
-
# Here,
|
3298
|
-
#
|
3299
|
-
#
|
3300
|
-
#
|
3301
|
-
#
|
3302
|
-
#
|
3303
|
-
#
|
3304
|
-
#
|
3305
|
-
#
|
3306
|
-
# can be used for an Amazon Web Services service path-based API. The
|
3295
|
+
# `arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}`.
|
3296
|
+
# Here, \{Region} is the API Gateway region (e.g., us-east-1);
|
3297
|
+
# \{service} is the name of the integrated Amazon Web Services service
|
3298
|
+
# (e.g., s3); and \{subdomain} is a designated subdomain supported by
|
3299
|
+
# certain Amazon Web Services service for fast host-name lookup.
|
3300
|
+
# action can be used for an Amazon Web Services service action-based
|
3301
|
+
# API, using an Action=\{name}&\{p1}=\{v1}&p2=\{v2}... query
|
3302
|
+
# string. The ensuing \{service\_api} refers to a supported action
|
3303
|
+
# \{name} plus any required input parameters. Alternatively, path can
|
3304
|
+
# be used for an Amazon Web Services service path-based API. The
|
3307
3305
|
# ensuing service\_api refers to the path to an Amazon Web Services
|
3308
3306
|
# service resource, including the region of the integrated Amazon Web
|
3309
3307
|
# Services service, if applicable. For example, for integration with
|
3310
3308
|
# the S3 API of GetObject, the uri can be either
|
3311
|
-
# `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket
|
3312
|
-
# or `arn:aws:apigateway:us-west-2:s3:path
|
3309
|
+
# `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}`
|
3310
|
+
# or `arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}`
|
3313
3311
|
# @return [String]
|
3314
3312
|
#
|
3315
3313
|
# @!attribute [rw] connection_type
|
@@ -3342,7 +3340,7 @@ module Aws::APIGateway
|
|
3342
3340
|
# parameter value or static value that must be enclosed within single
|
3343
3341
|
# quotes and pre-encoded as required by the back end. The method
|
3344
3342
|
# request parameter value must match the pattern of
|
3345
|
-
# `method.request
|
3343
|
+
# `method.request.{location}.{name}`, where `location` is
|
3346
3344
|
# `querystring`, `path`, or `header` and `name` must be a valid and
|
3347
3345
|
# unique method request parameter name.
|
3348
3346
|
# @return [Hash<String,String>]
|
@@ -3463,10 +3461,10 @@ module Aws::APIGateway
|
|
3463
3461
|
# response header value, a static value enclosed within a pair of
|
3464
3462
|
# single quotes, or a JSON expression from the integration response
|
3465
3463
|
# body. The mapping key must match the pattern of
|
3466
|
-
# `method.response.header
|
3467
|
-
#
|
3468
|
-
#
|
3469
|
-
# `integration.response.body
|
3464
|
+
# `method.response.header.{name}`, where `name` is a valid and unique
|
3465
|
+
# header name. The mapped non-static value must match the pattern of
|
3466
|
+
# `integration.response.header.{name}` or
|
3467
|
+
# `integration.response.body.{JSON-expression}`, where `name` is a
|
3470
3468
|
# valid and unique response header name and `JSON-expression` is a
|
3471
3469
|
# valid JSON expression without the `$` prefix.
|
3472
3470
|
# @return [Hash<String,String>]
|
@@ -3560,7 +3558,7 @@ module Aws::APIGateway
|
|
3560
3558
|
# A key-value map defining required or optional method request
|
3561
3559
|
# parameters that can be accepted by API Gateway. A key is a method
|
3562
3560
|
# request parameter name matching the pattern of
|
3563
|
-
# `method.request
|
3561
|
+
# `method.request.{location}.{name}`, where `location` is
|
3564
3562
|
# `querystring`, `path`, or `header` and `name` is a valid and unique
|
3565
3563
|
# parameter name. The value associated with the key is a Boolean flag
|
3566
3564
|
# indicating whether the parameter is required (`true`) or optional
|
@@ -3627,16 +3625,16 @@ module Aws::APIGateway
|
|
3627
3625
|
# that API Gateway can send back to the caller. A key defines a method
|
3628
3626
|
# response header and the value specifies whether the associated
|
3629
3627
|
# method response header is required or not. The expression of the key
|
3630
|
-
# must match the pattern `method.response.header
|
3631
|
-
#
|
3628
|
+
# must match the pattern `method.response.header.{name}`, where `name`
|
3629
|
+
# is a valid and unique header name. API Gateway passes certain
|
3632
3630
|
# integration response data to the method response headers specified
|
3633
3631
|
# here according to the mapping you prescribe in the API's
|
3634
3632
|
# IntegrationResponse. The integration response data that can be
|
3635
3633
|
# mapped include an integration response header expressed in
|
3636
|
-
# `integration.response.header
|
3637
|
-
#
|
3638
|
-
#
|
3639
|
-
# `integration.response.body
|
3634
|
+
# `integration.response.header.{name}`, a static value enclosed within
|
3635
|
+
# a pair of single quotes (e.g., `'application/json'`), or a JSON
|
3636
|
+
# expression from the back-end response payload in the form of
|
3637
|
+
# `integration.response.body.{JSON-expression}`, where
|
3640
3638
|
# `JSON-expression` is a valid JSON expression without the `$`
|
3641
3639
|
# prefix.)
|
3642
3640
|
# @return [Hash<String,Boolean>]
|
@@ -3898,20 +3896,20 @@ module Aws::APIGateway
|
|
3898
3896
|
# The op operation's target, as identified by a JSON Pointer value
|
3899
3897
|
# that references a location within the targeted resource. For
|
3900
3898
|
# example, if the target resource has an updateable property of
|
3901
|
-
#
|
3902
|
-
#
|
3903
|
-
#
|
3904
|
-
#
|
3905
|
-
#
|
3906
|
-
#
|
3907
|
-
#
|
3899
|
+
# \{"name":"value"}, the path for this property is /name. If the
|
3900
|
+
# name property value is a JSON object (e.g., \{"name":
|
3901
|
+
# \{"child/name": "child-value"}}), the path for the child/name
|
3902
|
+
# property will be /name/child~1name. Any slash ("/") character
|
3903
|
+
# appearing in path names must be escaped with "~1", as shown in the
|
3904
|
+
# example above. Each op operation can have only one path associated
|
3905
|
+
# with it.
|
3908
3906
|
# @return [String]
|
3909
3907
|
#
|
3910
3908
|
# @!attribute [rw] value
|
3911
3909
|
# The new target value of the update operation. It is applicable for
|
3912
3910
|
# the add or replace operation. When using AWS CLI to update a
|
3913
3911
|
# property of a JSON value, enclose the JSON object with a pair of
|
3914
|
-
# single quotes in a Linux shell, e.g., '
|
3912
|
+
# single quotes in a Linux shell, e.g., '\{"a": ...}'.
|
3915
3913
|
# @return [String]
|
3916
3914
|
#
|
3917
3915
|
# @!attribute [rw] from
|
@@ -3999,23 +3997,22 @@ module Aws::APIGateway
|
|
3999
3997
|
# `connectionType` is `VPC_LINK`. For a private HTTP integration, the
|
4000
3998
|
# URI is not used for routing. For `AWS` or `AWS_PROXY` integrations,
|
4001
3999
|
# the URI is of the form
|
4002
|
-
# `arn:aws:apigateway
|
4003
|
-
# Here,
|
4004
|
-
#
|
4005
|
-
#
|
4006
|
-
#
|
4007
|
-
#
|
4008
|
-
#
|
4009
|
-
#
|
4010
|
-
#
|
4011
|
-
#
|
4012
|
-
# can be used for an Amazon Web Services service path-based API. The
|
4000
|
+
# `arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api`}.
|
4001
|
+
# Here, \{Region} is the API Gateway region (e.g., us-east-1);
|
4002
|
+
# \{service} is the name of the integrated Amazon Web Services service
|
4003
|
+
# (e.g., s3); and \{subdomain} is a designated subdomain supported by
|
4004
|
+
# certain Amazon Web Services service for fast host-name lookup.
|
4005
|
+
# action can be used for an Amazon Web Services service action-based
|
4006
|
+
# API, using an Action=\{name}&\{p1}=\{v1}&p2=\{v2}... query
|
4007
|
+
# string. The ensuing \{service\_api} refers to a supported action
|
4008
|
+
# \{name} plus any required input parameters. Alternatively, path can
|
4009
|
+
# be used for an Amazon Web Services service path-based API. The
|
4013
4010
|
# ensuing service\_api refers to the path to an Amazon Web Services
|
4014
4011
|
# service resource, including the region of the integrated Amazon Web
|
4015
4012
|
# Services service, if applicable. For example, for integration with
|
4016
4013
|
# the S3 API of `GetObject`, the `uri` can be either
|
4017
|
-
# `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket
|
4018
|
-
# or `arn:aws:apigateway:us-west-2:s3:path
|
4014
|
+
# `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}`
|
4015
|
+
# or `arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}`.
|
4019
4016
|
# @return [String]
|
4020
4017
|
#
|
4021
4018
|
# @!attribute [rw] connection_type
|
@@ -4042,7 +4039,7 @@ module Aws::APIGateway
|
|
4042
4039
|
# parameter value or static value that must be enclosed within single
|
4043
4040
|
# quotes and pre-encoded as required by the back end. The method
|
4044
4041
|
# request parameter value must match the pattern of
|
4045
|
-
# `method.request
|
4042
|
+
# `method.request.{location}.{name}`, where `location` is
|
4046
4043
|
# `querystring`, `path`, or `header` and `name` must be a valid and
|
4047
4044
|
# unique method request parameter name.
|
4048
4045
|
# @return [Hash<String,String>]
|
@@ -4147,11 +4144,11 @@ module Aws::APIGateway
|
|
4147
4144
|
# response header value, a static value enclosed within a pair of
|
4148
4145
|
# single quotes, or a JSON expression from the integration response
|
4149
4146
|
# body. The mapping key must match the pattern of
|
4150
|
-
# `method.response.header
|
4151
|
-
#
|
4152
|
-
#
|
4153
|
-
# `integration.response.body
|
4154
|
-
#
|
4147
|
+
# `method.response.header.{name}`, where `name` is a valid and unique
|
4148
|
+
# header name. The mapped non-static value must match the pattern of
|
4149
|
+
# `integration.response.header.{name}` or
|
4150
|
+
# `integration.response.body.{JSON-expression}`, where `name` must be
|
4151
|
+
# a valid and unique response header name and `JSON-expression` a
|
4155
4152
|
# valid JSON expression without the `$` prefix.
|
4156
4153
|
# @return [Hash<String,String>]
|
4157
4154
|
#
|
@@ -4224,7 +4221,7 @@ module Aws::APIGateway
|
|
4224
4221
|
# A key-value map defining required or optional method request
|
4225
4222
|
# parameters that can be accepted by API Gateway. A key defines a
|
4226
4223
|
# method request parameter name matching the pattern of
|
4227
|
-
# `method.request
|
4224
|
+
# `method.request.{location}.{name}`, where `location` is
|
4228
4225
|
# `querystring`, `path`, or `header` and `name` is a valid and unique
|
4229
4226
|
# parameter name. The value associated with the key is a Boolean flag
|
4230
4227
|
# indicating whether the parameter is required (`true`) or optional
|
@@ -4296,14 +4293,14 @@ module Aws::APIGateway
|
|
4296
4293
|
# response header name and the associated value is a Boolean flag
|
4297
4294
|
# indicating whether the method response parameter is required or not.
|
4298
4295
|
# The method response header names must match the pattern of
|
4299
|
-
# `method.response.header
|
4300
|
-
#
|
4301
|
-
#
|
4302
|
-
#
|
4303
|
-
#
|
4304
|
-
#
|
4305
|
-
#
|
4306
|
-
# `integration.response.body
|
4296
|
+
# `method.response.header.{name}`, where `name` is a valid and unique
|
4297
|
+
# header name. The response parameter names defined here are available
|
4298
|
+
# in the integration response to be mapped from an integration
|
4299
|
+
# response header expressed in `integration.response.header.{name}`, a
|
4300
|
+
# static value enclosed within a pair of single quotes (e.g.,
|
4301
|
+
# `'application/json'`), or a JSON expression from the back-end
|
4302
|
+
# response payload in the form of
|
4303
|
+
# `integration.response.body.{JSON-expression}`, where
|
4307
4304
|
# `JSON-expression` is a valid JSON expression without the `$`
|
4308
4305
|
# prefix.)
|
4309
4306
|
# @return [Hash<String,Boolean>]
|
@@ -4554,10 +4551,9 @@ module Aws::APIGateway
|
|
4554
4551
|
# @!attribute [rw] disable_execute_api_endpoint
|
4555
4552
|
# Specifies whether clients can invoke your API by using the default
|
4556
4553
|
# `execute-api` endpoint. By default, clients can invoke your API with
|
4557
|
-
# the default
|
4558
|
-
#
|
4559
|
-
#
|
4560
|
-
# disable the default endpoint.
|
4554
|
+
# the default `https://{api_id}.execute-api.{region}.amazonaws.com`
|
4555
|
+
# endpoint. To require that clients use a custom domain name to invoke
|
4556
|
+
# your API, disable the default endpoint.
|
4561
4557
|
# @return [Boolean]
|
4562
4558
|
#
|
4563
4559
|
# @!attribute [rw] root_resource_id
|
@@ -4761,10 +4757,9 @@ module Aws::APIGateway
|
|
4761
4757
|
#
|
4762
4758
|
# @!attribute [rw] method_settings
|
4763
4759
|
# A map that defines the method settings for a Stage resource. Keys
|
4764
|
-
# (designated as
|
4765
|
-
# defined as
|
4766
|
-
#
|
4767
|
-
# stage.
|
4760
|
+
# (designated as `/{method_setting_key` below) are method paths
|
4761
|
+
# defined as `{resource_path}/{http_method}` for an individual method
|
4762
|
+
# override, or `/*/*` for overriding all methods in the stage.
|
4768
4763
|
# @return [Hash<String,Types::MethodSetting>]
|
4769
4764
|
#
|
4770
4765
|
# @!attribute [rw] variables
|
@@ -4830,7 +4825,7 @@ module Aws::APIGateway
|
|
4830
4825
|
end
|
4831
4826
|
|
4832
4827
|
# A reference to a unique stage identified in the format
|
4833
|
-
#
|
4828
|
+
# `{restApiId}/{stage}`.
|
4834
4829
|
#
|
4835
4830
|
# @!attribute [rw] rest_api_id
|
4836
4831
|
# The string identifier of the associated RestApi.
|
@@ -5803,10 +5798,9 @@ module Aws::APIGateway
|
|
5803
5798
|
# @!attribute [rw] items
|
5804
5799
|
# The usage data, as daily logs of used and remaining quotas, over the
|
5805
5800
|
# specified time interval indexed over the API keys in a usage plan.
|
5806
|
-
# For example,
|
5807
|
-
#
|
5808
|
-
#
|
5809
|
-
# quota]`.
|
5801
|
+
# For example, `{..., "values" : { "{api_key}" : [ [0, 100], [10, 90],
|
5802
|
+
# [100, 10]]}`, where `{api_key}` stands for an API key value and the
|
5803
|
+
# daily log entry is of the format `[used quota, remaining quota]`.
|
5810
5804
|
# @return [Hash<String,Array<Array<Integer>>>]
|
5811
5805
|
#
|
5812
5806
|
class Usage < Struct.new(
|