aws-sdk-apigateway 1.31.0 → 1.32.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 +59 -31
- data/lib/aws-sdk-apigateway/client_api.rb +6 -0
- data/lib/aws-sdk-apigateway/types.rb +82 -48
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 248b584bc59961c3385cea8360fd8c1d1a60cb98
|
4
|
+
data.tar.gz: 599bf7d2a0a464ace3452799c41ea7b7e8455a57
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1c9370f67a793c99034e97907cf626448a7d014e869b73539cd3cb77f8246402755b2dcc27829cd070d1cbe143398196f49a6b019df2665ab5ac550b7a81ff23
|
7
|
+
data.tar.gz: c752fdf8ee68f74fe7eef0ac6c22489fef8c704f897db0f7eca32a5efe955a6a290120984acba4df66b2ad757626acc81c643ab75e74ff188a0d37d01023c2ae
|
data/lib/aws-sdk-apigateway.rb
CHANGED
@@ -427,12 +427,13 @@ module Aws::APIGateway
|
|
427
427
|
#
|
428
428
|
# @option params [String] :identity_validation_expression
|
429
429
|
# A validation expression for the incoming identity token. For `TOKEN`
|
430
|
-
# authorizers, this value is a regular expression.
|
431
|
-
#
|
432
|
-
# the
|
433
|
-
#
|
434
|
-
#
|
435
|
-
#
|
430
|
+
# authorizers, this value is a regular expression. For
|
431
|
+
# `COGNITO_USER_POOLS` authorizers, API Gateway will match the `aud`
|
432
|
+
# field of the incoming token from the client against the specified
|
433
|
+
# regular expression. It will invoke the authorizer's Lambda function
|
434
|
+
# when there is a match. Otherwise, it will return a 401 Unauthorized
|
435
|
+
# response without calling the Lambda function. The validation
|
436
|
+
# expression does not apply to the `REQUEST` authorizer.
|
436
437
|
#
|
437
438
|
# @option params [Integer] :authorizer_result_ttl_in_seconds
|
438
439
|
# The TTL in seconds of cached authorizer results. If it equals 0,
|
@@ -498,7 +499,7 @@ module Aws::APIGateway
|
|
498
499
|
# @option params [String] :base_path
|
499
500
|
# The base path name that callers of the API must provide as part of the
|
500
501
|
# URL after the domain name. This value must be unique for all of the
|
501
|
-
# mappings across a single API.
|
502
|
+
# mappings across a single API. Specify '(none)' if you do not want
|
502
503
|
# callers to specify a base path name after the domain name.
|
503
504
|
#
|
504
505
|
# @option params [required, String] :rest_api_id
|
@@ -506,8 +507,8 @@ module Aws::APIGateway
|
|
506
507
|
#
|
507
508
|
# @option params [String] :stage
|
508
509
|
# The name of the API's stage that you want to use for this mapping.
|
509
|
-
#
|
510
|
-
# stage name after any base path name.
|
510
|
+
# Specify '(none)' if you do not want callers to explicitly specify
|
511
|
+
# the stage name after any base path name.
|
511
512
|
#
|
512
513
|
# @return [Types::BasePathMapping] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
513
514
|
#
|
@@ -759,6 +760,10 @@ module Aws::APIGateway
|
|
759
760
|
# \[a-zA-Z+-=.\_:/\]. The tag key can be up to 128 characters and must
|
760
761
|
# not start with `aws:`. The tag value can be up to 256 characters.
|
761
762
|
#
|
763
|
+
# @option params [String] :security_policy
|
764
|
+
# The Transport Layer Security (TLS) version + cipher suite for this
|
765
|
+
# DomainName. The valid values are `TLS_1_0` and `TLS_1_2`.
|
766
|
+
#
|
762
767
|
# @return [Types::DomainName] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
763
768
|
#
|
764
769
|
# * {Types::DomainName#domain_name #domain_name} => String
|
@@ -772,6 +777,9 @@ module Aws::APIGateway
|
|
772
777
|
# * {Types::DomainName#distribution_domain_name #distribution_domain_name} => String
|
773
778
|
# * {Types::DomainName#distribution_hosted_zone_id #distribution_hosted_zone_id} => String
|
774
779
|
# * {Types::DomainName#endpoint_configuration #endpoint_configuration} => Types::EndpointConfiguration
|
780
|
+
# * {Types::DomainName#domain_name_status #domain_name_status} => String
|
781
|
+
# * {Types::DomainName#domain_name_status_message #domain_name_status_message} => String
|
782
|
+
# * {Types::DomainName#security_policy #security_policy} => String
|
775
783
|
# * {Types::DomainName#tags #tags} => Hash<String,String>
|
776
784
|
#
|
777
785
|
# @example Request syntax with placeholder values
|
@@ -791,6 +799,7 @@ module Aws::APIGateway
|
|
791
799
|
# tags: {
|
792
800
|
# "String" => "String",
|
793
801
|
# },
|
802
|
+
# security_policy: "TLS_1_0", # accepts TLS_1_0, TLS_1_2
|
794
803
|
# })
|
795
804
|
#
|
796
805
|
# @example Response structure
|
@@ -807,6 +816,9 @@ module Aws::APIGateway
|
|
807
816
|
# resp.distribution_hosted_zone_id #=> String
|
808
817
|
# resp.endpoint_configuration.types #=> Array
|
809
818
|
# resp.endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE", "PRIVATE"
|
819
|
+
# resp.domain_name_status #=> String, one of "AVAILABLE", "UPDATING", "PENDING"
|
820
|
+
# resp.domain_name_status_message #=> String
|
821
|
+
# resp.security_policy #=> String, one of "TLS_1_0", "TLS_1_2"
|
810
822
|
# resp.tags #=> Hash
|
811
823
|
# resp.tags["String"] #=> String
|
812
824
|
#
|
@@ -1117,7 +1129,9 @@ module Aws::APIGateway
|
|
1117
1129
|
# \[Required\] The string identifier of the associated RestApi.
|
1118
1130
|
#
|
1119
1131
|
# @option params [required, String] :stage_name
|
1120
|
-
# \[Required\] The name for the Stage resource.
|
1132
|
+
# \[Required\] The name for the Stage resource. Stage names can only
|
1133
|
+
# contain alphanumeric characters, hyphens, and underscores. Maximum
|
1134
|
+
# length is 128 characters.
|
1121
1135
|
#
|
1122
1136
|
# @option params [required, String] :deployment_id
|
1123
1137
|
# \[Required\] The identifier of the Deployment resource for the Stage
|
@@ -1501,6 +1515,8 @@ module Aws::APIGateway
|
|
1501
1515
|
# \[Required\] The base path name of the BasePathMapping resource to
|
1502
1516
|
# delete.
|
1503
1517
|
#
|
1518
|
+
# To specify an empty base path, set this parameter to `'(none)'`.
|
1519
|
+
#
|
1504
1520
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1505
1521
|
#
|
1506
1522
|
# @example Request syntax with placeholder values
|
@@ -2336,7 +2352,7 @@ module Aws::APIGateway
|
|
2336
2352
|
# @option params [required, String] :base_path
|
2337
2353
|
# \[Required\] The base path name that callers of the API must provide
|
2338
2354
|
# as part of the URL after the domain name. This value must be unique
|
2339
|
-
# for all of the mappings across a single API.
|
2355
|
+
# for all of the mappings across a single API. Specify '(none)' if you
|
2340
2356
|
# do not want callers to specify any base path name after the domain
|
2341
2357
|
# name.
|
2342
2358
|
#
|
@@ -2769,6 +2785,9 @@ module Aws::APIGateway
|
|
2769
2785
|
# * {Types::DomainName#distribution_domain_name #distribution_domain_name} => String
|
2770
2786
|
# * {Types::DomainName#distribution_hosted_zone_id #distribution_hosted_zone_id} => String
|
2771
2787
|
# * {Types::DomainName#endpoint_configuration #endpoint_configuration} => Types::EndpointConfiguration
|
2788
|
+
# * {Types::DomainName#domain_name_status #domain_name_status} => String
|
2789
|
+
# * {Types::DomainName#domain_name_status_message #domain_name_status_message} => String
|
2790
|
+
# * {Types::DomainName#security_policy #security_policy} => String
|
2772
2791
|
# * {Types::DomainName#tags #tags} => Hash<String,String>
|
2773
2792
|
#
|
2774
2793
|
# @example Request syntax with placeholder values
|
@@ -2791,6 +2810,9 @@ module Aws::APIGateway
|
|
2791
2810
|
# resp.distribution_hosted_zone_id #=> String
|
2792
2811
|
# resp.endpoint_configuration.types #=> Array
|
2793
2812
|
# resp.endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE", "PRIVATE"
|
2813
|
+
# resp.domain_name_status #=> String, one of "AVAILABLE", "UPDATING", "PENDING"
|
2814
|
+
# resp.domain_name_status_message #=> String
|
2815
|
+
# resp.security_policy #=> String, one of "TLS_1_0", "TLS_1_2"
|
2794
2816
|
# resp.tags #=> Hash
|
2795
2817
|
# resp.tags["String"] #=> String
|
2796
2818
|
#
|
@@ -2838,6 +2860,9 @@ module Aws::APIGateway
|
|
2838
2860
|
# resp.items[0].distribution_hosted_zone_id #=> String
|
2839
2861
|
# resp.items[0].endpoint_configuration.types #=> Array
|
2840
2862
|
# resp.items[0].endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE", "PRIVATE"
|
2863
|
+
# resp.items[0].domain_name_status #=> String, one of "AVAILABLE", "UPDATING", "PENDING"
|
2864
|
+
# resp.items[0].domain_name_status_message #=> String
|
2865
|
+
# resp.items[0].security_policy #=> String, one of "TLS_1_0", "TLS_1_2"
|
2841
2866
|
# resp.items[0].tags #=> Hash
|
2842
2867
|
# resp.items[0].tags["String"] #=> String
|
2843
2868
|
#
|
@@ -4023,8 +4048,7 @@ module Aws::APIGateway
|
|
4023
4048
|
#
|
4024
4049
|
# @option params [required, String] :resource_arn
|
4025
4050
|
# \[Required\] The ARN of a resource that can be tagged. The resource
|
4026
|
-
# ARN must be URL-encoded.
|
4027
|
-
# resource.
|
4051
|
+
# ARN must be URL-encoded.
|
4028
4052
|
#
|
4029
4053
|
# @option params [String] :position
|
4030
4054
|
# (Not currently supported) The current pagination position in the paged
|
@@ -4504,8 +4528,8 @@ module Aws::APIGateway
|
|
4504
4528
|
# `endpointConfigurationTypes=PRIVATE`. The default endpoint type is
|
4505
4529
|
# `EDGE`.
|
4506
4530
|
#
|
4507
|
-
# To handle imported `
|
4508
|
-
# `
|
4531
|
+
# To handle imported `basepath`, set `parameters` as `basepath=ignore`,
|
4532
|
+
# `basepath=prepend` or `basepath=split`.
|
4509
4533
|
#
|
4510
4534
|
# For example, the AWS CLI command to exclude documentation from the
|
4511
4535
|
# imported API is:
|
@@ -4756,10 +4780,10 @@ module Aws::APIGateway
|
|
4756
4780
|
# the same 415 response.
|
4757
4781
|
#
|
4758
4782
|
# @option params [String] :cache_namespace
|
4759
|
-
#
|
4783
|
+
# A list of request parameters whose values are to be cached.
|
4760
4784
|
#
|
4761
4785
|
# @option params [Array<String>] :cache_key_parameters
|
4762
|
-
#
|
4786
|
+
# An API-specific tag group of related cached parameters.
|
4763
4787
|
#
|
4764
4788
|
# @option params [String] :content_handling
|
4765
4789
|
# Specifies how to handle request payload content type conversions.
|
@@ -4774,8 +4798,8 @@ module Aws::APIGateway
|
|
4774
4798
|
#
|
4775
4799
|
# If this property is not defined, the request payload will be passed
|
4776
4800
|
# through from the method request to integration request without
|
4777
|
-
# modification, provided that the `
|
4778
|
-
#
|
4801
|
+
# modification, provided that the `passthroughBehavior` is configured to
|
4802
|
+
# support payload pass-through.
|
4779
4803
|
#
|
4780
4804
|
# @option params [Integer] :timeout_in_millis
|
4781
4805
|
# Custom timeout between 50 and 29,000 milliseconds. The default value
|
@@ -4978,11 +5002,7 @@ module Aws::APIGateway
|
|
4978
5002
|
# @option params [String] :operation_name
|
4979
5003
|
# A human-friendly operation identifier for the method. For example, you
|
4980
5004
|
# can assign the `operationName` of `ListPets` for the `GET /pets`
|
4981
|
-
# method in
|
4982
|
-
#
|
4983
|
-
#
|
4984
|
-
#
|
4985
|
-
# [1]: https://petstore-demo-endpoint.execute-api.com/petstore/pets
|
5005
|
+
# method in the `PetStore` example.
|
4986
5006
|
#
|
4987
5007
|
# @option params [Hash<String,Boolean>] :request_parameters
|
4988
5008
|
# A key-value map defining required or optional method request
|
@@ -5260,8 +5280,7 @@ module Aws::APIGateway
|
|
5260
5280
|
#
|
5261
5281
|
# @option params [required, String] :resource_arn
|
5262
5282
|
# \[Required\] The ARN of a resource that can be tagged. The resource
|
5263
|
-
# ARN must be URL-encoded.
|
5264
|
-
# resource.
|
5283
|
+
# ARN must be URL-encoded.
|
5265
5284
|
#
|
5266
5285
|
# @option params [required, Hash<String,String>] :tags
|
5267
5286
|
# \[Required\] The key-value map of strings. The valid character set is
|
@@ -5290,12 +5309,14 @@ module Aws::APIGateway
|
|
5290
5309
|
# parameters, and an incoming request body.
|
5291
5310
|
#
|
5292
5311
|
# <div class="seeAlso">
|
5293
|
-
# [
|
5312
|
+
# [Use Lambda Function as Authorizer][1] [Use Cognito User Pool as
|
5313
|
+
# Authorizer][2]
|
5294
5314
|
# </div>
|
5295
5315
|
#
|
5296
5316
|
#
|
5297
5317
|
#
|
5298
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/use-
|
5318
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html
|
5319
|
+
# [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html
|
5299
5320
|
#
|
5300
5321
|
# @option params [required, String] :rest_api_id
|
5301
5322
|
# \[Required\] The string identifier of the associated RestApi.
|
@@ -5469,8 +5490,7 @@ module Aws::APIGateway
|
|
5469
5490
|
#
|
5470
5491
|
# @option params [required, String] :resource_arn
|
5471
5492
|
# \[Required\] The ARN of a resource that can be tagged. The resource
|
5472
|
-
# ARN must be URL-encoded.
|
5473
|
-
# resource.
|
5493
|
+
# ARN must be URL-encoded.
|
5474
5494
|
#
|
5475
5495
|
# @option params [required, Array<String>] :tag_keys
|
5476
5496
|
# \[Required\] The Tag keys to delete.
|
@@ -5669,6 +5689,8 @@ module Aws::APIGateway
|
|
5669
5689
|
# @option params [required, String] :base_path
|
5670
5690
|
# \[Required\] The base path of the BasePathMapping resource to change.
|
5671
5691
|
#
|
5692
|
+
# To specify an empty base path, set this parameter to `'(none)'`.
|
5693
|
+
#
|
5672
5694
|
# @option params [Array<Types::PatchOperation>] :patch_operations
|
5673
5695
|
# A list of update operations to be applied to the specified resource
|
5674
5696
|
# and in the order specified in this list.
|
@@ -5924,6 +5946,9 @@ module Aws::APIGateway
|
|
5924
5946
|
# * {Types::DomainName#distribution_domain_name #distribution_domain_name} => String
|
5925
5947
|
# * {Types::DomainName#distribution_hosted_zone_id #distribution_hosted_zone_id} => String
|
5926
5948
|
# * {Types::DomainName#endpoint_configuration #endpoint_configuration} => Types::EndpointConfiguration
|
5949
|
+
# * {Types::DomainName#domain_name_status #domain_name_status} => String
|
5950
|
+
# * {Types::DomainName#domain_name_status_message #domain_name_status_message} => String
|
5951
|
+
# * {Types::DomainName#security_policy #security_policy} => String
|
5927
5952
|
# * {Types::DomainName#tags #tags} => Hash<String,String>
|
5928
5953
|
#
|
5929
5954
|
# @example Request syntax with placeholder values
|
@@ -5954,6 +5979,9 @@ module Aws::APIGateway
|
|
5954
5979
|
# resp.distribution_hosted_zone_id #=> String
|
5955
5980
|
# resp.endpoint_configuration.types #=> Array
|
5956
5981
|
# resp.endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE", "PRIVATE"
|
5982
|
+
# resp.domain_name_status #=> String, one of "AVAILABLE", "UPDATING", "PENDING"
|
5983
|
+
# resp.domain_name_status_message #=> String
|
5984
|
+
# resp.security_policy #=> String, one of "TLS_1_0", "TLS_1_2"
|
5957
5985
|
# resp.tags #=> Hash
|
5958
5986
|
# resp.tags["String"] #=> String
|
5959
5987
|
#
|
@@ -6865,7 +6893,7 @@ module Aws::APIGateway
|
|
6865
6893
|
params: params,
|
6866
6894
|
config: config)
|
6867
6895
|
context[:gem_name] = 'aws-sdk-apigateway'
|
6868
|
-
context[:gem_version] = '1.
|
6896
|
+
context[:gem_version] = '1.32.0'
|
6869
6897
|
Seahorse::Client::Request.new(handlers, context)
|
6870
6898
|
end
|
6871
6899
|
|
@@ -83,6 +83,7 @@ module Aws::APIGateway
|
|
83
83
|
DocumentationVersion = Shapes::StructureShape.new(name: 'DocumentationVersion')
|
84
84
|
DocumentationVersions = Shapes::StructureShape.new(name: 'DocumentationVersions')
|
85
85
|
DomainName = Shapes::StructureShape.new(name: 'DomainName')
|
86
|
+
DomainNameStatus = Shapes::StringShape.new(name: 'DomainNameStatus')
|
86
87
|
DomainNames = Shapes::StructureShape.new(name: 'DomainNames')
|
87
88
|
Double = Shapes::FloatShape.new(name: 'Double')
|
88
89
|
EndpointConfiguration = Shapes::StructureShape.new(name: 'EndpointConfiguration')
|
@@ -219,6 +220,7 @@ module Aws::APIGateway
|
|
219
220
|
SdkResponse = Shapes::StructureShape.new(name: 'SdkResponse')
|
220
221
|
SdkType = Shapes::StructureShape.new(name: 'SdkType')
|
221
222
|
SdkTypes = Shapes::StructureShape.new(name: 'SdkTypes')
|
223
|
+
SecurityPolicy = Shapes::StringShape.new(name: 'SecurityPolicy')
|
222
224
|
ServiceUnavailableException = Shapes::StructureShape.new(name: 'ServiceUnavailableException')
|
223
225
|
Stage = Shapes::StructureShape.new(name: 'Stage')
|
224
226
|
StageKey = Shapes::StructureShape.new(name: 'StageKey')
|
@@ -414,6 +416,7 @@ module Aws::APIGateway
|
|
414
416
|
CreateDomainNameRequest.add_member(:regional_certificate_arn, Shapes::ShapeRef.new(shape: String, location_name: "regionalCertificateArn"))
|
415
417
|
CreateDomainNameRequest.add_member(:endpoint_configuration, Shapes::ShapeRef.new(shape: EndpointConfiguration, location_name: "endpointConfiguration"))
|
416
418
|
CreateDomainNameRequest.add_member(:tags, Shapes::ShapeRef.new(shape: MapOfStringToString, location_name: "tags"))
|
419
|
+
CreateDomainNameRequest.add_member(:security_policy, Shapes::ShapeRef.new(shape: SecurityPolicy, location_name: "securityPolicy"))
|
417
420
|
CreateDomainNameRequest.struct_class = Types::CreateDomainNameRequest
|
418
421
|
|
419
422
|
CreateModelRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
@@ -617,6 +620,9 @@ module Aws::APIGateway
|
|
617
620
|
DomainName.add_member(:distribution_domain_name, Shapes::ShapeRef.new(shape: String, location_name: "distributionDomainName"))
|
618
621
|
DomainName.add_member(:distribution_hosted_zone_id, Shapes::ShapeRef.new(shape: String, location_name: "distributionHostedZoneId"))
|
619
622
|
DomainName.add_member(:endpoint_configuration, Shapes::ShapeRef.new(shape: EndpointConfiguration, location_name: "endpointConfiguration"))
|
623
|
+
DomainName.add_member(:domain_name_status, Shapes::ShapeRef.new(shape: DomainNameStatus, location_name: "domainNameStatus"))
|
624
|
+
DomainName.add_member(:domain_name_status_message, Shapes::ShapeRef.new(shape: String, location_name: "domainNameStatusMessage"))
|
625
|
+
DomainName.add_member(:security_policy, Shapes::ShapeRef.new(shape: SecurityPolicy, location_name: "securityPolicy"))
|
620
626
|
DomainName.add_member(:tags, Shapes::ShapeRef.new(shape: MapOfStringToString, location_name: "tags"))
|
621
627
|
DomainName.struct_class = Types::DomainName
|
622
628
|
|
@@ -258,12 +258,14 @@ module Aws::APIGateway
|
|
258
258
|
# method.
|
259
259
|
#
|
260
260
|
# <div class="seeAlso">
|
261
|
-
# [
|
261
|
+
# [Use Lambda Function as Authorizer][1] [Use Cognito User Pool as
|
262
|
+
# Authorizer][2]
|
262
263
|
# </div>
|
263
264
|
#
|
264
265
|
#
|
265
266
|
#
|
266
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/use-
|
267
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html
|
268
|
+
# [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html
|
267
269
|
#
|
268
270
|
# @!attribute [rw] id
|
269
271
|
# The identifier for the authorizer resource.
|
@@ -339,12 +341,13 @@ module Aws::APIGateway
|
|
339
341
|
#
|
340
342
|
# @!attribute [rw] identity_validation_expression
|
341
343
|
# A validation expression for the incoming identity token. For `TOKEN`
|
342
|
-
# authorizers, this value is a regular expression.
|
343
|
-
#
|
344
|
-
# the
|
345
|
-
#
|
346
|
-
#
|
347
|
-
#
|
344
|
+
# authorizers, this value is a regular expression. For
|
345
|
+
# `COGNITO_USER_POOLS` authorizers, API Gateway will match the `aud`
|
346
|
+
# field of the incoming token from the client against the specified
|
347
|
+
# regular expression. It will invoke the authorizer's Lambda function
|
348
|
+
# when there is a match. Otherwise, it will return a 401 Unauthorized
|
349
|
+
# response without calling the Lambda function. The validation
|
350
|
+
# expression does not apply to the `REQUEST` authorizer.
|
348
351
|
# @return [String]
|
349
352
|
#
|
350
353
|
# @!attribute [rw] authorizer_result_ttl_in_seconds
|
@@ -371,12 +374,14 @@ module Aws::APIGateway
|
|
371
374
|
# Represents a collection of Authorizer resources.
|
372
375
|
#
|
373
376
|
# <div class="seeAlso">
|
374
|
-
# [
|
377
|
+
# [Use Lambda Function as Authorizer][1] [Use Cognito User Pool as
|
378
|
+
# Authorizer][2]
|
375
379
|
# </div>
|
376
380
|
#
|
377
381
|
#
|
378
382
|
#
|
379
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/use-
|
383
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html
|
384
|
+
# [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html
|
380
385
|
#
|
381
386
|
# @!attribute [rw] position
|
382
387
|
# @return [String]
|
@@ -757,12 +762,13 @@ module Aws::APIGateway
|
|
757
762
|
#
|
758
763
|
# @!attribute [rw] identity_validation_expression
|
759
764
|
# A validation expression for the incoming identity token. For `TOKEN`
|
760
|
-
# authorizers, this value is a regular expression.
|
761
|
-
#
|
762
|
-
# the
|
763
|
-
#
|
764
|
-
#
|
765
|
-
#
|
765
|
+
# authorizers, this value is a regular expression. For
|
766
|
+
# `COGNITO_USER_POOLS` authorizers, API Gateway will match the `aud`
|
767
|
+
# field of the incoming token from the client against the specified
|
768
|
+
# regular expression. It will invoke the authorizer's Lambda function
|
769
|
+
# when there is a match. Otherwise, it will return a 401 Unauthorized
|
770
|
+
# response without calling the Lambda function. The validation
|
771
|
+
# expression does not apply to the `REQUEST` authorizer.
|
766
772
|
# @return [String]
|
767
773
|
#
|
768
774
|
# @!attribute [rw] authorizer_result_ttl_in_seconds
|
@@ -806,7 +812,7 @@ module Aws::APIGateway
|
|
806
812
|
# @!attribute [rw] base_path
|
807
813
|
# The base path name that callers of the API must provide as part of
|
808
814
|
# the URL after the domain name. This value must be unique for all of
|
809
|
-
# the mappings across a single API.
|
815
|
+
# the mappings across a single API. Specify '(none)' if you do not
|
810
816
|
# want callers to specify a base path name after the domain name.
|
811
817
|
# @return [String]
|
812
818
|
#
|
@@ -816,7 +822,7 @@ module Aws::APIGateway
|
|
816
822
|
#
|
817
823
|
# @!attribute [rw] stage
|
818
824
|
# The name of the API's stage that you want to use for this mapping.
|
819
|
-
#
|
825
|
+
# Specify '(none)' if you do not want callers to explicitly specify
|
820
826
|
# the stage name after any base path name.
|
821
827
|
# @return [String]
|
822
828
|
#
|
@@ -1007,6 +1013,7 @@ module Aws::APIGateway
|
|
1007
1013
|
# tags: {
|
1008
1014
|
# "String" => "String",
|
1009
1015
|
# },
|
1016
|
+
# security_policy: "TLS_1_0", # accepts TLS_1_0, TLS_1_2
|
1010
1017
|
# }
|
1011
1018
|
#
|
1012
1019
|
# @!attribute [rw] domain_name
|
@@ -1068,6 +1075,11 @@ module Aws::APIGateway
|
|
1068
1075
|
# not start with `aws:`. The tag value can be up to 256 characters.
|
1069
1076
|
# @return [Hash<String,String>]
|
1070
1077
|
#
|
1078
|
+
# @!attribute [rw] security_policy
|
1079
|
+
# The Transport Layer Security (TLS) version + cipher suite for this
|
1080
|
+
# DomainName. The valid values are `TLS_1_0` and `TLS_1_2`.
|
1081
|
+
# @return [String]
|
1082
|
+
#
|
1071
1083
|
class CreateDomainNameRequest < Struct.new(
|
1072
1084
|
:domain_name,
|
1073
1085
|
:certificate_name,
|
@@ -1078,7 +1090,8 @@ module Aws::APIGateway
|
|
1078
1090
|
:regional_certificate_name,
|
1079
1091
|
:regional_certificate_arn,
|
1080
1092
|
:endpoint_configuration,
|
1081
|
-
:tags
|
1093
|
+
:tags,
|
1094
|
+
:security_policy)
|
1082
1095
|
include Aws::Structure
|
1083
1096
|
end
|
1084
1097
|
|
@@ -1324,7 +1337,9 @@ module Aws::APIGateway
|
|
1324
1337
|
# @return [String]
|
1325
1338
|
#
|
1326
1339
|
# @!attribute [rw] stage_name
|
1327
|
-
# \[Required\] The name for the Stage resource.
|
1340
|
+
# \[Required\] The name for the Stage resource. Stage names can only
|
1341
|
+
# contain alphanumeric characters, hyphens, and underscores. Maximum
|
1342
|
+
# length is 128 characters.
|
1328
1343
|
# @return [String]
|
1329
1344
|
#
|
1330
1345
|
# @!attribute [rw] deployment_id
|
@@ -1596,6 +1611,8 @@ module Aws::APIGateway
|
|
1596
1611
|
# @!attribute [rw] base_path
|
1597
1612
|
# \[Required\] The base path name of the BasePathMapping resource to
|
1598
1613
|
# delete.
|
1614
|
+
#
|
1615
|
+
# To specify an empty base path, set this parameter to `'(none)'`.
|
1599
1616
|
# @return [String]
|
1600
1617
|
#
|
1601
1618
|
class DeleteBasePathMappingRequest < Struct.new(
|
@@ -2554,6 +2571,23 @@ module Aws::APIGateway
|
|
2554
2571
|
# types of the domain name.
|
2555
2572
|
# @return [Types::EndpointConfiguration]
|
2556
2573
|
#
|
2574
|
+
# @!attribute [rw] domain_name_status
|
2575
|
+
# The status of the DomainName migration. The valid values are
|
2576
|
+
# `AVAILABLE` and `UPDATING`. If the status is `UPDATING`, the domain
|
2577
|
+
# cannot be modified further until the existing operation is complete.
|
2578
|
+
# If it is `AVAILABLE`, the domain can be updated.
|
2579
|
+
# @return [String]
|
2580
|
+
#
|
2581
|
+
# @!attribute [rw] domain_name_status_message
|
2582
|
+
# An optional text message containing detailed information about
|
2583
|
+
# status of the DomainName migration.
|
2584
|
+
# @return [String]
|
2585
|
+
#
|
2586
|
+
# @!attribute [rw] security_policy
|
2587
|
+
# The Transport Layer Security (TLS) version + cipher suite for this
|
2588
|
+
# DomainName. The valid values are `TLS_1_0` and `TLS_1_2`.
|
2589
|
+
# @return [String]
|
2590
|
+
#
|
2557
2591
|
# @!attribute [rw] tags
|
2558
2592
|
# The collection of tags. Each tag element is associated with a given
|
2559
2593
|
# resource.
|
@@ -2571,6 +2605,9 @@ module Aws::APIGateway
|
|
2571
2605
|
:distribution_domain_name,
|
2572
2606
|
:distribution_hosted_zone_id,
|
2573
2607
|
:endpoint_configuration,
|
2608
|
+
:domain_name_status,
|
2609
|
+
:domain_name_status_message,
|
2610
|
+
:security_policy,
|
2574
2611
|
:tags)
|
2575
2612
|
include Aws::Structure
|
2576
2613
|
end
|
@@ -3016,9 +3053,9 @@ module Aws::APIGateway
|
|
3016
3053
|
# @!attribute [rw] base_path
|
3017
3054
|
# \[Required\] The base path name that callers of the API must provide
|
3018
3055
|
# as part of the URL after the domain name. This value must be unique
|
3019
|
-
# for all of the mappings across a single API.
|
3020
|
-
# do not want callers to specify any base path name after the
|
3021
|
-
# name.
|
3056
|
+
# for all of the mappings across a single API. Specify '(none)' if
|
3057
|
+
# you do not want callers to specify any base path name after the
|
3058
|
+
# domain name.
|
3022
3059
|
# @return [String]
|
3023
3060
|
#
|
3024
3061
|
class GetBasePathMappingRequest < Struct.new(
|
@@ -4055,8 +4092,7 @@ module Aws::APIGateway
|
|
4055
4092
|
#
|
4056
4093
|
# @!attribute [rw] resource_arn
|
4057
4094
|
# \[Required\] The ARN of a resource that can be tagged. The resource
|
4058
|
-
# ARN must be URL-encoded.
|
4059
|
-
# resource.
|
4095
|
+
# ARN must be URL-encoded.
|
4060
4096
|
# @return [String]
|
4061
4097
|
#
|
4062
4098
|
# @!attribute [rw] position
|
@@ -4406,8 +4442,8 @@ module Aws::APIGateway
|
|
4406
4442
|
# `endpointConfigurationTypes=PRIVATE`. The default endpoint type is
|
4407
4443
|
# `EDGE`.
|
4408
4444
|
#
|
4409
|
-
# To handle imported `
|
4410
|
-
# `
|
4445
|
+
# To handle imported `basepath`, set `parameters` as
|
4446
|
+
# `basepath=ignore`, `basepath=prepend` or `basepath=split`.
|
4411
4447
|
#
|
4412
4448
|
# For example, the AWS CLI command to exclude documentation from the
|
4413
4449
|
# imported API is:
|
@@ -4604,7 +4640,7 @@ module Aws::APIGateway
|
|
4604
4640
|
#
|
4605
4641
|
# If this property is not defined, the request payload will be passed
|
4606
4642
|
# through from the method request to integration request without
|
4607
|
-
# modification, provided that the `
|
4643
|
+
# modification, provided that the `passthroughBehavior` is configured
|
4608
4644
|
# to support payload pass-through.
|
4609
4645
|
# @return [String]
|
4610
4646
|
#
|
@@ -4614,11 +4650,15 @@ module Aws::APIGateway
|
|
4614
4650
|
# @return [Integer]
|
4615
4651
|
#
|
4616
4652
|
# @!attribute [rw] cache_namespace
|
4617
|
-
#
|
4653
|
+
# An API-specific tag group of related cached parameters. To be valid
|
4654
|
+
# values for `cacheKeyParameters`, these parameters must also be
|
4655
|
+
# specified for Method `requestParameters`.
|
4618
4656
|
# @return [String]
|
4619
4657
|
#
|
4620
4658
|
# @!attribute [rw] cache_key_parameters
|
4621
|
-
#
|
4659
|
+
# A list of request parameters whose values API Gateway caches. To be
|
4660
|
+
# valid values for `cacheKeyParameters`, these parameters must also be
|
4661
|
+
# specified for Method `requestParameters`.
|
4622
4662
|
# @return [Array<String>]
|
4623
4663
|
#
|
4624
4664
|
# @!attribute [rw] integration_responses
|
@@ -4841,11 +4881,7 @@ module Aws::APIGateway
|
|
4841
4881
|
# @!attribute [rw] operation_name
|
4842
4882
|
# A human-friendly operation identifier for the method. For example,
|
4843
4883
|
# you can assign the `operationName` of `ListPets` for the `GET /pets`
|
4844
|
-
# method in
|
4845
|
-
#
|
4846
|
-
#
|
4847
|
-
#
|
4848
|
-
# [1]: https://petstore-demo-endpoint.execute-api.com/petstore/pets
|
4884
|
+
# method in the `PetStore` example.
|
4849
4885
|
# @return [String]
|
4850
4886
|
#
|
4851
4887
|
# @!attribute [rw] request_parameters
|
@@ -5524,11 +5560,11 @@ module Aws::APIGateway
|
|
5524
5560
|
# @return [String]
|
5525
5561
|
#
|
5526
5562
|
# @!attribute [rw] cache_namespace
|
5527
|
-
#
|
5563
|
+
# A list of request parameters whose values are to be cached.
|
5528
5564
|
# @return [String]
|
5529
5565
|
#
|
5530
5566
|
# @!attribute [rw] cache_key_parameters
|
5531
|
-
#
|
5567
|
+
# An API-specific tag group of related cached parameters.
|
5532
5568
|
# @return [Array<String>]
|
5533
5569
|
#
|
5534
5570
|
# @!attribute [rw] content_handling
|
@@ -5544,7 +5580,7 @@ module Aws::APIGateway
|
|
5544
5580
|
#
|
5545
5581
|
# If this property is not defined, the request payload will be passed
|
5546
5582
|
# through from the method request to integration request without
|
5547
|
-
# modification, provided that the `
|
5583
|
+
# modification, provided that the `passthroughBehavior` is configured
|
5548
5584
|
# to support payload pass-through.
|
5549
5585
|
# @return [String]
|
5550
5586
|
#
|
@@ -5719,11 +5755,7 @@ module Aws::APIGateway
|
|
5719
5755
|
# @!attribute [rw] operation_name
|
5720
5756
|
# A human-friendly operation identifier for the method. For example,
|
5721
5757
|
# you can assign the `operationName` of `ListPets` for the `GET /pets`
|
5722
|
-
# method in
|
5723
|
-
#
|
5724
|
-
#
|
5725
|
-
#
|
5726
|
-
# [1]: https://petstore-demo-endpoint.execute-api.com/petstore/pets
|
5758
|
+
# method in the `PetStore` example.
|
5727
5759
|
# @return [String]
|
5728
5760
|
#
|
5729
5761
|
# @!attribute [rw] request_parameters
|
@@ -6344,7 +6376,9 @@ module Aws::APIGateway
|
|
6344
6376
|
#
|
6345
6377
|
# @!attribute [rw] stage_name
|
6346
6378
|
# The name of the stage is the first path segment in the Uniform
|
6347
|
-
# Resource Identifier (URI) of a call to API Gateway.
|
6379
|
+
# Resource Identifier (URI) of a call to API Gateway. Stage names can
|
6380
|
+
# only contain alphanumeric characters, hyphens, and underscores.
|
6381
|
+
# Maximum length is 128 characters.
|
6348
6382
|
# @return [String]
|
6349
6383
|
#
|
6350
6384
|
# @!attribute [rw] description
|
@@ -6491,8 +6525,7 @@ module Aws::APIGateway
|
|
6491
6525
|
#
|
6492
6526
|
# @!attribute [rw] resource_arn
|
6493
6527
|
# \[Required\] The ARN of a resource that can be tagged. The resource
|
6494
|
-
# ARN must be URL-encoded.
|
6495
|
-
# resource.
|
6528
|
+
# ARN must be URL-encoded.
|
6496
6529
|
# @return [String]
|
6497
6530
|
#
|
6498
6531
|
# @!attribute [rw] tags
|
@@ -6856,8 +6889,7 @@ module Aws::APIGateway
|
|
6856
6889
|
#
|
6857
6890
|
# @!attribute [rw] resource_arn
|
6858
6891
|
# \[Required\] The ARN of a resource that can be tagged. The resource
|
6859
|
-
# ARN must be URL-encoded.
|
6860
|
-
# resource.
|
6892
|
+
# ARN must be URL-encoded.
|
6861
6893
|
# @return [String]
|
6862
6894
|
#
|
6863
6895
|
# @!attribute [rw] tag_keys
|
@@ -6993,6 +7025,8 @@ module Aws::APIGateway
|
|
6993
7025
|
# @!attribute [rw] base_path
|
6994
7026
|
# \[Required\] The base path of the BasePathMapping resource to
|
6995
7027
|
# change.
|
7028
|
+
#
|
7029
|
+
# To specify an empty base path, set this parameter to `'(none)'`.
|
6996
7030
|
# @return [String]
|
6997
7031
|
#
|
6998
7032
|
# @!attribute [rw] patch_operations
|
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.32.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: 2019-06-
|
11
|
+
date: 2019-06-24 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|