aws-sdk-apigateway 1.47.0 → 1.53.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 47ca31393579354fbdd611156ed303bd1b16d479dd017c53d38be6a6d64f4533
4
- data.tar.gz: fa821df958ffcec1aa6cec7553584c09b68dcd8f90bf6e9ab5a1d34a6160dbd7
3
+ metadata.gz: 149b2996bb6a58f95d6013062421afd99087ce27d948f7c3ce53be57377ee8d3
4
+ data.tar.gz: c87f53c035f32204bfe9d6ba4a22ce543790cc3729d5b530cf3c681dfd72eae8
5
5
  SHA512:
6
- metadata.gz: acb5f3afa9df6d6a0d6eb30632d2228512aadf0688d54eb0d10586b5a259b9eafddc97347b16dced357330fb1be2b88e2e2857445ec3954a1fff3249e3e5d3da
7
- data.tar.gz: 0b7d2df50a8054a3393d9fb6ca113990c29d25f35f712c0e8546604c1bbc27f7461a087dece9a4b52666b6cc1cd61bea8911e0f1561dd3a35fc8014f9f616605
6
+ metadata.gz: '0796a92f53edfd4c9e9d0671bafaf3578ce2ac2f498c965a9cb824bf613bdf2f341cff0962fe37af4842e8c410a3867619a0eb85049c686c8f828f15ddb2dff0'
7
+ data.tar.gz: 8e84844934fff14d36ffad122e80432b2d46c61c994feb8b6b61a2caf486ddce8768b4cec363b664cc773c5d97633c94558195952329e56364356201c89237ff
@@ -7,6 +7,7 @@
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
10
+
10
11
  require 'aws-sdk-core'
11
12
  require 'aws-sigv4'
12
13
 
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-apigateway/customizations'
44
45
  #
45
46
  # See {Errors} for more information.
46
47
  #
47
- # @service
48
+ # @!group service
48
49
  module Aws::APIGateway
49
50
 
50
- GEM_VERSION = '1.47.0'
51
+ GEM_VERSION = '1.53.0'
51
52
 
52
53
  end
@@ -87,13 +87,28 @@ module Aws::APIGateway
87
87
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
88
88
  # credentials.
89
89
  #
90
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
91
+ # shared file, such as `~/.aws/config`.
92
+ #
93
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
94
+ #
95
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
96
+ # assume a role after providing credentials via the web.
97
+ #
98
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
99
+ # access token generated from `aws login`.
100
+ #
101
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
102
+ # process that outputs to stdout.
103
+ #
90
104
  # * `Aws::InstanceProfileCredentials` - Used for loading credentials
91
105
  # from an EC2 IMDS on an EC2 instance.
92
106
  #
93
- # * `Aws::SharedCredentials` - Used for loading credentials from a
94
- # shared file, such as `~/.aws/config`.
107
+ # * `Aws::ECSCredentials` - Used for loading credentials from
108
+ # instances running in ECS.
95
109
  #
96
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
110
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
111
+ # from the Cognito Identity service.
97
112
  #
98
113
  # When `:credentials` are not configured directly, the following
99
114
  # locations will be searched for credentials:
@@ -103,10 +118,10 @@ module Aws::APIGateway
103
118
  # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
104
119
  # * `~/.aws/credentials`
105
120
  # * `~/.aws/config`
106
- # * EC2 IMDS instance profile - When used by default, the timeouts are
107
- # very aggressive. Construct and pass an instance of
108
- # `Aws::InstanceProfileCredentails` to enable retries and extended
109
- # timeouts.
121
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
122
+ # are very aggressive. Construct and pass an instance of
123
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
124
+ # enable retries and extended timeouts.
110
125
  #
111
126
  # @option options [required, String] :region
112
127
  # The AWS region to connect to. The configured `:region` is
@@ -316,7 +331,7 @@ module Aws::APIGateway
316
331
 
317
332
  # Create an ApiKey resource.
318
333
  #
319
- # <div class="seeAlso">
334
+ # <div class="seeAlso" markdown="1">
320
335
  # [AWS CLI][1]
321
336
  # </div>
322
337
  #
@@ -411,7 +426,7 @@ module Aws::APIGateway
411
426
 
412
427
  # Adds a new Authorizer resource to an existing RestApi resource.
413
428
  #
414
- # <div class="seeAlso">
429
+ # <div class="seeAlso" markdown="1">
415
430
  # [AWS CLI][1]
416
431
  # </div>
417
432
  #
@@ -823,6 +838,11 @@ module Aws::APIGateway
823
838
  # The Transport Layer Security (TLS) version + cipher suite for this
824
839
  # DomainName. The valid values are `TLS_1_0` and `TLS_1_2`.
825
840
  #
841
+ # @option params [Types::MutualTlsAuthenticationInput] :mutual_tls_authentication
842
+ # If specified, API Gateway performs two-way authentication between the
843
+ # client and the server. Clients must present a trusted certificate to
844
+ # access your custom domain name.
845
+ #
826
846
  # @return [Types::DomainName] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
827
847
  #
828
848
  # * {Types::DomainName#domain_name #domain_name} => String
@@ -840,6 +860,7 @@ module Aws::APIGateway
840
860
  # * {Types::DomainName#domain_name_status_message #domain_name_status_message} => String
841
861
  # * {Types::DomainName#security_policy #security_policy} => String
842
862
  # * {Types::DomainName#tags #tags} => Hash&lt;String,String&gt;
863
+ # * {Types::DomainName#mutual_tls_authentication #mutual_tls_authentication} => Types::MutualTlsAuthentication
843
864
  #
844
865
  # @example Request syntax with placeholder values
845
866
  #
@@ -860,6 +881,10 @@ module Aws::APIGateway
860
881
  # "String" => "String",
861
882
  # },
862
883
  # security_policy: "TLS_1_0", # accepts TLS_1_0, TLS_1_2
884
+ # mutual_tls_authentication: {
885
+ # truststore_uri: "String",
886
+ # truststore_version: "String",
887
+ # },
863
888
  # })
864
889
  #
865
890
  # @example Response structure
@@ -883,6 +908,10 @@ module Aws::APIGateway
883
908
  # resp.security_policy #=> String, one of "TLS_1_0", "TLS_1_2"
884
909
  # resp.tags #=> Hash
885
910
  # resp.tags["String"] #=> String
911
+ # resp.mutual_tls_authentication.truststore_uri #=> String
912
+ # resp.mutual_tls_authentication.truststore_version #=> String
913
+ # resp.mutual_tls_authentication.truststore_warnings #=> Array
914
+ # resp.mutual_tls_authentication.truststore_warnings[0] #=> String
886
915
  #
887
916
  # @overload create_domain_name(params = {})
888
917
  # @param [Hash] params ({})
@@ -1541,7 +1570,7 @@ module Aws::APIGateway
1541
1570
 
1542
1571
  # Deletes an existing Authorizer resource.
1543
1572
  #
1544
- # <div class="seeAlso">
1573
+ # <div class="seeAlso" markdown="1">
1545
1574
  # [AWS CLI][1]
1546
1575
  # </div>
1547
1576
  #
@@ -2300,7 +2329,7 @@ module Aws::APIGateway
2300
2329
 
2301
2330
  # Describe an existing Authorizer resource.
2302
2331
  #
2303
- # <div class="seeAlso">
2332
+ # <div class="seeAlso" markdown="1">
2304
2333
  # [AWS CLI][1]
2305
2334
  # </div>
2306
2335
  #
@@ -2357,7 +2386,7 @@ module Aws::APIGateway
2357
2386
 
2358
2387
  # Describe an existing Authorizers resource.
2359
2388
  #
2360
- # <div class="seeAlso">
2389
+ # <div class="seeAlso" markdown="1">
2361
2390
  # [AWS CLI][1]
2362
2391
  # </div>
2363
2392
  #
@@ -2863,6 +2892,7 @@ module Aws::APIGateway
2863
2892
  # * {Types::DomainName#domain_name_status_message #domain_name_status_message} => String
2864
2893
  # * {Types::DomainName#security_policy #security_policy} => String
2865
2894
  # * {Types::DomainName#tags #tags} => Hash&lt;String,String&gt;
2895
+ # * {Types::DomainName#mutual_tls_authentication #mutual_tls_authentication} => Types::MutualTlsAuthentication
2866
2896
  #
2867
2897
  # @example Request syntax with placeholder values
2868
2898
  #
@@ -2891,6 +2921,10 @@ module Aws::APIGateway
2891
2921
  # resp.security_policy #=> String, one of "TLS_1_0", "TLS_1_2"
2892
2922
  # resp.tags #=> Hash
2893
2923
  # resp.tags["String"] #=> String
2924
+ # resp.mutual_tls_authentication.truststore_uri #=> String
2925
+ # resp.mutual_tls_authentication.truststore_version #=> String
2926
+ # resp.mutual_tls_authentication.truststore_warnings #=> Array
2927
+ # resp.mutual_tls_authentication.truststore_warnings[0] #=> String
2894
2928
  #
2895
2929
  # @overload get_domain_name(params = {})
2896
2930
  # @param [Hash] params ({})
@@ -2945,6 +2979,10 @@ module Aws::APIGateway
2945
2979
  # resp.items[0].security_policy #=> String, one of "TLS_1_0", "TLS_1_2"
2946
2980
  # resp.items[0].tags #=> Hash
2947
2981
  # resp.items[0].tags["String"] #=> String
2982
+ # resp.items[0].mutual_tls_authentication.truststore_uri #=> String
2983
+ # resp.items[0].mutual_tls_authentication.truststore_version #=> String
2984
+ # resp.items[0].mutual_tls_authentication.truststore_warnings #=> Array
2985
+ # resp.items[0].mutual_tls_authentication.truststore_warnings[0] #=> String
2948
2986
  #
2949
2987
  # @overload get_domain_names(params = {})
2950
2988
  # @param [Hash] params ({})
@@ -4519,7 +4557,7 @@ module Aws::APIGateway
4519
4557
 
4520
4558
  # Import API keys from an external source, such as a CSV-formatted file.
4521
4559
  #
4522
- # @option params [required, String, IO] :body
4560
+ # @option params [required, String, StringIO, File] :body
4523
4561
  # The payload of the POST request to import API keys. For the payload
4524
4562
  # format, see [API Key File Format][1].
4525
4563
  #
@@ -4575,7 +4613,7 @@ module Aws::APIGateway
4575
4613
  # importation (`true`) or not (`false`) when a warning is encountered.
4576
4614
  # The default value is `false`.
4577
4615
  #
4578
- # @option params [required, String, IO] :body
4616
+ # @option params [required, String, StringIO, File] :body
4579
4617
  # \[Required\] Raw byte array representing the to-be-imported
4580
4618
  # documentation parts. To import from an OpenAPI file, this is a JSON
4581
4619
  # object.
@@ -4643,7 +4681,7 @@ module Aws::APIGateway
4643
4681
  #
4644
4682
  # aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json'
4645
4683
  #
4646
- # @option params [required, String, IO] :body
4684
+ # @option params [required, String, StringIO, File] :body
4647
4685
  # \[Required\] The POST request body containing external API
4648
4686
  # definitions. Currently, only OpenAPI definition JSON/YAML files are
4649
4687
  # supported. The maximum size of the API definition file is 6MB.
@@ -5335,7 +5373,7 @@ module Aws::APIGateway
5335
5373
  # command of `aws apigateway import-rest-api --parameters
5336
5374
  # ignore=documentation --body 'file:///path/to/imported-api-body.json'`.
5337
5375
  #
5338
- # @option params [required, String, IO] :body
5376
+ # @option params [required, String, StringIO, File] :body
5339
5377
  # \[Required\] The PUT request body containing external API definitions.
5340
5378
  # Currently, only OpenAPI definition JSON/YAML files are supported. The
5341
5379
  # maximum size of the API definition file is 6MB.
@@ -5426,7 +5464,7 @@ module Aws::APIGateway
5426
5464
  # Simulate the execution of an Authorizer in your RestApi with headers,
5427
5465
  # parameters, and an incoming request body.
5428
5466
  #
5429
- # <div class="seeAlso">
5467
+ # <div class="seeAlso" markdown="1">
5430
5468
  # [Use Lambda Function as Authorizer][1] [Use Cognito User Pool as
5431
5469
  # Authorizer][2]
5432
5470
  # </div>
@@ -5730,7 +5768,7 @@ module Aws::APIGateway
5730
5768
 
5731
5769
  # Updates an existing Authorizer resource.
5732
5770
  #
5733
- # <div class="seeAlso">
5771
+ # <div class="seeAlso" markdown="1">
5734
5772
  # [AWS CLI][1]
5735
5773
  # </div>
5736
5774
  #
@@ -6067,6 +6105,7 @@ module Aws::APIGateway
6067
6105
  # * {Types::DomainName#domain_name_status_message #domain_name_status_message} => String
6068
6106
  # * {Types::DomainName#security_policy #security_policy} => String
6069
6107
  # * {Types::DomainName#tags #tags} => Hash&lt;String,String&gt;
6108
+ # * {Types::DomainName#mutual_tls_authentication #mutual_tls_authentication} => Types::MutualTlsAuthentication
6070
6109
  #
6071
6110
  # @example Request syntax with placeholder values
6072
6111
  #
@@ -6103,6 +6142,10 @@ module Aws::APIGateway
6103
6142
  # resp.security_policy #=> String, one of "TLS_1_0", "TLS_1_2"
6104
6143
  # resp.tags #=> Hash
6105
6144
  # resp.tags["String"] #=> String
6145
+ # resp.mutual_tls_authentication.truststore_uri #=> String
6146
+ # resp.mutual_tls_authentication.truststore_version #=> String
6147
+ # resp.mutual_tls_authentication.truststore_warnings #=> Array
6148
+ # resp.mutual_tls_authentication.truststore_warnings[0] #=> String
6106
6149
  #
6107
6150
  # @overload update_domain_name(params = {})
6108
6151
  # @param [Hash] params ({})
@@ -7018,7 +7061,7 @@ module Aws::APIGateway
7018
7061
  params: params,
7019
7062
  config: config)
7020
7063
  context[:gem_name] = 'aws-sdk-apigateway'
7021
- context[:gem_version] = '1.47.0'
7064
+ context[:gem_version] = '1.53.0'
7022
7065
  Seahorse::Client::Request.new(handlers, context)
7023
7066
  end
7024
7067
 
@@ -196,6 +196,8 @@ module Aws::APIGateway
196
196
  MethodSnapshot = Shapes::StructureShape.new(name: 'MethodSnapshot')
197
197
  Model = Shapes::StructureShape.new(name: 'Model')
198
198
  Models = Shapes::StructureShape.new(name: 'Models')
199
+ MutualTlsAuthentication = Shapes::StructureShape.new(name: 'MutualTlsAuthentication')
200
+ MutualTlsAuthenticationInput = Shapes::StructureShape.new(name: 'MutualTlsAuthenticationInput')
199
201
  NotFoundException = Shapes::StructureShape.new(name: 'NotFoundException')
200
202
  NullableBoolean = Shapes::BooleanShape.new(name: 'NullableBoolean')
201
203
  NullableInteger = Shapes::IntegerShape.new(name: 'NullableInteger')
@@ -420,6 +422,7 @@ module Aws::APIGateway
420
422
  CreateDomainNameRequest.add_member(:endpoint_configuration, Shapes::ShapeRef.new(shape: EndpointConfiguration, location_name: "endpointConfiguration"))
421
423
  CreateDomainNameRequest.add_member(:tags, Shapes::ShapeRef.new(shape: MapOfStringToString, location_name: "tags"))
422
424
  CreateDomainNameRequest.add_member(:security_policy, Shapes::ShapeRef.new(shape: SecurityPolicy, location_name: "securityPolicy"))
425
+ CreateDomainNameRequest.add_member(:mutual_tls_authentication, Shapes::ShapeRef.new(shape: MutualTlsAuthenticationInput, location_name: "mutualTlsAuthentication"))
423
426
  CreateDomainNameRequest.struct_class = Types::CreateDomainNameRequest
424
427
 
425
428
  CreateModelRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
@@ -627,6 +630,7 @@ module Aws::APIGateway
627
630
  DomainName.add_member(:domain_name_status_message, Shapes::ShapeRef.new(shape: String, location_name: "domainNameStatusMessage"))
628
631
  DomainName.add_member(:security_policy, Shapes::ShapeRef.new(shape: SecurityPolicy, location_name: "securityPolicy"))
629
632
  DomainName.add_member(:tags, Shapes::ShapeRef.new(shape: MapOfStringToString, location_name: "tags"))
633
+ DomainName.add_member(:mutual_tls_authentication, Shapes::ShapeRef.new(shape: MutualTlsAuthentication, location_name: "mutualTlsAuthentication"))
630
634
  DomainName.struct_class = Types::DomainName
631
635
 
632
636
  DomainNames.add_member(:position, Shapes::ShapeRef.new(shape: String, location_name: "position"))
@@ -1061,6 +1065,15 @@ module Aws::APIGateway
1061
1065
  Models.add_member(:items, Shapes::ShapeRef.new(shape: ListOfModel, location_name: "item"))
1062
1066
  Models.struct_class = Types::Models
1063
1067
 
1068
+ MutualTlsAuthentication.add_member(:truststore_uri, Shapes::ShapeRef.new(shape: String, location_name: "truststoreUri"))
1069
+ MutualTlsAuthentication.add_member(:truststore_version, Shapes::ShapeRef.new(shape: String, location_name: "truststoreVersion"))
1070
+ MutualTlsAuthentication.add_member(:truststore_warnings, Shapes::ShapeRef.new(shape: ListOfString, location_name: "truststoreWarnings"))
1071
+ MutualTlsAuthentication.struct_class = Types::MutualTlsAuthentication
1072
+
1073
+ MutualTlsAuthenticationInput.add_member(:truststore_uri, Shapes::ShapeRef.new(shape: String, location_name: "truststoreUri"))
1074
+ MutualTlsAuthenticationInput.add_member(:truststore_version, Shapes::ShapeRef.new(shape: String, location_name: "truststoreVersion"))
1075
+ MutualTlsAuthenticationInput.struct_class = Types::MutualTlsAuthenticationInput
1076
+
1064
1077
  NotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "message"))
1065
1078
  NotFoundException.struct_class = Types::NotFoundException
1066
1079
 
@@ -2105,6 +2118,7 @@ module Aws::APIGateway
2105
2118
  o.input = Shapes::ShapeRef.new(shape: GetDeploymentsRequest)
2106
2119
  o.output = Shapes::ShapeRef.new(shape: Deployments)
2107
2120
  o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
2121
+ o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
2108
2122
  o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
2109
2123
  o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
2110
2124
  o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
@@ -71,7 +71,7 @@ module Aws::APIGateway
71
71
  #
72
72
  # </div>
73
73
  #
74
- # <div class="seeAlso">
74
+ # <div class="seeAlso" markdown="1">
75
75
  # [API Gateway Limits][2] [Developer Guide][3], [AWS CLI][4]
76
76
  # </div>
77
77
  #
@@ -113,7 +113,7 @@ module Aws::APIGateway
113
113
  # on any RestApi, which indicates that the callers with the API key can
114
114
  # make requests to that stage.
115
115
  #
116
- # <div class="seeAlso">
116
+ # <div class="seeAlso" markdown="1">
117
117
  # [Use API Keys][1]
118
118
  # </div>
119
119
  #
@@ -199,7 +199,7 @@ module Aws::APIGateway
199
199
  # Represents a collection of API keys as represented by an ApiKeys
200
200
  # resource.
201
201
  #
202
- # <div class="seeAlso">
202
+ # <div class="seeAlso" markdown="1">
203
203
  # [Use API Keys][1]
204
204
  # </div>
205
205
  #
@@ -268,7 +268,7 @@ module Aws::APIGateway
268
268
  # API Gateway will activate the authorizer when a client calls the
269
269
  # method.
270
270
  #
271
- # <div class="seeAlso">
271
+ # <div class="seeAlso" markdown="1">
272
272
  # [Use Lambda Function as Authorizer][1] [Use Cognito User Pool as
273
273
  # Authorizer][2]
274
274
  # </div>
@@ -385,7 +385,7 @@ module Aws::APIGateway
385
385
 
386
386
  # Represents a collection of Authorizer resources.
387
387
  #
388
- # <div class="seeAlso">
388
+ # <div class="seeAlso" markdown="1">
389
389
  # [Use Lambda Function as Authorizer][1] [Use Cognito User Pool as
390
390
  # Authorizer][2]
391
391
  # </div>
@@ -425,12 +425,12 @@ module Aws::APIGateway
425
425
  # Represents the base path that callers of the API must provide as part
426
426
  # of the URL after the domain name.
427
427
  #
428
- # <div class="remarks">
428
+ # <div class="remarks" markdown="1">
429
429
  # A custom domain name plus a `BasePathMapping` specification identifies
430
430
  # a deployed RestApi in a given stage of the owner Account.
431
431
  # </div>
432
432
  #
433
- # <div class="seeAlso">
433
+ # <div class="seeAlso" markdown="1">
434
434
  # [Use Custom Domain Names][1]
435
435
  # </div>
436
436
  #
@@ -461,7 +461,7 @@ module Aws::APIGateway
461
461
 
462
462
  # Represents a collection of BasePathMapping resources.
463
463
  #
464
- # <div class="seeAlso">
464
+ # <div class="seeAlso" markdown="1">
465
465
  # [Use Custom Domain Names][1]
466
466
  # </div>
467
467
  #
@@ -535,7 +535,7 @@ module Aws::APIGateway
535
535
  # policies, a custom Authorizer or an Amazon Cognito user pool.
536
536
  # </div>
537
537
  #
538
- # <div class="seeAlso">
538
+ # <div class="seeAlso" markdown="1">
539
539
  # [Use Client-Side Certificate][1]
540
540
  # </div>
541
541
  #
@@ -583,7 +583,7 @@ module Aws::APIGateway
583
583
 
584
584
  # Represents a collection of ClientCertificate resources.
585
585
  #
586
- # <div class="seeAlso">
586
+ # <div class="seeAlso" markdown="1">
587
587
  # [Use Client-Side Certificate][1]
588
588
  # </div>
589
589
  #
@@ -1042,6 +1042,10 @@ module Aws::APIGateway
1042
1042
  # "String" => "String",
1043
1043
  # },
1044
1044
  # security_policy: "TLS_1_0", # accepts TLS_1_0, TLS_1_2
1045
+ # mutual_tls_authentication: {
1046
+ # truststore_uri: "String",
1047
+ # truststore_version: "String",
1048
+ # },
1045
1049
  # }
1046
1050
  #
1047
1051
  # @!attribute [rw] domain_name
@@ -1108,6 +1112,12 @@ module Aws::APIGateway
1108
1112
  # DomainName. The valid values are `TLS_1_0` and `TLS_1_2`.
1109
1113
  # @return [String]
1110
1114
  #
1115
+ # @!attribute [rw] mutual_tls_authentication
1116
+ # If specified, API Gateway performs two-way authentication between
1117
+ # the client and the server. Clients must present a trusted
1118
+ # certificate to access your custom domain name.
1119
+ # @return [Types::MutualTlsAuthenticationInput]
1120
+ #
1111
1121
  class CreateDomainNameRequest < Struct.new(
1112
1122
  :domain_name,
1113
1123
  :certificate_name,
@@ -1119,7 +1129,8 @@ module Aws::APIGateway
1119
1129
  :regional_certificate_arn,
1120
1130
  :endpoint_configuration,
1121
1131
  :tags,
1122
- :security_policy)
1132
+ :security_policy,
1133
+ :mutual_tls_authentication)
1123
1134
  SENSITIVE = []
1124
1135
  include Aws::Structure
1125
1136
  end
@@ -2156,14 +2167,14 @@ module Aws::APIGateway
2156
2167
  # by users using Stages. A deployment must be associated with a Stage
2157
2168
  # for it to be callable over the Internet.
2158
2169
  #
2159
- # <div class="remarks">
2170
+ # <div class="remarks" markdown="1">
2160
2171
  # To create a deployment, call `POST` on the Deployments resource of a
2161
2172
  # RestApi. To view, update, or delete a deployment, call `GET`, `PATCH`,
2162
2173
  # or `DELETE` on the specified deployment resource
2163
2174
  # (`/restapis/\{restapi_id\}/deployments/\{deployment_id\}`).
2164
2175
  # </div>
2165
2176
  #
2166
- # <div class="seeAlso">
2177
+ # <div class="seeAlso" markdown="1">
2167
2178
  # RestApi, Deployments, Stage, [AWS CLI][1], [AWS SDKs][2]
2168
2179
  # </div>
2169
2180
  #
@@ -2242,14 +2253,14 @@ module Aws::APIGateway
2242
2253
  # interact with your collection. The collection offers a paginated view
2243
2254
  # of the contained deployments.
2244
2255
  #
2245
- # <div class="remarks">
2256
+ # <div class="remarks" markdown="1">
2246
2257
  # To create a new deployment of a RestApi, make a `POST` request against
2247
2258
  # this resource. To view, update, or delete an existing deployment, make
2248
2259
  # a `GET`, `PATCH`, or `DELETE` request, respectively, on a specified
2249
2260
  # Deployment resource.
2250
2261
  # </div>
2251
2262
  #
2252
- # <div class="seeAlso">
2263
+ # <div class="seeAlso" markdown="1">
2253
2264
  # [Deploying an API][1], [AWS CLI][2], [AWS SDKs][3]
2254
2265
  # </div>
2255
2266
  #
@@ -2292,7 +2303,7 @@ module Aws::APIGateway
2292
2303
  #
2293
2304
  # </div>
2294
2305
  #
2295
- # <div class="seeAlso">
2306
+ # <div class="seeAlso" markdown="1">
2296
2307
  # [Documenting an API][1], DocumentationParts
2297
2308
  # </div>
2298
2309
  #
@@ -2341,7 +2352,7 @@ module Aws::APIGateway
2341
2352
  # external (e.g., OpenAPI) file are imported into API Gateway
2342
2353
  # </div>
2343
2354
  #
2344
- # <div class="seeAlso">
2355
+ # <div class="seeAlso" markdown="1">
2345
2356
  # [Documenting an API][1], [documentationpart:import][2],
2346
2357
  # DocumentationPart
2347
2358
  # </div>
@@ -2444,7 +2455,7 @@ module Aws::APIGateway
2444
2455
  #
2445
2456
  # <div class="remarks"></div>
2446
2457
  #
2447
- # <div class="seeAlso">
2458
+ # <div class="seeAlso" markdown="1">
2448
2459
  # [Documenting an API][1], DocumentationPart
2449
2460
  # </div>
2450
2461
  #
@@ -2475,7 +2486,7 @@ module Aws::APIGateway
2475
2486
  #
2476
2487
  # </div>
2477
2488
  #
2478
- # <div class="seeAlso">
2489
+ # <div class="seeAlso" markdown="1">
2479
2490
  # [Documenting an API][1], DocumentationPart, DocumentationVersions
2480
2491
  # </div>
2481
2492
  #
@@ -2511,7 +2522,7 @@ module Aws::APIGateway
2511
2522
  #
2512
2523
  # </div>
2513
2524
  #
2514
- # <div class="seeAlso">
2525
+ # <div class="seeAlso" markdown="1">
2515
2526
  # [Documenting an API][1], DocumentationPart, DocumentationVersion
2516
2527
  # </div>
2517
2528
  #
@@ -2550,7 +2561,7 @@ module Aws::APIGateway
2550
2561
  #
2551
2562
  # </div>
2552
2563
  #
2553
- # <div class="seeAlso">
2564
+ # <div class="seeAlso" markdown="1">
2554
2565
  # [Set a Custom Host Name for an API][1]
2555
2566
  # </div>
2556
2567
  #
@@ -2661,6 +2672,13 @@ module Aws::APIGateway
2661
2672
  # resource.
2662
2673
  # @return [Hash<String,String>]
2663
2674
  #
2675
+ # @!attribute [rw] mutual_tls_authentication
2676
+ # The mutual TLS authentication configuration for a custom domain
2677
+ # name. If specified, API Gateway performs two-way authentication
2678
+ # between the client and the server. Clients must present a trusted
2679
+ # certificate to access your API.
2680
+ # @return [Types::MutualTlsAuthentication]
2681
+ #
2664
2682
  class DomainName < Struct.new(
2665
2683
  :domain_name,
2666
2684
  :certificate_name,
@@ -2676,14 +2694,15 @@ module Aws::APIGateway
2676
2694
  :domain_name_status,
2677
2695
  :domain_name_status_message,
2678
2696
  :security_policy,
2679
- :tags)
2697
+ :tags,
2698
+ :mutual_tls_authentication)
2680
2699
  SENSITIVE = []
2681
2700
  include Aws::Structure
2682
2701
  end
2683
2702
 
2684
2703
  # Represents a collection of DomainName resources.
2685
2704
  #
2686
- # <div class="seeAlso">
2705
+ # <div class="seeAlso" markdown="1">
2687
2706
  # [Use Client-Side Certificate][1]
2688
2707
  # </div>
2689
2708
  #
@@ -2813,7 +2832,7 @@ module Aws::APIGateway
2813
2832
  # A gateway response of a given response type and status code, with
2814
2833
  # optional response parameters and mapping templates.
2815
2834
  #
2816
- # <div class="remarks">
2835
+ # <div class="remarks" markdown="1">
2817
2836
  # For more information about valid gateway response types, see [Gateway
2818
2837
  # Response Types Supported by API Gateway][1]
2819
2838
  # <div class="example" markdown="1">
@@ -2840,7 +2859,7 @@ module Aws::APIGateway
2840
2859
  # </div>
2841
2860
  # </div>
2842
2861
  #
2843
- # <div class="seeAlso">
2862
+ # <div class="seeAlso" markdown="1">
2844
2863
  # [Customize Gateway Responses][2]
2845
2864
  # </div>
2846
2865
  #
@@ -2908,7 +2927,7 @@ module Aws::APIGateway
2908
2927
  # `responseType`-to-GatewayResponse object map of key-value pairs. As
2909
2928
  # such, pagination is not supported for querying this collection.
2910
2929
  #
2911
- # <div class="remarks">
2930
+ # <div class="remarks" markdown="1">
2912
2931
  # For more information about valid gateway response types, see [Gateway
2913
2932
  # Response Types Supported by API Gateway][1]
2914
2933
  # <div class="example" markdown="1">
@@ -2935,7 +2954,7 @@ module Aws::APIGateway
2935
2954
  # </div>
2936
2955
  # </div>
2937
2956
  #
2938
- # <div class="seeAlso">
2957
+ # <div class="seeAlso" markdown="1">
2939
2958
  # [Customize Gateway Responses][2]
2940
2959
  # </div>
2941
2960
  #
@@ -4607,7 +4626,7 @@ module Aws::APIGateway
4607
4626
  # integration.
4608
4627
  # </div>
4609
4628
  #
4610
- # <div class="seeAlso">
4629
+ # <div class="seeAlso" markdown="1">
4611
4630
  # [Creating an API][1]
4612
4631
  # </div>
4613
4632
  #
@@ -4818,7 +4837,7 @@ module Aws::APIGateway
4818
4837
  #
4819
4838
  # </div>
4820
4839
  #
4821
- # <div class="seeAlso">
4840
+ # <div class="seeAlso" markdown="1">
4822
4841
  # [Creating an API][1]
4823
4842
  # </div>
4824
4843
  #
@@ -4855,7 +4874,7 @@ module Aws::APIGateway
4855
4874
  # existing MethodResponse, and parameters and templates can be used to
4856
4875
  # transform the back-end response.
4857
4876
  #
4858
- # <div class="seeAlso">
4877
+ # <div class="seeAlso" markdown="1">
4859
4878
  # [Creating an API][1]
4860
4879
  # </div>
4861
4880
  #
@@ -4983,7 +5002,7 @@ module Aws::APIGateway
4983
5002
  #
4984
5003
  # </div>
4985
5004
  #
4986
- # <div class="seeAlso">
5005
+ # <div class="seeAlso" markdown="1">
4987
5006
  # MethodResponse, Integration, IntegrationResponse, Resource, [Set up an
4988
5007
  # API's method][2]
4989
5008
  # </div>
@@ -5071,7 +5090,7 @@ module Aws::APIGateway
5071
5090
  #
5072
5091
  # </div>
5073
5092
  #
5074
- # <div class="seeAlso">
5093
+ # <div class="seeAlso" markdown="1">
5075
5094
  # [AWS CLI][1]
5076
5095
  # </div>
5077
5096
  #
@@ -5107,7 +5126,7 @@ module Aws::APIGateway
5107
5126
  #
5108
5127
  # </div>
5109
5128
  #
5110
- # <div class="seeAlso">
5129
+ # <div class="seeAlso" markdown="1">
5111
5130
  # [AWS CLI][1]
5112
5131
  # </div>
5113
5132
  #
@@ -5172,7 +5191,7 @@ module Aws::APIGateway
5172
5191
  #
5173
5192
  # </div>
5174
5193
  #
5175
- # <div class="seeAlso">
5194
+ # <div class="seeAlso" markdown="1">
5176
5195
  # Method, IntegrationResponse, Integration [Creating an API][1]
5177
5196
  # </div>
5178
5197
  #
@@ -5343,7 +5362,7 @@ module Aws::APIGateway
5343
5362
  #
5344
5363
  # </div>
5345
5364
  #
5346
- # <div class="seeAlso">
5365
+ # <div class="seeAlso" markdown="1">
5347
5366
  # Method, MethodResponse, [Models and Mappings][1]
5348
5367
  # </div>
5349
5368
  #
@@ -5392,7 +5411,7 @@ module Aws::APIGateway
5392
5411
 
5393
5412
  # Represents a collection of Model resources.
5394
5413
  #
5395
- # <div class="seeAlso">
5414
+ # <div class="seeAlso" markdown="1">
5396
5415
  # Method, MethodResponse, [Models and Mappings][1]
5397
5416
  # </div>
5398
5417
  #
@@ -5414,6 +5433,77 @@ module Aws::APIGateway
5414
5433
  include Aws::Structure
5415
5434
  end
5416
5435
 
5436
+ # If specified, API Gateway performs two-way authentication between the
5437
+ # client and the server. Clients must present a trusted certificate to
5438
+ # access your custom domain name.
5439
+ #
5440
+ # @!attribute [rw] truststore_uri
5441
+ # An Amazon S3 URL that specifies the truststore for mutual TLS
5442
+ # authentication, for example `s3://bucket-name/key-name`. The
5443
+ # truststore can contain certificates from public or private
5444
+ # certificate authorities. To update the truststore, upload a new
5445
+ # version to S3, and then update your custom domain name to use the
5446
+ # new version. To update the truststore, you must have permissions to
5447
+ # access the S3 object.
5448
+ # @return [String]
5449
+ #
5450
+ # @!attribute [rw] truststore_version
5451
+ # The version of the S3 object that contains your truststore. To
5452
+ # specify a version, you must have versioning enabled for the S3
5453
+ # bucket.
5454
+ # @return [String]
5455
+ #
5456
+ # @!attribute [rw] truststore_warnings
5457
+ # A list of warnings that API Gateway returns while processing your
5458
+ # truststore. Invalid certificates produce warnings. Mutual TLS is
5459
+ # still enabled, but some clients might not be able to access your
5460
+ # API. To resolve warnings, upload a new truststore to S3, and then
5461
+ # update you domain name to use the new version.
5462
+ # @return [Array<String>]
5463
+ #
5464
+ class MutualTlsAuthentication < Struct.new(
5465
+ :truststore_uri,
5466
+ :truststore_version,
5467
+ :truststore_warnings)
5468
+ SENSITIVE = []
5469
+ include Aws::Structure
5470
+ end
5471
+
5472
+ # If specified, API Gateway performs two-way authentication between the
5473
+ # client and the server. Clients must present a trusted certificate to
5474
+ # access your custom domain name.
5475
+ #
5476
+ # @note When making an API call, you may pass MutualTlsAuthenticationInput
5477
+ # data as a hash:
5478
+ #
5479
+ # {
5480
+ # truststore_uri: "String",
5481
+ # truststore_version: "String",
5482
+ # }
5483
+ #
5484
+ # @!attribute [rw] truststore_uri
5485
+ # An Amazon S3 resource ARN that specifies the truststore for mutual
5486
+ # TLS authentication, for example, `s3://bucket-name/key-name`. The
5487
+ # truststore can contain certificates from public or private
5488
+ # certificate authorities. To update the truststore, upload a new
5489
+ # version to S3, and then update your custom domain name to use the
5490
+ # new version. To update the truststore, you must have permissions to
5491
+ # access the S3 object.
5492
+ # @return [String]
5493
+ #
5494
+ # @!attribute [rw] truststore_version
5495
+ # The version of the S3 object that contains your truststore. To
5496
+ # specify a version, you must have versioning enabled for the S3
5497
+ # bucket.
5498
+ # @return [String]
5499
+ #
5500
+ class MutualTlsAuthenticationInput < Struct.new(
5501
+ :truststore_uri,
5502
+ :truststore_version)
5503
+ SENSITIVE = []
5504
+ include Aws::Structure
5505
+ end
5506
+
5417
5507
  # The requested resource is not found. Make sure that the request URI is
5418
5508
  # correct.
5419
5509
  #
@@ -6145,7 +6235,7 @@ module Aws::APIGateway
6145
6235
  #
6146
6236
  # </div>
6147
6237
  #
6148
- # <div class="seeAlso">
6238
+ # <div class="seeAlso" markdown="1">
6149
6239
  # [Enable Basic Request Validation in API Gateway][3]
6150
6240
  # </div>
6151
6241
  #
@@ -6190,7 +6280,7 @@ module Aws::APIGateway
6190
6280
  #
6191
6281
  # </div>
6192
6282
  #
6193
- # <div class="seeAlso">
6283
+ # <div class="seeAlso" markdown="1">
6194
6284
  # [Enable Basic Request Validation in API Gateway][2]
6195
6285
  # </div>
6196
6286
  #
@@ -6215,7 +6305,7 @@ module Aws::APIGateway
6215
6305
 
6216
6306
  # Represents an API resource.
6217
6307
  #
6218
- # <div class="seeAlso">
6308
+ # <div class="seeAlso" markdown="1">
6219
6309
  # [Create an API][1]
6220
6310
  # </div>
6221
6311
  #
@@ -6281,7 +6371,7 @@ module Aws::APIGateway
6281
6371
 
6282
6372
  # Represents a collection of Resource resources.
6283
6373
  #
6284
- # <div class="seeAlso">
6374
+ # <div class="seeAlso" markdown="1">
6285
6375
  # [Create an API][1]
6286
6376
  # </div>
6287
6377
  #
@@ -6305,7 +6395,7 @@ module Aws::APIGateway
6305
6395
 
6306
6396
  # Represents a REST API.
6307
6397
  #
6308
- # <div class="seeAlso">
6398
+ # <div class="seeAlso" markdown="1">
6309
6399
  # [Create an API][1]
6310
6400
  # </div>
6311
6401
  #
@@ -6397,7 +6487,7 @@ module Aws::APIGateway
6397
6487
  # interact with your collection. A collection offers a paginated view of
6398
6488
  # your APIs.
6399
6489
  #
6400
- # <div class="seeAlso">
6490
+ # <div class="seeAlso" markdown="1">
6401
6491
  # [Create an API][1]
6402
6492
  # </div>
6403
6493
  #
@@ -6538,7 +6628,7 @@ module Aws::APIGateway
6538
6628
  # Represents a unique identifier for a version of a deployed RestApi
6539
6629
  # that is callable by users.
6540
6630
  #
6541
- # <div class="seeAlso">
6631
+ # <div class="seeAlso" markdown="1">
6542
6632
  # [Deploy an API][1]
6543
6633
  # </div>
6544
6634
  #
@@ -6676,7 +6766,7 @@ module Aws::APIGateway
6676
6766
  # A list of Stage resources that are associated with the ApiKey
6677
6767
  # resource.
6678
6768
  #
6679
- # <div class="seeAlso">
6769
+ # <div class="seeAlso" markdown="1">
6680
6770
  # [Deploying API in Stages][1]
6681
6771
  # </div>
6682
6772
  #
@@ -6740,7 +6830,7 @@ module Aws::APIGateway
6740
6830
 
6741
6831
  # Represents a mapping template used to transform a payload.
6742
6832
  #
6743
- # <div class="seeAlso">
6833
+ # <div class="seeAlso" markdown="1">
6744
6834
  # [Mapping Templates][1]
6745
6835
  # </div>
6746
6836
  #
@@ -6971,7 +7061,7 @@ module Aws::APIGateway
6971
7061
 
6972
7062
  # Represents the response of the test invoke request in the HTTP method.
6973
7063
  #
6974
- # <div class="seeAlso">
7064
+ # <div class="seeAlso" markdown="1">
6975
7065
  # [Test API using the API Gateway console][1]
6976
7066
  # </div>
6977
7067
  #
@@ -8016,7 +8106,7 @@ module Aws::APIGateway
8016
8106
  #
8017
8107
  # <div class="remarks"></div>
8018
8108
  #
8019
- # <div class="seeAlso">
8109
+ # <div class="seeAlso" markdown="1">
8020
8110
  # [Create and Use Usage Plans][1], [Manage Usage in a Usage Plan][2]
8021
8111
  # </div>
8022
8112
  #
@@ -8069,7 +8159,7 @@ module Aws::APIGateway
8069
8159
  #
8070
8160
  # </div>
8071
8161
  #
8072
- # <div class="seeAlso">
8162
+ # <div class="seeAlso" markdown="1">
8073
8163
  # [Create and Use Usage Plans][1]
8074
8164
  # </div>
8075
8165
  #
@@ -8133,7 +8223,7 @@ module Aws::APIGateway
8133
8223
  #
8134
8224
  # </div>
8135
8225
  #
8136
- # " <div class="seeAlso">
8226
+ # " <div class="seeAlso" markdown="1">
8137
8227
  # [Create and Use Usage Plans][1]
8138
8228
  # </div>
8139
8229
  #
@@ -8170,7 +8260,7 @@ module Aws::APIGateway
8170
8260
  # Represents the collection of usage plan keys added to usage plans for
8171
8261
  # the associated API keys and, possibly, other types of keys.
8172
8262
  #
8173
- # <div class="seeAlso">
8263
+ # <div class="seeAlso" markdown="1">
8174
8264
  # [Create and Use Usage Plans][1]
8175
8265
  # </div>
8176
8266
  #
@@ -8194,7 +8284,7 @@ module Aws::APIGateway
8194
8284
 
8195
8285
  # Represents a collection of usage plans for an AWS account.
8196
8286
  #
8197
- # <div class="seeAlso">
8287
+ # <div class="seeAlso" markdown="1">
8198
8288
  # [Create and Use Usage Plans][1]
8199
8289
  # </div>
8200
8290
  #
@@ -8279,7 +8369,7 @@ module Aws::APIGateway
8279
8369
 
8280
8370
  # The collection of VPC links under the caller's account in a region.
8281
8371
  #
8282
- # <div class="seeAlso">
8372
+ # <div class="seeAlso" markdown="1">
8283
8373
  # [Getting Started with Private Integrations][1], [Set up Private
8284
8374
  # Integrations][2]
8285
8375
  # </div>
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.47.0
4
+ version: 1.53.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-06-23 00:00:00.000000000 Z
11
+ date: 2020-09-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core