aws-sdk-apigateway 1.0.0 → 1.1.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.
- checksums.yaml +4 -4
- data/lib/aws-sdk-apigateway.rb +1 -1
- data/lib/aws-sdk-apigateway/client.rb +78 -27
- data/lib/aws-sdk-apigateway/client_api.rb +3 -1
- data/lib/aws-sdk-apigateway/types.rb +128 -56
- metadata +5 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 55d730092c929ef161958cdaa678afca71ac021e
|
4
|
+
data.tar.gz: a03c352bb7d70fc5a2c5065a561361443484f2ae
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4da20f7782070796b9c5ee7f113b0f95cd427b4425f6bd4992a059905c97f853aea09db55169543dfcb76a12abde9ed5316bffcc4aef74fce453e1b0eb0fb7f4
|
7
|
+
data.tar.gz: 7902b82be9e2e8c7daf321335bbd62877aaf5d6aadb46a6504dc652950b7481dab5943b7e8553c9ba9578215afe233f4e6a63826562bfa702efcd5b808c3dcd9
|
data/lib/aws-sdk-apigateway.rb
CHANGED
@@ -247,30 +247,79 @@ module Aws::APIGateway
|
|
247
247
|
# \[Required\] The name of the authorizer.
|
248
248
|
#
|
249
249
|
# @option params [required, String] :type
|
250
|
-
# \[Required\] The type
|
250
|
+
# \[Required\] The authorizer type. Valid values are `TOKEN` for a
|
251
|
+
# Lambda function using a single authorization token submitted in a
|
252
|
+
# custom header, `REQUEST` for a Lambda function using incoming request
|
253
|
+
# parameters, and `COGNITO_USER_POOLS` for using an Amazon Cognito user
|
254
|
+
# pool.
|
251
255
|
#
|
252
256
|
# @option params [Array<String>] :provider_arns
|
253
|
-
# A list of the Cognito
|
257
|
+
# A list of the Amazon Cognito user pool ARNs for the
|
258
|
+
# `COGNITO_USER_POOLS` authorizer. Each element is of this format:
|
259
|
+
# `arn:aws:cognito-idp:\{region\}:\{account_id\}:userpool/\{user_pool_id\}`.
|
260
|
+
# For a `TOKEN` or `REQUEST` authorizer, this is not defined.
|
254
261
|
#
|
255
262
|
# @option params [String] :auth_type
|
256
|
-
# Optional customer-defined field, used in Swagger imports
|
257
|
-
#
|
263
|
+
# Optional customer-defined field, used in Swagger imports and exports
|
264
|
+
# without functional impact.
|
258
265
|
#
|
259
266
|
# @option params [String] :authorizer_uri
|
260
|
-
#
|
261
|
-
#
|
267
|
+
# Specifies the authorizer's Uniform Resource Identifier (URI). For
|
268
|
+
# `TOKEN` or `REQUEST` authorizers, this must be a well-formed Lambda
|
269
|
+
# function URI, for example,
|
270
|
+
# `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`.
|
271
|
+
# In general, the URI has this form
|
272
|
+
# `arn:aws:apigateway:\{region\}:lambda:path/\{service_api\}`, where
|
273
|
+
# `\{region\}` is the same as the region hosting the Lambda function,
|
274
|
+
# `path` indicates that the remaining substring in the URI should be
|
275
|
+
# treated as the path to the resource, including the initial `/`. For
|
276
|
+
# Lambda functions, this is usually of the form
|
277
|
+
# `/2015-03-31/functions/[FunctionARN]/invocations`.
|
262
278
|
#
|
263
279
|
# @option params [String] :authorizer_credentials
|
264
|
-
# Specifies the credentials
|
265
|
-
#
|
266
|
-
#
|
267
|
-
#
|
280
|
+
# Specifies the required credentials as an IAM role for Amazon API
|
281
|
+
# Gateway to invoke the authorizer. To specify an IAM role for Amazon
|
282
|
+
# API Gateway to assume, use the role's Amazon Resource Name (ARN). To
|
283
|
+
# use resource-based permissions on the Lambda function, specify null.
|
284
|
+
#
|
285
|
+
# @option params [String] :identity_source
|
286
|
+
# The identity source for which authorization is requested. * For a
|
287
|
+
# `TOKEN` authorizer, this is required and specifies the request
|
288
|
+
# header mapping expression for the custom header holding the
|
289
|
+
# authorization token submitted by the client. For example, if the
|
290
|
+
# token header name is `Auth`, the header mapping expression is
|
291
|
+
# `method.request.header.Auth`.
|
292
|
+
# * For the `REQUEST` authorizer, this is required when authorization
|
293
|
+
# caching is enabled. The value is a comma-separated string of one or
|
294
|
+
# more mapping expressions of the specified request parameters. For
|
295
|
+
# example, if an `Auth` header, a `Name` query string parameter are
|
296
|
+
# defined as identity sources, this value is
|
297
|
+
# `method.request.header.Auth, method.request.querystring.Name`. These
|
298
|
+
# parameters will be used to derive the authorization caching key and
|
299
|
+
# to perform runtime validation of the `REQUEST` authorizer by
|
300
|
+
# verifying all of the identity-related request parameters are
|
301
|
+
# present, not null and non-empty. Only when this is true does the
|
302
|
+
# authorizer invoke the authorizer Lambda function, otherwise, it
|
303
|
+
# returns a 401 Unauthorized response without calling the Lambda
|
304
|
+
# function. The valid value is a string of comma-separated mapping
|
305
|
+
# expressions of the specified request parameters. When the
|
306
|
+
# authorization caching is not enabled, this property is optional.
|
307
|
+
# * For a `COGNITO_USER_POOLS` authorizer, this property is not used.
|
268
308
|
#
|
269
309
|
# @option params [String] :identity_validation_expression
|
270
|
-
# A validation expression for the incoming identity.
|
310
|
+
# A validation expression for the incoming identity token. For `TOKEN`
|
311
|
+
# authorizers, this value is a regular expression. Amazon API Gateway
|
312
|
+
# will match the incoming token from the client against the specified
|
313
|
+
# regular expression. It will invoke the authorizer's Lambda function
|
314
|
+
# there is a match. Otherwise, it will return a 401 Unauthorized
|
315
|
+
# response without calling the Lambda function. The validation
|
316
|
+
# expression does not apply to the `REQUEST` authorizer.
|
271
317
|
#
|
272
318
|
# @option params [Integer] :authorizer_result_ttl_in_seconds
|
273
|
-
# The TTL of cached authorizer results.
|
319
|
+
# The TTL in seconds of cached authorizer results. If it equals 0,
|
320
|
+
# authorization caching is disabled. If it is greater than 0, API
|
321
|
+
# Gateway will cache authorizer responses. If this field is not set, the
|
322
|
+
# default value is 300. The maximum value is 3600, or 1 hour.
|
274
323
|
#
|
275
324
|
# @return [Types::Authorizer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
276
325
|
#
|
@@ -290,12 +339,12 @@ module Aws::APIGateway
|
|
290
339
|
# resp = client.create_authorizer({
|
291
340
|
# rest_api_id: "String", # required
|
292
341
|
# name: "String", # required
|
293
|
-
# type: "TOKEN", # required, accepts TOKEN, COGNITO_USER_POOLS
|
342
|
+
# type: "TOKEN", # required, accepts TOKEN, REQUEST, COGNITO_USER_POOLS
|
294
343
|
# provider_arns: ["ProviderARN"],
|
295
344
|
# auth_type: "String",
|
296
345
|
# authorizer_uri: "String",
|
297
346
|
# authorizer_credentials: "String",
|
298
|
-
# identity_source: "String",
|
347
|
+
# identity_source: "String",
|
299
348
|
# identity_validation_expression: "String",
|
300
349
|
# authorizer_result_ttl_in_seconds: 1,
|
301
350
|
# })
|
@@ -304,7 +353,7 @@ module Aws::APIGateway
|
|
304
353
|
#
|
305
354
|
# resp.id #=> String
|
306
355
|
# resp.name #=> String
|
307
|
-
# resp.type #=> String, one of "TOKEN", "COGNITO_USER_POOLS"
|
356
|
+
# resp.type #=> String, one of "TOKEN", "REQUEST", "COGNITO_USER_POOLS"
|
308
357
|
# resp.provider_arns #=> Array
|
309
358
|
# resp.provider_arns[0] #=> String
|
310
359
|
# resp.auth_type #=> String
|
@@ -593,7 +642,7 @@ module Aws::APIGateway
|
|
593
642
|
# The RestApi identifier under which the Model will be created.
|
594
643
|
#
|
595
644
|
# @option params [required, String] :name
|
596
|
-
# The name of the model.
|
645
|
+
# The name of the model. Must be alphanumeric.
|
597
646
|
#
|
598
647
|
# @option params [String] :description
|
599
648
|
# The description of the model.
|
@@ -1801,7 +1850,7 @@ module Aws::APIGateway
|
|
1801
1850
|
#
|
1802
1851
|
# resp.id #=> String
|
1803
1852
|
# resp.name #=> String
|
1804
|
-
# resp.type #=> String, one of "TOKEN", "COGNITO_USER_POOLS"
|
1853
|
+
# resp.type #=> String, one of "TOKEN", "REQUEST", "COGNITO_USER_POOLS"
|
1805
1854
|
# resp.provider_arns #=> Array
|
1806
1855
|
# resp.provider_arns[0] #=> String
|
1807
1856
|
# resp.auth_type #=> String
|
@@ -1856,7 +1905,7 @@ module Aws::APIGateway
|
|
1856
1905
|
# resp.items #=> Array
|
1857
1906
|
# resp.items[0].id #=> String
|
1858
1907
|
# resp.items[0].name #=> String
|
1859
|
-
# resp.items[0].type #=> String, one of "TOKEN", "COGNITO_USER_POOLS"
|
1908
|
+
# resp.items[0].type #=> String, one of "TOKEN", "REQUEST", "COGNITO_USER_POOLS"
|
1860
1909
|
# resp.items[0].provider_arns #=> Array
|
1861
1910
|
# resp.items[0].provider_arns[0] #=> String
|
1862
1911
|
# resp.items[0].auth_type #=> String
|
@@ -3213,15 +3262,17 @@ module Aws::APIGateway
|
|
3213
3262
|
# The name of the Stage that the SDK will use.
|
3214
3263
|
#
|
3215
3264
|
# @option params [required, String] :sdk_type
|
3216
|
-
# The language for the generated SDK. Currently `
|
3217
|
-
#
|
3265
|
+
# The language for the generated SDK. Currently `java`, `javascript`,
|
3266
|
+
# `android`, `objectivec` and `swift` (for iOS) are supported.
|
3218
3267
|
#
|
3219
3268
|
# @option params [Hash<String,String>] :parameters
|
3220
|
-
# A key-value map of query
|
3221
|
-
#
|
3222
|
-
# `objectivec`, a parameter named `classPrefix` is required.
|
3223
|
-
# `sdkType` of `android`, parameters named `groupId`, `artifactId`,
|
3224
|
-
# `artifactVersion`, and `invokerPackage` are required.
|
3269
|
+
# A string-to-string key-value map of query parameters
|
3270
|
+
# `sdkType`-dependent properties of the SDK. For `sdkType` of
|
3271
|
+
# `objectivec` or `swift`, a parameter named `classPrefix` is required.
|
3272
|
+
# For `sdkType` of `android`, parameters named `groupId`, `artifactId`,
|
3273
|
+
# `artifactVersion`, and `invokerPackage` are required. For `sdkType` of
|
3274
|
+
# `java`, parameters named `serviceName` and `javaPackageName` are
|
3275
|
+
# required.
|
3225
3276
|
#
|
3226
3277
|
# @return [Types::SdkResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3227
3278
|
#
|
@@ -4743,7 +4794,7 @@ module Aws::APIGateway
|
|
4743
4794
|
#
|
4744
4795
|
# resp.id #=> String
|
4745
4796
|
# resp.name #=> String
|
4746
|
-
# resp.type #=> String, one of "TOKEN", "COGNITO_USER_POOLS"
|
4797
|
+
# resp.type #=> String, one of "TOKEN", "REQUEST", "COGNITO_USER_POOLS"
|
4747
4798
|
# resp.provider_arns #=> Array
|
4748
4799
|
# resp.provider_arns[0] #=> String
|
4749
4800
|
# resp.auth_type #=> String
|
@@ -5835,7 +5886,7 @@ module Aws::APIGateway
|
|
5835
5886
|
params: params,
|
5836
5887
|
config: config)
|
5837
5888
|
context[:gem_name] = 'aws-sdk-apigateway'
|
5838
|
-
context[:gem_version] = '1.
|
5889
|
+
context[:gem_version] = '1.1.0'
|
5839
5890
|
Seahorse::Client::Request.new(handlers, context)
|
5840
5891
|
end
|
5841
5892
|
|
@@ -329,7 +329,7 @@ module Aws::APIGateway
|
|
329
329
|
CreateAuthorizerRequest.add_member(:auth_type, Shapes::ShapeRef.new(shape: String, location_name: "authType"))
|
330
330
|
CreateAuthorizerRequest.add_member(:authorizer_uri, Shapes::ShapeRef.new(shape: String, location_name: "authorizerUri"))
|
331
331
|
CreateAuthorizerRequest.add_member(:authorizer_credentials, Shapes::ShapeRef.new(shape: String, location_name: "authorizerCredentials"))
|
332
|
-
CreateAuthorizerRequest.add_member(:identity_source, Shapes::ShapeRef.new(shape: String,
|
332
|
+
CreateAuthorizerRequest.add_member(:identity_source, Shapes::ShapeRef.new(shape: String, location_name: "identitySource"))
|
333
333
|
CreateAuthorizerRequest.add_member(:identity_validation_expression, Shapes::ShapeRef.new(shape: String, location_name: "identityValidationExpression"))
|
334
334
|
CreateAuthorizerRequest.add_member(:authorizer_result_ttl_in_seconds, Shapes::ShapeRef.new(shape: NullableInteger, location_name: "authorizerResultTtlInSeconds"))
|
335
335
|
CreateAuthorizerRequest.struct_class = Types::CreateAuthorizerRequest
|
@@ -1507,6 +1507,8 @@ module Aws::APIGateway
|
|
1507
1507
|
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
1508
1508
|
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
1509
1509
|
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
1510
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
1511
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
1510
1512
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1511
1513
|
end)
|
1512
1514
|
|
@@ -233,27 +233,28 @@ module Aws::APIGateway
|
|
233
233
|
# @return [String]
|
234
234
|
#
|
235
235
|
# @!attribute [rw] type
|
236
|
-
# \[Required\] The type
|
237
|
-
#
|
238
|
-
#
|
236
|
+
# \[Required\] The authorizer type. Valid values are `TOKEN` for a
|
237
|
+
# Lambda function using a single authorization token submitted in a
|
238
|
+
# custom header, `REQUEST` for a Lambda function using incoming
|
239
|
+
# request parameters, and `COGNITO_USER_POOLS` for using an Amazon
|
240
|
+
# Cognito user pool.
|
239
241
|
# @return [String]
|
240
242
|
#
|
241
243
|
# @!attribute [rw] provider_arns
|
242
|
-
# A list of the
|
243
|
-
# authorizer
|
244
|
-
# `COGNITO_USER_POOLS` type, each element corresponds to a user pool
|
245
|
-
# ARN of this format:
|
244
|
+
# A list of the Amazon Cognito user pool ARNs for the
|
245
|
+
# `COGNITO_USER_POOLS` authorizer. Each element is of this format:
|
246
246
|
# `arn:aws:cognito-idp:\{region\}:\{account_id\}:userpool/\{user_pool_id\}`.
|
247
|
+
# For a `TOKEN` or `REQUEST` authorizer, this is not defined.
|
247
248
|
# @return [Array<String>]
|
248
249
|
#
|
249
250
|
# @!attribute [rw] auth_type
|
250
|
-
# Optional customer-defined field, used in Swagger imports
|
251
|
-
#
|
251
|
+
# Optional customer-defined field, used in Swagger imports and exports
|
252
|
+
# without functional impact.
|
252
253
|
# @return [String]
|
253
254
|
#
|
254
255
|
# @!attribute [rw] authorizer_uri
|
255
|
-
#
|
256
|
-
#
|
256
|
+
# Specifies the authorizer's Uniform Resource Identifier (URI). For
|
257
|
+
# `TOKEN` or `REQUEST` authorizers, this must be a well-formed Lambda
|
257
258
|
# function URI, for example,
|
258
259
|
# `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`.
|
259
260
|
# In general, the URI has this form
|
@@ -262,38 +263,57 @@ module Aws::APIGateway
|
|
262
263
|
# `path` indicates that the remaining substring in the URI should be
|
263
264
|
# treated as the path to the resource, including the initial `/`. For
|
264
265
|
# Lambda functions, this is usually of the form
|
265
|
-
#
|
266
|
+
# `/2015-03-31/functions/[FunctionARN]/invocations`.
|
266
267
|
# @return [String]
|
267
268
|
#
|
268
269
|
# @!attribute [rw] authorizer_credentials
|
269
|
-
# Specifies the credentials
|
270
|
-
#
|
271
|
-
# to assume, use the role's Amazon Resource Name (ARN).
|
272
|
-
# resource-based permissions on the Lambda function, specify
|
270
|
+
# Specifies the required credentials as an IAM role for Amazon API
|
271
|
+
# Gateway to invoke the authorizer. To specify an IAM role for Amazon
|
272
|
+
# API Gateway to assume, use the role's Amazon Resource Name (ARN).
|
273
|
+
# To use resource-based permissions on the Lambda function, specify
|
274
|
+
# null.
|
273
275
|
# @return [String]
|
274
276
|
#
|
275
277
|
# @!attribute [rw] identity_source
|
276
|
-
#
|
277
|
-
#
|
278
|
-
#
|
279
|
-
#
|
280
|
-
#
|
281
|
-
#
|
282
|
-
# `
|
278
|
+
# The identity source for which authorization is requested. * For a
|
279
|
+
# `TOKEN` authorizer, this is required and specifies the
|
280
|
+
# request header mapping expression for the custom header holding
|
281
|
+
# the authorization token submitted by the client. For example, if
|
282
|
+
# the token header name is `Auth`, the header mapping expression is
|
283
|
+
# `method.request.header.Auth`.
|
284
|
+
# * For the `REQUEST` authorizer, this is required when authorization
|
285
|
+
# caching is enabled. The value is a comma-separated string of one
|
286
|
+
# or more mapping expressions of the specified request parameters.
|
287
|
+
# For example, if an `Auth` header, a `Name` query string parameter
|
288
|
+
# are defined as identity sources, this value is
|
289
|
+
# `method.request.header.Auth, method.request.querystring.Name`.
|
290
|
+
# These parameters will be used to derive the authorization caching
|
291
|
+
# key and to perform runtime validation of the `REQUEST` authorizer
|
292
|
+
# by verifying all of the identity-related request parameters are
|
293
|
+
# present, not null and non-empty. Only when this is true does the
|
294
|
+
# authorizer invoke the authorizer Lambda function, otherwise, it
|
295
|
+
# returns a 401 Unauthorized response without calling the Lambda
|
296
|
+
# function. The valid value is a string of comma-separated mapping
|
297
|
+
# expressions of the specified request parameters. When the
|
298
|
+
# authorization caching is not enabled, this property is optional.
|
299
|
+
# * For a `COGNITO_USER_POOLS` authorizer, this property is not used.
|
283
300
|
# @return [String]
|
284
301
|
#
|
285
302
|
# @!attribute [rw] identity_validation_expression
|
286
|
-
# A validation expression for the incoming identity. For `TOKEN`
|
287
|
-
# authorizers, this value
|
288
|
-
# token from the client
|
289
|
-
#
|
290
|
-
#
|
303
|
+
# A validation expression for the incoming identity token. For `TOKEN`
|
304
|
+
# authorizers, this value is a regular expression. Amazon API Gateway
|
305
|
+
# will match the incoming token from the client against the specified
|
306
|
+
# regular expression. It will invoke the authorizer's Lambda function
|
307
|
+
# there is a match. Otherwise, it will return a 401 Unauthorized
|
308
|
+
# response without calling the Lambda function. The validation
|
309
|
+
# expression does not apply to the `REQUEST` authorizer.
|
291
310
|
# @return [String]
|
292
311
|
#
|
293
312
|
# @!attribute [rw] authorizer_result_ttl_in_seconds
|
294
|
-
# The TTL in seconds of cached authorizer results. If
|
295
|
-
#
|
296
|
-
#
|
313
|
+
# The TTL in seconds of cached authorizer results. If it equals 0,
|
314
|
+
# authorization caching is disabled. If it is greater than 0, API
|
315
|
+
# Gateway will cache authorizer responses. If this field is not set,
|
316
|
+
# the default value is 300. The maximum value is 3600, or 1 hour.
|
297
317
|
# @return [Integer]
|
298
318
|
#
|
299
319
|
class Authorizer < Struct.new(
|
@@ -396,9 +416,9 @@ module Aws::APIGateway
|
|
396
416
|
# authentication while sending requests to the integration endpoint.
|
397
417
|
#
|
398
418
|
# <div class="remarks">
|
399
|
-
# Client certificates are used authenticate an API by the
|
400
|
-
# server. To authenticate an API client (or user), use
|
401
|
-
# Authorizer.
|
419
|
+
# Client certificates are used to authenticate an API by the backend
|
420
|
+
# server. To authenticate an API client (or user), use IAM roles and
|
421
|
+
# policies, a custom Authorizer or an Amazon Cognito user pool.
|
402
422
|
# </div>
|
403
423
|
#
|
404
424
|
# <div class="seeAlso">
|
@@ -533,12 +553,12 @@ module Aws::APIGateway
|
|
533
553
|
# {
|
534
554
|
# rest_api_id: "String", # required
|
535
555
|
# name: "String", # required
|
536
|
-
# type: "TOKEN", # required, accepts TOKEN, COGNITO_USER_POOLS
|
556
|
+
# type: "TOKEN", # required, accepts TOKEN, REQUEST, COGNITO_USER_POOLS
|
537
557
|
# provider_arns: ["ProviderARN"],
|
538
558
|
# auth_type: "String",
|
539
559
|
# authorizer_uri: "String",
|
540
560
|
# authorizer_credentials: "String",
|
541
|
-
# identity_source: "String",
|
561
|
+
# identity_source: "String",
|
542
562
|
# identity_validation_expression: "String",
|
543
563
|
# authorizer_result_ttl_in_seconds: 1,
|
544
564
|
# }
|
@@ -552,37 +572,87 @@ module Aws::APIGateway
|
|
552
572
|
# @return [String]
|
553
573
|
#
|
554
574
|
# @!attribute [rw] type
|
555
|
-
# \[Required\] The type
|
575
|
+
# \[Required\] The authorizer type. Valid values are `TOKEN` for a
|
576
|
+
# Lambda function using a single authorization token submitted in a
|
577
|
+
# custom header, `REQUEST` for a Lambda function using incoming
|
578
|
+
# request parameters, and `COGNITO_USER_POOLS` for using an Amazon
|
579
|
+
# Cognito user pool.
|
556
580
|
# @return [String]
|
557
581
|
#
|
558
582
|
# @!attribute [rw] provider_arns
|
559
|
-
# A list of the Cognito
|
583
|
+
# A list of the Amazon Cognito user pool ARNs for the
|
584
|
+
# `COGNITO_USER_POOLS` authorizer. Each element is of this format:
|
585
|
+
# `arn:aws:cognito-idp:\{region\}:\{account_id\}:userpool/\{user_pool_id\}`.
|
586
|
+
# For a `TOKEN` or `REQUEST` authorizer, this is not defined.
|
560
587
|
# @return [Array<String>]
|
561
588
|
#
|
562
589
|
# @!attribute [rw] auth_type
|
563
|
-
# Optional customer-defined field, used in Swagger imports
|
564
|
-
#
|
590
|
+
# Optional customer-defined field, used in Swagger imports and exports
|
591
|
+
# without functional impact.
|
565
592
|
# @return [String]
|
566
593
|
#
|
567
594
|
# @!attribute [rw] authorizer_uri
|
568
|
-
#
|
569
|
-
#
|
595
|
+
# Specifies the authorizer's Uniform Resource Identifier (URI). For
|
596
|
+
# `TOKEN` or `REQUEST` authorizers, this must be a well-formed Lambda
|
597
|
+
# function URI, for example,
|
598
|
+
# `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`.
|
599
|
+
# In general, the URI has this form
|
600
|
+
# `arn:aws:apigateway:\{region\}:lambda:path/\{service_api\}`, where
|
601
|
+
# `\{region\}` is the same as the region hosting the Lambda function,
|
602
|
+
# `path` indicates that the remaining substring in the URI should be
|
603
|
+
# treated as the path to the resource, including the initial `/`. For
|
604
|
+
# Lambda functions, this is usually of the form
|
605
|
+
# `/2015-03-31/functions/[FunctionARN]/invocations`.
|
570
606
|
# @return [String]
|
571
607
|
#
|
572
608
|
# @!attribute [rw] authorizer_credentials
|
573
|
-
# Specifies the credentials
|
609
|
+
# Specifies the required credentials as an IAM role for Amazon API
|
610
|
+
# Gateway to invoke the authorizer. To specify an IAM role for Amazon
|
611
|
+
# API Gateway to assume, use the role's Amazon Resource Name (ARN).
|
612
|
+
# To use resource-based permissions on the Lambda function, specify
|
613
|
+
# null.
|
574
614
|
# @return [String]
|
575
615
|
#
|
576
616
|
# @!attribute [rw] identity_source
|
577
|
-
#
|
617
|
+
# The identity source for which authorization is requested. * For a
|
618
|
+
# `TOKEN` authorizer, this is required and specifies the
|
619
|
+
# request header mapping expression for the custom header holding
|
620
|
+
# the authorization token submitted by the client. For example, if
|
621
|
+
# the token header name is `Auth`, the header mapping expression is
|
622
|
+
# `method.request.header.Auth`.
|
623
|
+
# * For the `REQUEST` authorizer, this is required when authorization
|
624
|
+
# caching is enabled. The value is a comma-separated string of one
|
625
|
+
# or more mapping expressions of the specified request parameters.
|
626
|
+
# For example, if an `Auth` header, a `Name` query string parameter
|
627
|
+
# are defined as identity sources, this value is
|
628
|
+
# `method.request.header.Auth, method.request.querystring.Name`.
|
629
|
+
# These parameters will be used to derive the authorization caching
|
630
|
+
# key and to perform runtime validation of the `REQUEST` authorizer
|
631
|
+
# by verifying all of the identity-related request parameters are
|
632
|
+
# present, not null and non-empty. Only when this is true does the
|
633
|
+
# authorizer invoke the authorizer Lambda function, otherwise, it
|
634
|
+
# returns a 401 Unauthorized response without calling the Lambda
|
635
|
+
# function. The valid value is a string of comma-separated mapping
|
636
|
+
# expressions of the specified request parameters. When the
|
637
|
+
# authorization caching is not enabled, this property is optional.
|
638
|
+
# * For a `COGNITO_USER_POOLS` authorizer, this property is not used.
|
578
639
|
# @return [String]
|
579
640
|
#
|
580
641
|
# @!attribute [rw] identity_validation_expression
|
581
|
-
# A validation expression for the incoming identity.
|
642
|
+
# A validation expression for the incoming identity token. For `TOKEN`
|
643
|
+
# authorizers, this value is a regular expression. Amazon API Gateway
|
644
|
+
# will match the incoming token from the client against the specified
|
645
|
+
# regular expression. It will invoke the authorizer's Lambda function
|
646
|
+
# there is a match. Otherwise, it will return a 401 Unauthorized
|
647
|
+
# response without calling the Lambda function. The validation
|
648
|
+
# expression does not apply to the `REQUEST` authorizer.
|
582
649
|
# @return [String]
|
583
650
|
#
|
584
651
|
# @!attribute [rw] authorizer_result_ttl_in_seconds
|
585
|
-
# The TTL of cached authorizer results.
|
652
|
+
# The TTL in seconds of cached authorizer results. If it equals 0,
|
653
|
+
# authorization caching is disabled. If it is greater than 0, API
|
654
|
+
# Gateway will cache authorizer responses. If this field is not set,
|
655
|
+
# the default value is 300. The maximum value is 3600, or 1 hour.
|
586
656
|
# @return [Integer]
|
587
657
|
#
|
588
658
|
class CreateAuthorizerRequest < Struct.new(
|
@@ -853,7 +923,7 @@ module Aws::APIGateway
|
|
853
923
|
# @return [String]
|
854
924
|
#
|
855
925
|
# @!attribute [rw] name
|
856
|
-
# The name of the model.
|
926
|
+
# The name of the model. Must be alphanumeric.
|
857
927
|
# @return [String]
|
858
928
|
#
|
859
929
|
# @!attribute [rw] description
|
@@ -1850,7 +1920,7 @@ module Aws::APIGateway
|
|
1850
1920
|
# `AUTHORIZER`, `MODEL`, `RESOURCE`, `METHOD`, `PATH_PARAMETER`,
|
1851
1921
|
# `QUERY_PARAMETER`, `REQUEST_HEADER`, `REQUEST_BODY`, `RESPONSE`,
|
1852
1922
|
# `RESPONSE_HEADER`, and `RESPONSE_BODY`. Content inheritance does not
|
1853
|
-
# apply to any entity of the `API`, `
|
1923
|
+
# apply to any entity of the `API`, `AUTHORIZER`, `METHOD`, `MODEL`,
|
1854
1924
|
# `REQUEST_BODY`, or `RESOURCE` type.
|
1855
1925
|
# @return [String]
|
1856
1926
|
#
|
@@ -3332,16 +3402,18 @@ module Aws::APIGateway
|
|
3332
3402
|
# @return [String]
|
3333
3403
|
#
|
3334
3404
|
# @!attribute [rw] sdk_type
|
3335
|
-
# The language for the generated SDK. Currently `javascript`,
|
3336
|
-
# `android`, and `
|
3405
|
+
# The language for the generated SDK. Currently `java`, `javascript`,
|
3406
|
+
# `android`, `objectivec` and `swift` (for iOS) are supported.
|
3337
3407
|
# @return [String]
|
3338
3408
|
#
|
3339
3409
|
# @!attribute [rw] parameters
|
3340
|
-
# A key-value map of query
|
3341
|
-
# of the SDK
|
3342
|
-
# `objectivec`, a parameter named `classPrefix` is
|
3343
|
-
# `sdkType` of `android`, parameters named `groupId`,
|
3344
|
-
# `artifactVersion`, and `invokerPackage` are required.
|
3410
|
+
# A string-to-string key-value map of query parameters
|
3411
|
+
# `sdkType`-dependent properties of the SDK. For `sdkType` of
|
3412
|
+
# `objectivec` or `swift`, a parameter named `classPrefix` is
|
3413
|
+
# required. For `sdkType` of `android`, parameters named `groupId`,
|
3414
|
+
# `artifactId`, `artifactVersion`, and `invokerPackage` are required.
|
3415
|
+
# For `sdkType` of `java`, parameters named `serviceName` and
|
3416
|
+
# `javaPackageName` are required.
|
3345
3417
|
# @return [Hash<String,String>]
|
3346
3418
|
#
|
3347
3419
|
class GetSdkRequest < Struct.new(
|
@@ -4382,7 +4454,7 @@ module Aws::APIGateway
|
|
4382
4454
|
# @return [String]
|
4383
4455
|
#
|
4384
4456
|
# @!attribute [rw] name
|
4385
|
-
# The name of the model.
|
4457
|
+
# The name of the model. Must be an alphanumeric string.
|
4386
4458
|
# @return [String]
|
4387
4459
|
#
|
4388
4460
|
# @!attribute [rw] description
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-apigateway
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.1.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2017-
|
11
|
+
date: 2017-09-15 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -57,7 +57,9 @@ files:
|
|
57
57
|
homepage: http://github.com/aws/aws-sdk-ruby
|
58
58
|
licenses:
|
59
59
|
- Apache-2.0
|
60
|
-
metadata:
|
60
|
+
metadata:
|
61
|
+
source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-apigateway
|
62
|
+
changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-apigateway/CHANGELOG.md
|
61
63
|
post_install_message:
|
62
64
|
rdoc_options: []
|
63
65
|
require_paths:
|