aws-sdk-apigatewayv2 1.25.0 → 1.26.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-apigatewayv2.rb +1 -1
- data/lib/aws-sdk-apigatewayv2/client.rb +62 -9
- data/lib/aws-sdk-apigatewayv2/client_api.rb +31 -0
- data/lib/aws-sdk-apigatewayv2/types.rb +273 -91
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: fcc4304d259f94361ba55c9f83f56deadb2bcc16c9609644607758fc040cc43f
|
4
|
+
data.tar.gz: 351d8f10eb4ff1b171b88380c133a12a66da57defeb336fb9aa139df0a7b2b87
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 688c43a7139413cd00a3cd5a0a4de722c523e8e84a6da1a20d5cea82b4242cad25defe39b07ca2f4d7d29e909b1d43e74dbf51392400de6602060d4b73d476ed
|
7
|
+
data.tar.gz: 04d4cb904ecd280b823a6b10cffc384b183a7ac42f8168b8150d4a805aeb150b32604c5b6cc6fe4a5db414afef5ad343572d10d20dbb69a23b6d0575603562a1
|
data/lib/aws-sdk-apigatewayv2.rb
CHANGED
@@ -528,9 +528,9 @@ module Aws::ApiGatewayV2
|
|
528
528
|
# An integer with a value between \[0-3600\].
|
529
529
|
#
|
530
530
|
# @option params [required, String] :authorizer_type
|
531
|
-
# The authorizer type.
|
532
|
-
#
|
533
|
-
#
|
531
|
+
# The authorizer type. Specify REQUEST for a Lambda function using
|
532
|
+
# incoming request parameters. Specify JWT to use JSON Web Tokens
|
533
|
+
# (supported only for HTTP APIs).
|
534
534
|
#
|
535
535
|
# @option params [String] :authorizer_uri
|
536
536
|
# A string representation of a URI with a length between \[1-2048\].
|
@@ -562,6 +562,11 @@ module Aws::ApiGatewayV2
|
|
562
562
|
# @option params [required, String] :name
|
563
563
|
# A string with a length between \[1-128\].
|
564
564
|
#
|
565
|
+
# @option params [String] :authorizer_payload_format_version
|
566
|
+
# A string with a length between \[1-64\].
|
567
|
+
#
|
568
|
+
# @option params [Boolean] :enable_simple_responses
|
569
|
+
#
|
565
570
|
# @return [Types::CreateAuthorizerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
566
571
|
#
|
567
572
|
# * {Types::CreateAuthorizerResponse#authorizer_credentials_arn #authorizer_credentials_arn} => String
|
@@ -573,6 +578,8 @@ module Aws::ApiGatewayV2
|
|
573
578
|
# * {Types::CreateAuthorizerResponse#identity_validation_expression #identity_validation_expression} => String
|
574
579
|
# * {Types::CreateAuthorizerResponse#jwt_configuration #jwt_configuration} => Types::JWTConfiguration
|
575
580
|
# * {Types::CreateAuthorizerResponse#name #name} => String
|
581
|
+
# * {Types::CreateAuthorizerResponse#authorizer_payload_format_version #authorizer_payload_format_version} => String
|
582
|
+
# * {Types::CreateAuthorizerResponse#enable_simple_responses #enable_simple_responses} => Boolean
|
576
583
|
#
|
577
584
|
# @example Request syntax with placeholder values
|
578
585
|
#
|
@@ -589,6 +596,8 @@ module Aws::ApiGatewayV2
|
|
589
596
|
# issuer: "UriWithLengthBetween1And2048",
|
590
597
|
# },
|
591
598
|
# name: "StringWithLengthBetween1And128", # required
|
599
|
+
# authorizer_payload_format_version: "StringWithLengthBetween1And64",
|
600
|
+
# enable_simple_responses: false,
|
592
601
|
# })
|
593
602
|
#
|
594
603
|
# @example Response structure
|
@@ -605,6 +614,8 @@ module Aws::ApiGatewayV2
|
|
605
614
|
# resp.jwt_configuration.audience[0] #=> String
|
606
615
|
# resp.jwt_configuration.issuer #=> String
|
607
616
|
# resp.name #=> String
|
617
|
+
# resp.authorizer_payload_format_version #=> String
|
618
|
+
# resp.enable_simple_responses #=> Boolean
|
608
619
|
#
|
609
620
|
# @overload create_authorizer(params = {})
|
610
621
|
# @param [Hash] params ({})
|
@@ -1032,7 +1043,8 @@ module Aws::ApiGatewayV2
|
|
1032
1043
|
# The authorization type. For WebSocket APIs, valid values are NONE for
|
1033
1044
|
# open access, AWS\_IAM for using AWS IAM permissions, and CUSTOM for
|
1034
1045
|
# using a Lambda authorizer. For HTTP APIs, valid values are NONE for
|
1035
|
-
# open access,
|
1046
|
+
# open access, JWT for using JSON Web Tokens, AWS\_IAM for using AWS IAM
|
1047
|
+
# permissions, and CUSTOM for using a Lambda authorizer.
|
1036
1048
|
#
|
1037
1049
|
# @option params [String] :authorizer_id
|
1038
1050
|
# The identifier.
|
@@ -1788,6 +1800,29 @@ module Aws::ApiGatewayV2
|
|
1788
1800
|
req.send_request(options)
|
1789
1801
|
end
|
1790
1802
|
|
1803
|
+
# Resets all authorizer cache entries for the specified stage. Supported
|
1804
|
+
# only for HTTP API Lambda authorizers.
|
1805
|
+
#
|
1806
|
+
# @option params [required, String] :api_id
|
1807
|
+
#
|
1808
|
+
# @option params [required, String] :stage_name
|
1809
|
+
#
|
1810
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1811
|
+
#
|
1812
|
+
# @example Request syntax with placeholder values
|
1813
|
+
#
|
1814
|
+
# resp = client.reset_authorizers_cache({
|
1815
|
+
# api_id: "__string", # required
|
1816
|
+
# stage_name: "__string", # required
|
1817
|
+
# })
|
1818
|
+
#
|
1819
|
+
# @overload reset_authorizers_cache(params = {})
|
1820
|
+
# @param [Hash] params ({})
|
1821
|
+
def reset_authorizers_cache(params = {}, options = {})
|
1822
|
+
req = build_request(:reset_authorizers_cache, params)
|
1823
|
+
req.send_request(options)
|
1824
|
+
end
|
1825
|
+
|
1791
1826
|
# Gets an Api resource.
|
1792
1827
|
#
|
1793
1828
|
# @option params [required, String] :api_id
|
@@ -1998,6 +2033,8 @@ module Aws::ApiGatewayV2
|
|
1998
2033
|
# * {Types::GetAuthorizerResponse#identity_validation_expression #identity_validation_expression} => String
|
1999
2034
|
# * {Types::GetAuthorizerResponse#jwt_configuration #jwt_configuration} => Types::JWTConfiguration
|
2000
2035
|
# * {Types::GetAuthorizerResponse#name #name} => String
|
2036
|
+
# * {Types::GetAuthorizerResponse#authorizer_payload_format_version #authorizer_payload_format_version} => String
|
2037
|
+
# * {Types::GetAuthorizerResponse#enable_simple_responses #enable_simple_responses} => Boolean
|
2001
2038
|
#
|
2002
2039
|
# @example Request syntax with placeholder values
|
2003
2040
|
#
|
@@ -2020,6 +2057,8 @@ module Aws::ApiGatewayV2
|
|
2020
2057
|
# resp.jwt_configuration.audience[0] #=> String
|
2021
2058
|
# resp.jwt_configuration.issuer #=> String
|
2022
2059
|
# resp.name #=> String
|
2060
|
+
# resp.authorizer_payload_format_version #=> String
|
2061
|
+
# resp.enable_simple_responses #=> Boolean
|
2023
2062
|
#
|
2024
2063
|
# @overload get_authorizer(params = {})
|
2025
2064
|
# @param [Hash] params ({})
|
@@ -2064,6 +2103,8 @@ module Aws::ApiGatewayV2
|
|
2064
2103
|
# resp.items[0].jwt_configuration.audience[0] #=> String
|
2065
2104
|
# resp.items[0].jwt_configuration.issuer #=> String
|
2066
2105
|
# resp.items[0].name #=> String
|
2106
|
+
# resp.items[0].authorizer_payload_format_version #=> String
|
2107
|
+
# resp.items[0].enable_simple_responses #=> Boolean
|
2067
2108
|
# resp.next_token #=> String
|
2068
2109
|
#
|
2069
2110
|
# @overload get_authorizers(params = {})
|
@@ -3360,9 +3401,9 @@ module Aws::ApiGatewayV2
|
|
3360
3401
|
# An integer with a value between \[0-3600\].
|
3361
3402
|
#
|
3362
3403
|
# @option params [String] :authorizer_type
|
3363
|
-
# The authorizer type.
|
3364
|
-
#
|
3365
|
-
#
|
3404
|
+
# The authorizer type. Specify REQUEST for a Lambda function using
|
3405
|
+
# incoming request parameters. Specify JWT to use JSON Web Tokens
|
3406
|
+
# (supported only for HTTP APIs).
|
3366
3407
|
#
|
3367
3408
|
# @option params [String] :authorizer_uri
|
3368
3409
|
# A string representation of a URI with a length between \[1-2048\].
|
@@ -3394,6 +3435,11 @@ module Aws::ApiGatewayV2
|
|
3394
3435
|
# @option params [String] :name
|
3395
3436
|
# A string with a length between \[1-128\].
|
3396
3437
|
#
|
3438
|
+
# @option params [String] :authorizer_payload_format_version
|
3439
|
+
# A string with a length between \[1-64\].
|
3440
|
+
#
|
3441
|
+
# @option params [Boolean] :enable_simple_responses
|
3442
|
+
#
|
3397
3443
|
# @return [Types::UpdateAuthorizerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3398
3444
|
#
|
3399
3445
|
# * {Types::UpdateAuthorizerResponse#authorizer_credentials_arn #authorizer_credentials_arn} => String
|
@@ -3405,6 +3451,8 @@ module Aws::ApiGatewayV2
|
|
3405
3451
|
# * {Types::UpdateAuthorizerResponse#identity_validation_expression #identity_validation_expression} => String
|
3406
3452
|
# * {Types::UpdateAuthorizerResponse#jwt_configuration #jwt_configuration} => Types::JWTConfiguration
|
3407
3453
|
# * {Types::UpdateAuthorizerResponse#name #name} => String
|
3454
|
+
# * {Types::UpdateAuthorizerResponse#authorizer_payload_format_version #authorizer_payload_format_version} => String
|
3455
|
+
# * {Types::UpdateAuthorizerResponse#enable_simple_responses #enable_simple_responses} => Boolean
|
3408
3456
|
#
|
3409
3457
|
# @example Request syntax with placeholder values
|
3410
3458
|
#
|
@@ -3422,6 +3470,8 @@ module Aws::ApiGatewayV2
|
|
3422
3470
|
# issuer: "UriWithLengthBetween1And2048",
|
3423
3471
|
# },
|
3424
3472
|
# name: "StringWithLengthBetween1And128",
|
3473
|
+
# authorizer_payload_format_version: "StringWithLengthBetween1And64",
|
3474
|
+
# enable_simple_responses: false,
|
3425
3475
|
# })
|
3426
3476
|
#
|
3427
3477
|
# @example Response structure
|
@@ -3438,6 +3488,8 @@ module Aws::ApiGatewayV2
|
|
3438
3488
|
# resp.jwt_configuration.audience[0] #=> String
|
3439
3489
|
# resp.jwt_configuration.issuer #=> String
|
3440
3490
|
# resp.name #=> String
|
3491
|
+
# resp.authorizer_payload_format_version #=> String
|
3492
|
+
# resp.enable_simple_responses #=> Boolean
|
3441
3493
|
#
|
3442
3494
|
# @overload update_authorizer(params = {})
|
3443
3495
|
# @param [Hash] params ({})
|
@@ -3866,7 +3918,8 @@ module Aws::ApiGatewayV2
|
|
3866
3918
|
# The authorization type. For WebSocket APIs, valid values are NONE for
|
3867
3919
|
# open access, AWS\_IAM for using AWS IAM permissions, and CUSTOM for
|
3868
3920
|
# using a Lambda authorizer. For HTTP APIs, valid values are NONE for
|
3869
|
-
# open access,
|
3921
|
+
# open access, JWT for using JSON Web Tokens, AWS\_IAM for using AWS IAM
|
3922
|
+
# permissions, and CUSTOM for using a Lambda authorizer.
|
3870
3923
|
#
|
3871
3924
|
# @option params [String] :authorizer_id
|
3872
3925
|
# The identifier.
|
@@ -4229,7 +4282,7 @@ module Aws::ApiGatewayV2
|
|
4229
4282
|
params: params,
|
4230
4283
|
config: config)
|
4231
4284
|
context[:gem_name] = 'aws-sdk-apigatewayv2'
|
4232
|
-
context[:gem_version] = '1.
|
4285
|
+
context[:gem_version] = '1.26.0'
|
4233
4286
|
Seahorse::Client::Request.new(handlers, context)
|
4234
4287
|
end
|
4235
4288
|
|
@@ -177,6 +177,7 @@ module Aws::ApiGatewayV2
|
|
177
177
|
ReimportApiInput = Shapes::StructureShape.new(name: 'ReimportApiInput')
|
178
178
|
ReimportApiRequest = Shapes::StructureShape.new(name: 'ReimportApiRequest')
|
179
179
|
ReimportApiResponse = Shapes::StructureShape.new(name: 'ReimportApiResponse')
|
180
|
+
ResetAuthorizersCacheRequest = Shapes::StructureShape.new(name: 'ResetAuthorizersCacheRequest')
|
180
181
|
Route = Shapes::StructureShape.new(name: 'Route')
|
181
182
|
RouteModels = Shapes::MapShape.new(name: 'RouteModels')
|
182
183
|
RouteParameters = Shapes::MapShape.new(name: 'RouteParameters')
|
@@ -323,6 +324,8 @@ module Aws::ApiGatewayV2
|
|
323
324
|
Authorizer.add_member(:identity_validation_expression, Shapes::ShapeRef.new(shape: StringWithLengthBetween0And1024, location_name: "identityValidationExpression"))
|
324
325
|
Authorizer.add_member(:jwt_configuration, Shapes::ShapeRef.new(shape: JWTConfiguration, location_name: "jwtConfiguration"))
|
325
326
|
Authorizer.add_member(:name, Shapes::ShapeRef.new(shape: StringWithLengthBetween1And128, required: true, location_name: "name"))
|
327
|
+
Authorizer.add_member(:authorizer_payload_format_version, Shapes::ShapeRef.new(shape: StringWithLengthBetween1And64, location_name: "authorizerPayloadFormatVersion"))
|
328
|
+
Authorizer.add_member(:enable_simple_responses, Shapes::ShapeRef.new(shape: __boolean, location_name: "enableSimpleResponses"))
|
326
329
|
Authorizer.struct_class = Types::Authorizer
|
327
330
|
|
328
331
|
Authorizers.add_member(:items, Shapes::ShapeRef.new(shape: __listOfAuthorizer, location_name: "items"))
|
@@ -419,6 +422,8 @@ module Aws::ApiGatewayV2
|
|
419
422
|
CreateAuthorizerInput.add_member(:identity_validation_expression, Shapes::ShapeRef.new(shape: StringWithLengthBetween0And1024, location_name: "identityValidationExpression"))
|
420
423
|
CreateAuthorizerInput.add_member(:jwt_configuration, Shapes::ShapeRef.new(shape: JWTConfiguration, location_name: "jwtConfiguration"))
|
421
424
|
CreateAuthorizerInput.add_member(:name, Shapes::ShapeRef.new(shape: StringWithLengthBetween1And128, required: true, location_name: "name"))
|
425
|
+
CreateAuthorizerInput.add_member(:authorizer_payload_format_version, Shapes::ShapeRef.new(shape: StringWithLengthBetween1And64, location_name: "authorizerPayloadFormatVersion"))
|
426
|
+
CreateAuthorizerInput.add_member(:enable_simple_responses, Shapes::ShapeRef.new(shape: __boolean, location_name: "enableSimpleResponses"))
|
422
427
|
CreateAuthorizerInput.struct_class = Types::CreateAuthorizerInput
|
423
428
|
|
424
429
|
CreateAuthorizerRequest.add_member(:api_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "apiId"))
|
@@ -430,6 +435,8 @@ module Aws::ApiGatewayV2
|
|
430
435
|
CreateAuthorizerRequest.add_member(:identity_validation_expression, Shapes::ShapeRef.new(shape: StringWithLengthBetween0And1024, location_name: "identityValidationExpression"))
|
431
436
|
CreateAuthorizerRequest.add_member(:jwt_configuration, Shapes::ShapeRef.new(shape: JWTConfiguration, location_name: "jwtConfiguration"))
|
432
437
|
CreateAuthorizerRequest.add_member(:name, Shapes::ShapeRef.new(shape: StringWithLengthBetween1And128, required: true, location_name: "name"))
|
438
|
+
CreateAuthorizerRequest.add_member(:authorizer_payload_format_version, Shapes::ShapeRef.new(shape: StringWithLengthBetween1And64, location_name: "authorizerPayloadFormatVersion"))
|
439
|
+
CreateAuthorizerRequest.add_member(:enable_simple_responses, Shapes::ShapeRef.new(shape: __boolean, location_name: "enableSimpleResponses"))
|
433
440
|
CreateAuthorizerRequest.struct_class = Types::CreateAuthorizerRequest
|
434
441
|
|
435
442
|
CreateAuthorizerResponse.add_member(:authorizer_credentials_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "authorizerCredentialsArn"))
|
@@ -441,6 +448,8 @@ module Aws::ApiGatewayV2
|
|
441
448
|
CreateAuthorizerResponse.add_member(:identity_validation_expression, Shapes::ShapeRef.new(shape: StringWithLengthBetween0And1024, location_name: "identityValidationExpression"))
|
442
449
|
CreateAuthorizerResponse.add_member(:jwt_configuration, Shapes::ShapeRef.new(shape: JWTConfiguration, location_name: "jwtConfiguration"))
|
443
450
|
CreateAuthorizerResponse.add_member(:name, Shapes::ShapeRef.new(shape: StringWithLengthBetween1And128, location_name: "name"))
|
451
|
+
CreateAuthorizerResponse.add_member(:authorizer_payload_format_version, Shapes::ShapeRef.new(shape: StringWithLengthBetween1And64, location_name: "authorizerPayloadFormatVersion"))
|
452
|
+
CreateAuthorizerResponse.add_member(:enable_simple_responses, Shapes::ShapeRef.new(shape: __boolean, location_name: "enableSimpleResponses"))
|
444
453
|
CreateAuthorizerResponse.struct_class = Types::CreateAuthorizerResponse
|
445
454
|
|
446
455
|
CreateDeploymentInput.add_member(:description, Shapes::ShapeRef.new(shape: StringWithLengthBetween0And1024, location_name: "description"))
|
@@ -879,6 +888,8 @@ module Aws::ApiGatewayV2
|
|
879
888
|
GetAuthorizerResponse.add_member(:identity_validation_expression, Shapes::ShapeRef.new(shape: StringWithLengthBetween0And1024, location_name: "identityValidationExpression"))
|
880
889
|
GetAuthorizerResponse.add_member(:jwt_configuration, Shapes::ShapeRef.new(shape: JWTConfiguration, location_name: "jwtConfiguration"))
|
881
890
|
GetAuthorizerResponse.add_member(:name, Shapes::ShapeRef.new(shape: StringWithLengthBetween1And128, location_name: "name"))
|
891
|
+
GetAuthorizerResponse.add_member(:authorizer_payload_format_version, Shapes::ShapeRef.new(shape: StringWithLengthBetween1And64, location_name: "authorizerPayloadFormatVersion"))
|
892
|
+
GetAuthorizerResponse.add_member(:enable_simple_responses, Shapes::ShapeRef.new(shape: __boolean, location_name: "enableSimpleResponses"))
|
882
893
|
GetAuthorizerResponse.struct_class = Types::GetAuthorizerResponse
|
883
894
|
|
884
895
|
GetAuthorizersRequest.add_member(:api_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "apiId"))
|
@@ -1238,6 +1249,10 @@ module Aws::ApiGatewayV2
|
|
1238
1249
|
ReimportApiResponse.add_member(:warnings, Shapes::ShapeRef.new(shape: __listOf__string, location_name: "warnings"))
|
1239
1250
|
ReimportApiResponse.struct_class = Types::ReimportApiResponse
|
1240
1251
|
|
1252
|
+
ResetAuthorizersCacheRequest.add_member(:api_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "apiId"))
|
1253
|
+
ResetAuthorizersCacheRequest.add_member(:stage_name, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "stageName"))
|
1254
|
+
ResetAuthorizersCacheRequest.struct_class = Types::ResetAuthorizersCacheRequest
|
1255
|
+
|
1241
1256
|
Route.add_member(:api_gateway_managed, Shapes::ShapeRef.new(shape: __boolean, location_name: "apiGatewayManaged"))
|
1242
1257
|
Route.add_member(:api_key_required, Shapes::ShapeRef.new(shape: __boolean, location_name: "apiKeyRequired"))
|
1243
1258
|
Route.add_member(:authorization_scopes, Shapes::ShapeRef.new(shape: AuthorizationScopes, location_name: "authorizationScopes"))
|
@@ -1411,6 +1426,8 @@ module Aws::ApiGatewayV2
|
|
1411
1426
|
UpdateAuthorizerInput.add_member(:identity_validation_expression, Shapes::ShapeRef.new(shape: StringWithLengthBetween0And1024, location_name: "identityValidationExpression"))
|
1412
1427
|
UpdateAuthorizerInput.add_member(:jwt_configuration, Shapes::ShapeRef.new(shape: JWTConfiguration, location_name: "jwtConfiguration"))
|
1413
1428
|
UpdateAuthorizerInput.add_member(:name, Shapes::ShapeRef.new(shape: StringWithLengthBetween1And128, location_name: "name"))
|
1429
|
+
UpdateAuthorizerInput.add_member(:authorizer_payload_format_version, Shapes::ShapeRef.new(shape: StringWithLengthBetween1And64, location_name: "authorizerPayloadFormatVersion"))
|
1430
|
+
UpdateAuthorizerInput.add_member(:enable_simple_responses, Shapes::ShapeRef.new(shape: __boolean, location_name: "enableSimpleResponses"))
|
1414
1431
|
UpdateAuthorizerInput.struct_class = Types::UpdateAuthorizerInput
|
1415
1432
|
|
1416
1433
|
UpdateAuthorizerRequest.add_member(:api_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "apiId"))
|
@@ -1423,6 +1440,8 @@ module Aws::ApiGatewayV2
|
|
1423
1440
|
UpdateAuthorizerRequest.add_member(:identity_validation_expression, Shapes::ShapeRef.new(shape: StringWithLengthBetween0And1024, location_name: "identityValidationExpression"))
|
1424
1441
|
UpdateAuthorizerRequest.add_member(:jwt_configuration, Shapes::ShapeRef.new(shape: JWTConfiguration, location_name: "jwtConfiguration"))
|
1425
1442
|
UpdateAuthorizerRequest.add_member(:name, Shapes::ShapeRef.new(shape: StringWithLengthBetween1And128, location_name: "name"))
|
1443
|
+
UpdateAuthorizerRequest.add_member(:authorizer_payload_format_version, Shapes::ShapeRef.new(shape: StringWithLengthBetween1And64, location_name: "authorizerPayloadFormatVersion"))
|
1444
|
+
UpdateAuthorizerRequest.add_member(:enable_simple_responses, Shapes::ShapeRef.new(shape: __boolean, location_name: "enableSimpleResponses"))
|
1426
1445
|
UpdateAuthorizerRequest.struct_class = Types::UpdateAuthorizerRequest
|
1427
1446
|
|
1428
1447
|
UpdateAuthorizerResponse.add_member(:authorizer_credentials_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "authorizerCredentialsArn"))
|
@@ -1434,6 +1453,8 @@ module Aws::ApiGatewayV2
|
|
1434
1453
|
UpdateAuthorizerResponse.add_member(:identity_validation_expression, Shapes::ShapeRef.new(shape: StringWithLengthBetween0And1024, location_name: "identityValidationExpression"))
|
1435
1454
|
UpdateAuthorizerResponse.add_member(:jwt_configuration, Shapes::ShapeRef.new(shape: JWTConfiguration, location_name: "jwtConfiguration"))
|
1436
1455
|
UpdateAuthorizerResponse.add_member(:name, Shapes::ShapeRef.new(shape: StringWithLengthBetween1And128, location_name: "name"))
|
1456
|
+
UpdateAuthorizerResponse.add_member(:authorizer_payload_format_version, Shapes::ShapeRef.new(shape: StringWithLengthBetween1And64, location_name: "authorizerPayloadFormatVersion"))
|
1457
|
+
UpdateAuthorizerResponse.add_member(:enable_simple_responses, Shapes::ShapeRef.new(shape: __boolean, location_name: "enableSimpleResponses"))
|
1437
1458
|
UpdateAuthorizerResponse.struct_class = Types::UpdateAuthorizerResponse
|
1438
1459
|
|
1439
1460
|
UpdateDeploymentInput.add_member(:description, Shapes::ShapeRef.new(shape: StringWithLengthBetween0And1024, location_name: "description"))
|
@@ -2065,6 +2086,16 @@ module Aws::ApiGatewayV2
|
|
2065
2086
|
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
2066
2087
|
end)
|
2067
2088
|
|
2089
|
+
api.add_operation(:reset_authorizers_cache, Seahorse::Model::Operation.new.tap do |o|
|
2090
|
+
o.name = "ResetAuthorizersCache"
|
2091
|
+
o.http_method = "DELETE"
|
2092
|
+
o.http_request_uri = "/v2/apis/{apiId}/stages/{stageName}/cache/authorizers"
|
2093
|
+
o.input = Shapes::ShapeRef.new(shape: ResetAuthorizersCacheRequest)
|
2094
|
+
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
2095
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
2096
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
2097
|
+
end)
|
2098
|
+
|
2068
2099
|
api.add_operation(:get_api, Seahorse::Model::Operation.new.tap do |o|
|
2069
2100
|
o.name = "GetApi"
|
2070
2101
|
o.http_method = "GET"
|
@@ -214,8 +214,8 @@ module Aws::ApiGatewayV2
|
|
214
214
|
# Specifies the required credentials as an IAM role for API Gateway to
|
215
215
|
# invoke the authorizer. To specify an IAM role for API Gateway to
|
216
216
|
# assume, use the role's Amazon Resource Name (ARN). To use
|
217
|
-
# resource-based permissions on the Lambda function, specify
|
218
|
-
# Supported only for REQUEST authorizers.
|
217
|
+
# resource-based permissions on the Lambda function, don't specify
|
218
|
+
# this parameter. Supported only for REQUEST authorizers.
|
219
219
|
# @return [String]
|
220
220
|
#
|
221
221
|
# @!attribute [rw] authorizer_id
|
@@ -223,18 +223,20 @@ module Aws::ApiGatewayV2
|
|
223
223
|
# @return [String]
|
224
224
|
#
|
225
225
|
# @!attribute [rw] authorizer_result_ttl_in_seconds
|
226
|
-
#
|
227
|
-
#
|
226
|
+
# The time to live (TTL) for cached authorizer results, in seconds. If
|
227
|
+
# it equals 0, authorization caching is disabled. If it is greater
|
228
|
+
# than 0, API Gateway caches authorizer responses. The maximum value
|
229
|
+
# is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
|
228
230
|
# @return [Integer]
|
229
231
|
#
|
230
232
|
# @!attribute [rw] authorizer_type
|
231
|
-
# The authorizer type.
|
232
|
-
#
|
233
|
-
#
|
233
|
+
# The authorizer type. Specify REQUEST for a Lambda function using
|
234
|
+
# incoming request parameters. Specify JWT to use JSON Web Tokens
|
235
|
+
# (supported only for HTTP APIs).
|
234
236
|
# @return [String]
|
235
237
|
#
|
236
238
|
# @!attribute [rw] authorizer_uri
|
237
|
-
# The authorizer's Uniform Resource Identifier (URI).
|
239
|
+
# The authorizer's Uniform Resource Identifier (URI). For REQUEST
|
238
240
|
# authorizers, this must be a well-formed Lambda function URI, for
|
239
241
|
# example,
|
240
242
|
# 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.
|
@@ -255,22 +257,30 @@ module Aws::ApiGatewayV2
|
|
255
257
|
#
|
256
258
|
# For a REQUEST authorizer, this is optional. The value is a set of
|
257
259
|
# one or more mapping expressions of the specified request parameters.
|
258
|
-
#
|
259
|
-
#
|
260
|
-
#
|
261
|
-
#
|
262
|
-
# route.request.querystring.Name
|
263
|
-
#
|
264
|
-
#
|
265
|
-
#
|
266
|
-
#
|
267
|
-
#
|
268
|
-
# function.
|
260
|
+
# The identity source can be headers, query string parameters, stage
|
261
|
+
# variables, and context parameters. For example, if an Auth header
|
262
|
+
# and a Name query string parameter are defined as identity sources,
|
263
|
+
# this value is route.request.header.Auth,
|
264
|
+
# route.request.querystring.Name for WebSocket APIs. For HTTP APIs,
|
265
|
+
# use selection expressions prefixed with $, for example,
|
266
|
+
# $request.header.Auth, $request.querystring.Name. These parameters
|
267
|
+
# are used to perform runtime validation for Lambda-based authorizers
|
268
|
+
# by verifying all of the identity-related request parameters are
|
269
|
+
# present in the request, not null, and non-empty. Only when this is
|
270
|
+
# true does the authorizer invoke the authorizer Lambda function.
|
271
|
+
# Otherwise, it returns a 401 Unauthorized response without calling
|
272
|
+
# the Lambda function. For HTTP APIs, identity sources are also used
|
273
|
+
# as the cache key when caching is enabled. To learn more, see
|
274
|
+
# [Working with AWS Lambda authorizers for HTTP APIs][1].
|
269
275
|
#
|
270
276
|
# For JWT, a single entry that specifies where to extract the JSON Web
|
271
277
|
# Token (JWT) from inbound requests. Currently only header-based and
|
272
278
|
# query parameter-based selections are supported, for example
|
273
|
-
#
|
279
|
+
# $request.header.Authorization.
|
280
|
+
#
|
281
|
+
#
|
282
|
+
#
|
283
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html
|
274
284
|
# @return [Array<String>]
|
275
285
|
#
|
276
286
|
# @!attribute [rw] identity_validation_expression
|
@@ -286,6 +296,28 @@ module Aws::ApiGatewayV2
|
|
286
296
|
# The name of the authorizer.
|
287
297
|
# @return [String]
|
288
298
|
#
|
299
|
+
# @!attribute [rw] authorizer_payload_format_version
|
300
|
+
# Specifies the format of the payload sent to an HTTP API Lambda
|
301
|
+
# authorizer. Required for HTTP API Lambda authorizers. Supported
|
302
|
+
# values are 1.0 and 2.0. To learn more, see [Working with AWS Lambda
|
303
|
+
# authorizers for HTTP APIs][1].
|
304
|
+
#
|
305
|
+
#
|
306
|
+
#
|
307
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html
|
308
|
+
# @return [String]
|
309
|
+
#
|
310
|
+
# @!attribute [rw] enable_simple_responses
|
311
|
+
# Specifies whether a Lambda authorizer returns a response in a simple
|
312
|
+
# format. If enabled, the Lambda authorizer can return a boolean value
|
313
|
+
# instead of an IAM policy. Supported only for HTTP APIs. To learn
|
314
|
+
# more, see [Working with AWS Lambda authorizers for HTTP APIs][1]
|
315
|
+
#
|
316
|
+
#
|
317
|
+
#
|
318
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html
|
319
|
+
# @return [Boolean]
|
320
|
+
#
|
289
321
|
class Authorizer < Struct.new(
|
290
322
|
:authorizer_credentials_arn,
|
291
323
|
:authorizer_id,
|
@@ -295,7 +327,9 @@ module Aws::ApiGatewayV2
|
|
295
327
|
:identity_source,
|
296
328
|
:identity_validation_expression,
|
297
329
|
:jwt_configuration,
|
298
|
-
:name
|
330
|
+
:name,
|
331
|
+
:authorizer_payload_format_version,
|
332
|
+
:enable_simple_responses)
|
299
333
|
SENSITIVE = []
|
300
334
|
include Aws::Structure
|
301
335
|
end
|
@@ -809,19 +843,21 @@ module Aws::ApiGatewayV2
|
|
809
843
|
# Specifies the required credentials as an IAM role for API Gateway to
|
810
844
|
# invoke the authorizer. To specify an IAM role for API Gateway to
|
811
845
|
# assume, use the role's Amazon Resource Name (ARN). To use
|
812
|
-
# resource-based permissions on the Lambda function, specify
|
813
|
-
# Supported only for REQUEST authorizers.
|
846
|
+
# resource-based permissions on the Lambda function, don't specify
|
847
|
+
# this parameter. Supported only for REQUEST authorizers.
|
814
848
|
# @return [String]
|
815
849
|
#
|
816
850
|
# @!attribute [rw] authorizer_result_ttl_in_seconds
|
817
|
-
#
|
818
|
-
#
|
851
|
+
# The time to live (TTL) for cached authorizer results, in seconds. If
|
852
|
+
# it equals 0, authorization caching is disabled. If it is greater
|
853
|
+
# than 0, API Gateway caches authorizer responses. The maximum value
|
854
|
+
# is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
|
819
855
|
# @return [Integer]
|
820
856
|
#
|
821
857
|
# @!attribute [rw] authorizer_type
|
822
|
-
# The authorizer type.
|
823
|
-
#
|
824
|
-
#
|
858
|
+
# The authorizer type. Specify REQUEST for a Lambda function using
|
859
|
+
# incoming request parameters. Specify JWT to use JSON Web Tokens
|
860
|
+
# (supported only for HTTP APIs).
|
825
861
|
# @return [String]
|
826
862
|
#
|
827
863
|
# @!attribute [rw] authorizer_uri
|
@@ -846,22 +882,30 @@ module Aws::ApiGatewayV2
|
|
846
882
|
#
|
847
883
|
# For a REQUEST authorizer, this is optional. The value is a set of
|
848
884
|
# one or more mapping expressions of the specified request parameters.
|
849
|
-
#
|
850
|
-
#
|
851
|
-
#
|
852
|
-
#
|
853
|
-
# route.request.querystring.Name
|
854
|
-
#
|
855
|
-
#
|
856
|
-
#
|
857
|
-
#
|
858
|
-
#
|
859
|
-
# function.
|
885
|
+
# The identity source can be headers, query string parameters, stage
|
886
|
+
# variables, and context parameters. For example, if an Auth header
|
887
|
+
# and a Name query string parameter are defined as identity sources,
|
888
|
+
# this value is route.request.header.Auth,
|
889
|
+
# route.request.querystring.Name for WebSocket APIs. For HTTP APIs,
|
890
|
+
# use selection expressions prefixed with $, for example,
|
891
|
+
# $request.header.Auth, $request.querystring.Name. These parameters
|
892
|
+
# are used to perform runtime validation for Lambda-based authorizers
|
893
|
+
# by verifying all of the identity-related request parameters are
|
894
|
+
# present in the request, not null, and non-empty. Only when this is
|
895
|
+
# true does the authorizer invoke the authorizer Lambda function.
|
896
|
+
# Otherwise, it returns a 401 Unauthorized response without calling
|
897
|
+
# the Lambda function. For HTTP APIs, identity sources are also used
|
898
|
+
# as the cache key when caching is enabled. To learn more, see
|
899
|
+
# [Working with AWS Lambda authorizers for HTTP APIs][1].
|
860
900
|
#
|
861
901
|
# For JWT, a single entry that specifies where to extract the JSON Web
|
862
|
-
# Token (JWT
|
902
|
+
# Token (JWT) from inbound requests. Currently only header-based and
|
863
903
|
# query parameter-based selections are supported, for example
|
864
|
-
#
|
904
|
+
# $request.header.Authorization.
|
905
|
+
#
|
906
|
+
#
|
907
|
+
#
|
908
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html
|
865
909
|
# @return [Array<String>]
|
866
910
|
#
|
867
911
|
# @!attribute [rw] identity_validation_expression
|
@@ -877,6 +921,29 @@ module Aws::ApiGatewayV2
|
|
877
921
|
# The name of the authorizer.
|
878
922
|
# @return [String]
|
879
923
|
#
|
924
|
+
# @!attribute [rw] authorizer_payload_format_version
|
925
|
+
# Specifies the format of the payload sent to an HTTP API Lambda
|
926
|
+
# authorizer. Required for HTTP API Lambda authorizers. Supported
|
927
|
+
# values are 1.0 and 2.0. To learn more, see [Working with AWS Lambda
|
928
|
+
# authorizers for HTTP APIs][1].
|
929
|
+
#
|
930
|
+
#
|
931
|
+
#
|
932
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html
|
933
|
+
# @return [String]
|
934
|
+
#
|
935
|
+
# @!attribute [rw] enable_simple_responses
|
936
|
+
# Specifies whether a Lambda authorizer returns a response in a simple
|
937
|
+
# format. By default, a Lambda authorizer must return an IAM policy.
|
938
|
+
# If enabled, the Lambda authorizer can return a boolean value instead
|
939
|
+
# of an IAM policy. Supported only for HTTP APIs. To learn more, see
|
940
|
+
# [Working with AWS Lambda authorizers for HTTP APIs][1]
|
941
|
+
#
|
942
|
+
#
|
943
|
+
#
|
944
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html
|
945
|
+
# @return [Boolean]
|
946
|
+
#
|
880
947
|
class CreateAuthorizerInput < Struct.new(
|
881
948
|
:authorizer_credentials_arn,
|
882
949
|
:authorizer_result_ttl_in_seconds,
|
@@ -885,7 +952,9 @@ module Aws::ApiGatewayV2
|
|
885
952
|
:identity_source,
|
886
953
|
:identity_validation_expression,
|
887
954
|
:jwt_configuration,
|
888
|
-
:name
|
955
|
+
:name,
|
956
|
+
:authorizer_payload_format_version,
|
957
|
+
:enable_simple_responses)
|
889
958
|
SENSITIVE = []
|
890
959
|
include Aws::Structure
|
891
960
|
end
|
@@ -906,6 +975,8 @@ module Aws::ApiGatewayV2
|
|
906
975
|
# issuer: "UriWithLengthBetween1And2048",
|
907
976
|
# },
|
908
977
|
# name: "StringWithLengthBetween1And128", # required
|
978
|
+
# authorizer_payload_format_version: "StringWithLengthBetween1And64",
|
979
|
+
# enable_simple_responses: false,
|
909
980
|
# }
|
910
981
|
#
|
911
982
|
# @!attribute [rw] api_id
|
@@ -920,9 +991,9 @@ module Aws::ApiGatewayV2
|
|
920
991
|
# @return [Integer]
|
921
992
|
#
|
922
993
|
# @!attribute [rw] authorizer_type
|
923
|
-
# The authorizer type.
|
924
|
-
#
|
925
|
-
#
|
994
|
+
# The authorizer type. Specify REQUEST for a Lambda function using
|
995
|
+
# incoming request parameters. Specify JWT to use JSON Web Tokens
|
996
|
+
# (supported only for HTTP APIs).
|
926
997
|
# @return [String]
|
927
998
|
#
|
928
999
|
# @!attribute [rw] authorizer_uri
|
@@ -961,6 +1032,13 @@ module Aws::ApiGatewayV2
|
|
961
1032
|
# A string with a length between \[1-128\].
|
962
1033
|
# @return [String]
|
963
1034
|
#
|
1035
|
+
# @!attribute [rw] authorizer_payload_format_version
|
1036
|
+
# A string with a length between \[1-64\].
|
1037
|
+
# @return [String]
|
1038
|
+
#
|
1039
|
+
# @!attribute [rw] enable_simple_responses
|
1040
|
+
# @return [Boolean]
|
1041
|
+
#
|
964
1042
|
class CreateAuthorizerRequest < Struct.new(
|
965
1043
|
:api_id,
|
966
1044
|
:authorizer_credentials_arn,
|
@@ -970,7 +1048,9 @@ module Aws::ApiGatewayV2
|
|
970
1048
|
:identity_source,
|
971
1049
|
:identity_validation_expression,
|
972
1050
|
:jwt_configuration,
|
973
|
-
:name
|
1051
|
+
:name,
|
1052
|
+
:authorizer_payload_format_version,
|
1053
|
+
:enable_simple_responses)
|
974
1054
|
SENSITIVE = []
|
975
1055
|
include Aws::Structure
|
976
1056
|
end
|
@@ -988,9 +1068,9 @@ module Aws::ApiGatewayV2
|
|
988
1068
|
# @return [Integer]
|
989
1069
|
#
|
990
1070
|
# @!attribute [rw] authorizer_type
|
991
|
-
# The authorizer type.
|
992
|
-
#
|
993
|
-
#
|
1071
|
+
# The authorizer type. Specify REQUEST for a Lambda function using
|
1072
|
+
# incoming request parameters. Specify JWT to use JSON Web Tokens
|
1073
|
+
# (supported only for HTTP APIs).
|
994
1074
|
# @return [String]
|
995
1075
|
#
|
996
1076
|
# @!attribute [rw] authorizer_uri
|
@@ -1029,6 +1109,13 @@ module Aws::ApiGatewayV2
|
|
1029
1109
|
# A string with a length between \[1-128\].
|
1030
1110
|
# @return [String]
|
1031
1111
|
#
|
1112
|
+
# @!attribute [rw] authorizer_payload_format_version
|
1113
|
+
# A string with a length between \[1-64\].
|
1114
|
+
# @return [String]
|
1115
|
+
#
|
1116
|
+
# @!attribute [rw] enable_simple_responses
|
1117
|
+
# @return [Boolean]
|
1118
|
+
#
|
1032
1119
|
class CreateAuthorizerResponse < Struct.new(
|
1033
1120
|
:authorizer_credentials_arn,
|
1034
1121
|
:authorizer_id,
|
@@ -1038,7 +1125,9 @@ module Aws::ApiGatewayV2
|
|
1038
1125
|
:identity_source,
|
1039
1126
|
:identity_validation_expression,
|
1040
1127
|
:jwt_configuration,
|
1041
|
-
:name
|
1128
|
+
:name,
|
1129
|
+
:authorizer_payload_format_version,
|
1130
|
+
:enable_simple_responses)
|
1042
1131
|
SENSITIVE = []
|
1043
1132
|
include Aws::Structure
|
1044
1133
|
end
|
@@ -1994,8 +2083,9 @@ module Aws::ApiGatewayV2
|
|
1994
2083
|
# The authorization type for the route. For WebSocket APIs, valid
|
1995
2084
|
# values are NONE for open access, AWS\_IAM for using AWS IAM
|
1996
2085
|
# permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs,
|
1997
|
-
# valid values are NONE for open access,
|
1998
|
-
# Tokens
|
2086
|
+
# valid values are NONE for open access, JWT for using JSON Web
|
2087
|
+
# Tokens, AWS\_IAM for using AWS IAM permissions, and CUSTOM for using
|
2088
|
+
# a Lambda authorizer.
|
1999
2089
|
# @return [String]
|
2000
2090
|
#
|
2001
2091
|
# @!attribute [rw] authorizer_id
|
@@ -2097,7 +2187,8 @@ module Aws::ApiGatewayV2
|
|
2097
2187
|
# The authorization type. For WebSocket APIs, valid values are NONE
|
2098
2188
|
# for open access, AWS\_IAM for using AWS IAM permissions, and CUSTOM
|
2099
2189
|
# for using a Lambda authorizer. For HTTP APIs, valid values are NONE
|
2100
|
-
# for open access,
|
2190
|
+
# for open access, JWT for using JSON Web Tokens, AWS\_IAM for using
|
2191
|
+
# AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
|
2101
2192
|
# @return [String]
|
2102
2193
|
#
|
2103
2194
|
# @!attribute [rw] authorizer_id
|
@@ -2188,7 +2279,8 @@ module Aws::ApiGatewayV2
|
|
2188
2279
|
# The authorization type. For WebSocket APIs, valid values are NONE
|
2189
2280
|
# for open access, AWS\_IAM for using AWS IAM permissions, and CUSTOM
|
2190
2281
|
# for using a Lambda authorizer. For HTTP APIs, valid values are NONE
|
2191
|
-
# for open access,
|
2282
|
+
# for open access, JWT for using JSON Web Tokens, AWS\_IAM for using
|
2283
|
+
# AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
|
2192
2284
|
# @return [String]
|
2193
2285
|
#
|
2194
2286
|
# @!attribute [rw] authorizer_id
|
@@ -3308,6 +3400,27 @@ module Aws::ApiGatewayV2
|
|
3308
3400
|
include Aws::Structure
|
3309
3401
|
end
|
3310
3402
|
|
3403
|
+
# @note When making an API call, you may pass ResetAuthorizersCacheRequest
|
3404
|
+
# data as a hash:
|
3405
|
+
#
|
3406
|
+
# {
|
3407
|
+
# api_id: "__string", # required
|
3408
|
+
# stage_name: "__string", # required
|
3409
|
+
# }
|
3410
|
+
#
|
3411
|
+
# @!attribute [rw] api_id
|
3412
|
+
# @return [String]
|
3413
|
+
#
|
3414
|
+
# @!attribute [rw] stage_name
|
3415
|
+
# @return [String]
|
3416
|
+
#
|
3417
|
+
class ResetAuthorizersCacheRequest < Struct.new(
|
3418
|
+
:api_id,
|
3419
|
+
:stage_name)
|
3420
|
+
SENSITIVE = []
|
3421
|
+
include Aws::Structure
|
3422
|
+
end
|
3423
|
+
|
3311
3424
|
# @note When making an API call, you may pass GetApiMappingRequest
|
3312
3425
|
# data as a hash:
|
3313
3426
|
#
|
@@ -3577,9 +3690,9 @@ module Aws::ApiGatewayV2
|
|
3577
3690
|
# @return [Integer]
|
3578
3691
|
#
|
3579
3692
|
# @!attribute [rw] authorizer_type
|
3580
|
-
# The authorizer type.
|
3581
|
-
#
|
3582
|
-
#
|
3693
|
+
# The authorizer type. Specify REQUEST for a Lambda function using
|
3694
|
+
# incoming request parameters. Specify JWT to use JSON Web Tokens
|
3695
|
+
# (supported only for HTTP APIs).
|
3583
3696
|
# @return [String]
|
3584
3697
|
#
|
3585
3698
|
# @!attribute [rw] authorizer_uri
|
@@ -3618,6 +3731,13 @@ module Aws::ApiGatewayV2
|
|
3618
3731
|
# A string with a length between \[1-128\].
|
3619
3732
|
# @return [String]
|
3620
3733
|
#
|
3734
|
+
# @!attribute [rw] authorizer_payload_format_version
|
3735
|
+
# A string with a length between \[1-64\].
|
3736
|
+
# @return [String]
|
3737
|
+
#
|
3738
|
+
# @!attribute [rw] enable_simple_responses
|
3739
|
+
# @return [Boolean]
|
3740
|
+
#
|
3621
3741
|
class GetAuthorizerResponse < Struct.new(
|
3622
3742
|
:authorizer_credentials_arn,
|
3623
3743
|
:authorizer_id,
|
@@ -3627,7 +3747,9 @@ module Aws::ApiGatewayV2
|
|
3627
3747
|
:identity_source,
|
3628
3748
|
:identity_validation_expression,
|
3629
3749
|
:jwt_configuration,
|
3630
|
-
:name
|
3750
|
+
:name,
|
3751
|
+
:authorizer_payload_format_version,
|
3752
|
+
:enable_simple_responses)
|
3631
3753
|
SENSITIVE = []
|
3632
3754
|
include Aws::Structure
|
3633
3755
|
end
|
@@ -4335,7 +4457,8 @@ module Aws::ApiGatewayV2
|
|
4335
4457
|
# The authorization type. For WebSocket APIs, valid values are NONE
|
4336
4458
|
# for open access, AWS\_IAM for using AWS IAM permissions, and CUSTOM
|
4337
4459
|
# for using a Lambda authorizer. For HTTP APIs, valid values are NONE
|
4338
|
-
# for open access,
|
4460
|
+
# for open access, JWT for using JSON Web Tokens, AWS\_IAM for using
|
4461
|
+
# AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
|
4339
4462
|
# @return [String]
|
4340
4463
|
#
|
4341
4464
|
# @!attribute [rw] authorizer_id
|
@@ -5587,8 +5710,9 @@ module Aws::ApiGatewayV2
|
|
5587
5710
|
# The authorization type for the route. For WebSocket APIs, valid
|
5588
5711
|
# values are NONE for open access, AWS\_IAM for using AWS IAM
|
5589
5712
|
# permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs,
|
5590
|
-
# valid values are NONE for open access,
|
5591
|
-
# Tokens
|
5713
|
+
# valid values are NONE for open access, JWT for using JSON Web
|
5714
|
+
# Tokens, AWS\_IAM for using AWS IAM permissions, and CUSTOM for using
|
5715
|
+
# a Lambda authorizer.
|
5592
5716
|
# @return [String]
|
5593
5717
|
#
|
5594
5718
|
# @!attribute [rw] authorizer_id
|
@@ -6386,14 +6510,16 @@ module Aws::ApiGatewayV2
|
|
6386
6510
|
# @return [String]
|
6387
6511
|
#
|
6388
6512
|
# @!attribute [rw] authorizer_result_ttl_in_seconds
|
6389
|
-
#
|
6390
|
-
#
|
6513
|
+
# The time to live (TTL) for cached authorizer results, in seconds. If
|
6514
|
+
# it equals 0, authorization caching is disabled. If it is greater
|
6515
|
+
# than 0, API Gateway caches authorizer responses. The maximum value
|
6516
|
+
# is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
|
6391
6517
|
# @return [Integer]
|
6392
6518
|
#
|
6393
6519
|
# @!attribute [rw] authorizer_type
|
6394
|
-
# The authorizer type.
|
6395
|
-
#
|
6396
|
-
#
|
6520
|
+
# The authorizer type. Specify REQUEST for a Lambda function using
|
6521
|
+
# incoming request parameters. Specify JWT to use JSON Web Tokens
|
6522
|
+
# (supported only for HTTP APIs).
|
6397
6523
|
# @return [String]
|
6398
6524
|
#
|
6399
6525
|
# @!attribute [rw] authorizer_uri
|
@@ -6418,22 +6544,30 @@ module Aws::ApiGatewayV2
|
|
6418
6544
|
#
|
6419
6545
|
# For a REQUEST authorizer, this is optional. The value is a set of
|
6420
6546
|
# one or more mapping expressions of the specified request parameters.
|
6421
|
-
#
|
6422
|
-
#
|
6423
|
-
#
|
6424
|
-
#
|
6425
|
-
# route.request.querystring.Name
|
6426
|
-
#
|
6427
|
-
#
|
6428
|
-
#
|
6429
|
-
#
|
6430
|
-
#
|
6431
|
-
# function.
|
6547
|
+
# The identity source can be headers, query string parameters, stage
|
6548
|
+
# variables, and context parameters. For example, if an Auth header
|
6549
|
+
# and a Name query string parameter are defined as identity sources,
|
6550
|
+
# this value is route.request.header.Auth,
|
6551
|
+
# route.request.querystring.Name for WebSocket APIs. For HTTP APIs,
|
6552
|
+
# use selection expressions prefixed with $, for example,
|
6553
|
+
# $request.header.Auth, $request.querystring.Name. These parameters
|
6554
|
+
# are used to perform runtime validation for Lambda-based authorizers
|
6555
|
+
# by verifying all of the identity-related request parameters are
|
6556
|
+
# present in the request, not null, and non-empty. Only when this is
|
6557
|
+
# true does the authorizer invoke the authorizer Lambda function.
|
6558
|
+
# Otherwise, it returns a 401 Unauthorized response without calling
|
6559
|
+
# the Lambda function. For HTTP APIs, identity sources are also used
|
6560
|
+
# as the cache key when caching is enabled. To learn more, see
|
6561
|
+
# [Working with AWS Lambda authorizers for HTTP APIs][1].
|
6432
6562
|
#
|
6433
6563
|
# For JWT, a single entry that specifies where to extract the JSON Web
|
6434
6564
|
# Token (JWT) from inbound requests. Currently only header-based and
|
6435
6565
|
# query parameter-based selections are supported, for example
|
6436
|
-
#
|
6566
|
+
# $request.header.Authorization.
|
6567
|
+
#
|
6568
|
+
#
|
6569
|
+
#
|
6570
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html
|
6437
6571
|
# @return [Array<String>]
|
6438
6572
|
#
|
6439
6573
|
# @!attribute [rw] identity_validation_expression
|
@@ -6449,6 +6583,29 @@ module Aws::ApiGatewayV2
|
|
6449
6583
|
# The name of the authorizer.
|
6450
6584
|
# @return [String]
|
6451
6585
|
#
|
6586
|
+
# @!attribute [rw] authorizer_payload_format_version
|
6587
|
+
# Specifies the format of the payload sent to an HTTP API Lambda
|
6588
|
+
# authorizer. Required for HTTP API Lambda authorizers. Supported
|
6589
|
+
# values are 1.0 and 2.0. To learn more, see [Working with AWS Lambda
|
6590
|
+
# authorizers for HTTP APIs][1].
|
6591
|
+
#
|
6592
|
+
#
|
6593
|
+
#
|
6594
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html
|
6595
|
+
# @return [String]
|
6596
|
+
#
|
6597
|
+
# @!attribute [rw] enable_simple_responses
|
6598
|
+
# Specifies whether a Lambda authorizer returns a response in a simple
|
6599
|
+
# format. By default, a Lambda authorizer must return an IAM policy.
|
6600
|
+
# If enabled, the Lambda authorizer can return a boolean value instead
|
6601
|
+
# of an IAM policy. Supported only for HTTP APIs. To learn more, see
|
6602
|
+
# [Working with AWS Lambda authorizers for HTTP APIs][1]
|
6603
|
+
#
|
6604
|
+
#
|
6605
|
+
#
|
6606
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html
|
6607
|
+
# @return [Boolean]
|
6608
|
+
#
|
6452
6609
|
class UpdateAuthorizerInput < Struct.new(
|
6453
6610
|
:authorizer_credentials_arn,
|
6454
6611
|
:authorizer_result_ttl_in_seconds,
|
@@ -6457,7 +6614,9 @@ module Aws::ApiGatewayV2
|
|
6457
6614
|
:identity_source,
|
6458
6615
|
:identity_validation_expression,
|
6459
6616
|
:jwt_configuration,
|
6460
|
-
:name
|
6617
|
+
:name,
|
6618
|
+
:authorizer_payload_format_version,
|
6619
|
+
:enable_simple_responses)
|
6461
6620
|
SENSITIVE = []
|
6462
6621
|
include Aws::Structure
|
6463
6622
|
end
|
@@ -6479,6 +6638,8 @@ module Aws::ApiGatewayV2
|
|
6479
6638
|
# issuer: "UriWithLengthBetween1And2048",
|
6480
6639
|
# },
|
6481
6640
|
# name: "StringWithLengthBetween1And128",
|
6641
|
+
# authorizer_payload_format_version: "StringWithLengthBetween1And64",
|
6642
|
+
# enable_simple_responses: false,
|
6482
6643
|
# }
|
6483
6644
|
#
|
6484
6645
|
# @!attribute [rw] api_id
|
@@ -6496,9 +6657,9 @@ module Aws::ApiGatewayV2
|
|
6496
6657
|
# @return [Integer]
|
6497
6658
|
#
|
6498
6659
|
# @!attribute [rw] authorizer_type
|
6499
|
-
# The authorizer type.
|
6500
|
-
#
|
6501
|
-
#
|
6660
|
+
# The authorizer type. Specify REQUEST for a Lambda function using
|
6661
|
+
# incoming request parameters. Specify JWT to use JSON Web Tokens
|
6662
|
+
# (supported only for HTTP APIs).
|
6502
6663
|
# @return [String]
|
6503
6664
|
#
|
6504
6665
|
# @!attribute [rw] authorizer_uri
|
@@ -6537,6 +6698,13 @@ module Aws::ApiGatewayV2
|
|
6537
6698
|
# A string with a length between \[1-128\].
|
6538
6699
|
# @return [String]
|
6539
6700
|
#
|
6701
|
+
# @!attribute [rw] authorizer_payload_format_version
|
6702
|
+
# A string with a length between \[1-64\].
|
6703
|
+
# @return [String]
|
6704
|
+
#
|
6705
|
+
# @!attribute [rw] enable_simple_responses
|
6706
|
+
# @return [Boolean]
|
6707
|
+
#
|
6540
6708
|
class UpdateAuthorizerRequest < Struct.new(
|
6541
6709
|
:api_id,
|
6542
6710
|
:authorizer_credentials_arn,
|
@@ -6547,7 +6715,9 @@ module Aws::ApiGatewayV2
|
|
6547
6715
|
:identity_source,
|
6548
6716
|
:identity_validation_expression,
|
6549
6717
|
:jwt_configuration,
|
6550
|
-
:name
|
6718
|
+
:name,
|
6719
|
+
:authorizer_payload_format_version,
|
6720
|
+
:enable_simple_responses)
|
6551
6721
|
SENSITIVE = []
|
6552
6722
|
include Aws::Structure
|
6553
6723
|
end
|
@@ -6565,9 +6735,9 @@ module Aws::ApiGatewayV2
|
|
6565
6735
|
# @return [Integer]
|
6566
6736
|
#
|
6567
6737
|
# @!attribute [rw] authorizer_type
|
6568
|
-
# The authorizer type.
|
6569
|
-
#
|
6570
|
-
#
|
6738
|
+
# The authorizer type. Specify REQUEST for a Lambda function using
|
6739
|
+
# incoming request parameters. Specify JWT to use JSON Web Tokens
|
6740
|
+
# (supported only for HTTP APIs).
|
6571
6741
|
# @return [String]
|
6572
6742
|
#
|
6573
6743
|
# @!attribute [rw] authorizer_uri
|
@@ -6606,6 +6776,13 @@ module Aws::ApiGatewayV2
|
|
6606
6776
|
# A string with a length between \[1-128\].
|
6607
6777
|
# @return [String]
|
6608
6778
|
#
|
6779
|
+
# @!attribute [rw] authorizer_payload_format_version
|
6780
|
+
# A string with a length between \[1-64\].
|
6781
|
+
# @return [String]
|
6782
|
+
#
|
6783
|
+
# @!attribute [rw] enable_simple_responses
|
6784
|
+
# @return [Boolean]
|
6785
|
+
#
|
6609
6786
|
class UpdateAuthorizerResponse < Struct.new(
|
6610
6787
|
:authorizer_credentials_arn,
|
6611
6788
|
:authorizer_id,
|
@@ -6615,7 +6792,9 @@ module Aws::ApiGatewayV2
|
|
6615
6792
|
:identity_source,
|
6616
6793
|
:identity_validation_expression,
|
6617
6794
|
:jwt_configuration,
|
6618
|
-
:name
|
6795
|
+
:name,
|
6796
|
+
:authorizer_payload_format_version,
|
6797
|
+
:enable_simple_responses)
|
6619
6798
|
SENSITIVE = []
|
6620
6799
|
include Aws::Structure
|
6621
6800
|
end
|
@@ -7562,8 +7741,9 @@ module Aws::ApiGatewayV2
|
|
7562
7741
|
# The authorization type for the route. For WebSocket APIs, valid
|
7563
7742
|
# values are NONE for open access, AWS\_IAM for using AWS IAM
|
7564
7743
|
# permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs,
|
7565
|
-
# valid values are NONE for open access,
|
7566
|
-
# Tokens
|
7744
|
+
# valid values are NONE for open access, JWT for using JSON Web
|
7745
|
+
# Tokens, AWS\_IAM for using AWS IAM permissions, and CUSTOM for using
|
7746
|
+
# a Lambda authorizer.
|
7567
7747
|
# @return [String]
|
7568
7748
|
#
|
7569
7749
|
# @!attribute [rw] authorizer_id
|
@@ -7666,7 +7846,8 @@ module Aws::ApiGatewayV2
|
|
7666
7846
|
# The authorization type. For WebSocket APIs, valid values are NONE
|
7667
7847
|
# for open access, AWS\_IAM for using AWS IAM permissions, and CUSTOM
|
7668
7848
|
# for using a Lambda authorizer. For HTTP APIs, valid values are NONE
|
7669
|
-
# for open access,
|
7849
|
+
# for open access, JWT for using JSON Web Tokens, AWS\_IAM for using
|
7850
|
+
# AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
|
7670
7851
|
# @return [String]
|
7671
7852
|
#
|
7672
7853
|
# @!attribute [rw] authorizer_id
|
@@ -7761,7 +7942,8 @@ module Aws::ApiGatewayV2
|
|
7761
7942
|
# The authorization type. For WebSocket APIs, valid values are NONE
|
7762
7943
|
# for open access, AWS\_IAM for using AWS IAM permissions, and CUSTOM
|
7763
7944
|
# for using a Lambda authorizer. For HTTP APIs, valid values are NONE
|
7764
|
-
# for open access,
|
7945
|
+
# for open access, JWT for using JSON Web Tokens, AWS\_IAM for using
|
7946
|
+
# AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
|
7765
7947
|
# @return [String]
|
7766
7948
|
#
|
7767
7949
|
# @!attribute [rw] authorizer_id
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-apigatewayv2
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.26.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: 2020-08
|
11
|
+
date: 2020-09-08 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|