aws-sdk-apigateway 1.108.0 → 1.110.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-apigateway/client.rb +281 -52
- data/lib/aws-sdk-apigateway/client_api.rb +105 -0
- data/lib/aws-sdk-apigateway/types.rb +316 -106
- data/lib/aws-sdk-apigateway.rb +1 -1
- data/sig/client.rbs +69 -4
- data/sig/types.rbs +55 -0
- metadata +2 -2
@@ -209,7 +209,7 @@ module Aws::APIGateway
|
|
209
209
|
# @!attribute [rw] provider_arns
|
210
210
|
# A list of the Amazon Cognito user pool ARNs for the
|
211
211
|
# `COGNITO_USER_POOLS` authorizer. Each element is of this format:
|
212
|
-
# `arn:aws:cognito-idp
|
212
|
+
# `arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}`.
|
213
213
|
# For a `TOKEN` or `REQUEST` authorizer, this is not defined.
|
214
214
|
# @return [Array<String>]
|
215
215
|
#
|
@@ -222,10 +222,10 @@ module Aws::APIGateway
|
|
222
222
|
# Specifies the authorizer's Uniform Resource Identifier (URI). For
|
223
223
|
# `TOKEN` or `REQUEST` authorizers, this must be a well-formed Lambda
|
224
224
|
# function URI, for example,
|
225
|
-
# `arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2
|
225
|
+
# `arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations`.
|
226
226
|
# In general, the URI has this form
|
227
|
-
# `arn:aws:apigateway
|
228
|
-
#
|
227
|
+
# `arn:aws:apigateway:{region}:lambda:path/{service_api}`, where
|
228
|
+
# `{region}` is the same as the region hosting the Lambda function,
|
229
229
|
# `path` indicates that the remaining substring in the URI should be
|
230
230
|
# treated as the path to the resource, including the initial `/`. For
|
231
231
|
# Lambda functions, this is usually of the form
|
@@ -538,7 +538,7 @@ module Aws::APIGateway
|
|
538
538
|
# @!attribute [rw] provider_arns
|
539
539
|
# A list of the Amazon Cognito user pool ARNs for the
|
540
540
|
# `COGNITO_USER_POOLS` authorizer. Each element is of this format:
|
541
|
-
# `arn:aws:cognito-idp
|
541
|
+
# `arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}`.
|
542
542
|
# For a `TOKEN` or `REQUEST` authorizer, this is not defined.
|
543
543
|
# @return [Array<String>]
|
544
544
|
#
|
@@ -551,10 +551,10 @@ module Aws::APIGateway
|
|
551
551
|
# Specifies the authorizer's Uniform Resource Identifier (URI). For
|
552
552
|
# `TOKEN` or `REQUEST` authorizers, this must be a well-formed Lambda
|
553
553
|
# function URI, for example,
|
554
|
-
# `arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2
|
554
|
+
# `arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations`.
|
555
555
|
# In general, the URI has this form
|
556
|
-
# `arn:aws:apigateway
|
557
|
-
#
|
556
|
+
# `arn:aws:apigateway:{region}:lambda:path/{service_api}`, where
|
557
|
+
# `{region}` is the same as the region hosting the Lambda function,
|
558
558
|
# `path` indicates that the remaining substring in the URI should be
|
559
559
|
# treated as the path to the resource, including the initial `/`. For
|
560
560
|
# Lambda functions, this is usually of the form
|
@@ -631,6 +631,11 @@ module Aws::APIGateway
|
|
631
631
|
# The domain name of the BasePathMapping resource to create.
|
632
632
|
# @return [String]
|
633
633
|
#
|
634
|
+
# @!attribute [rw] domain_name_id
|
635
|
+
# The identifier for the domain name resource. Supported only for
|
636
|
+
# private custom domain names.
|
637
|
+
# @return [String]
|
638
|
+
#
|
634
639
|
# @!attribute [rw] base_path
|
635
640
|
# The base path name that callers of the API must provide as part of
|
636
641
|
# the URL after the domain name. This value must be unique for all of
|
@@ -650,6 +655,7 @@ module Aws::APIGateway
|
|
650
655
|
#
|
651
656
|
class CreateBasePathMappingRequest < Struct.new(
|
652
657
|
:domain_name,
|
658
|
+
:domain_name_id,
|
653
659
|
:base_path,
|
654
660
|
:rest_api_id,
|
655
661
|
:stage)
|
@@ -776,6 +782,34 @@ module Aws::APIGateway
|
|
776
782
|
include Aws::Structure
|
777
783
|
end
|
778
784
|
|
785
|
+
# @!attribute [rw] domain_name_arn
|
786
|
+
# The ARN of the domain name.
|
787
|
+
# @return [String]
|
788
|
+
#
|
789
|
+
# @!attribute [rw] access_association_source_type
|
790
|
+
# The type of the domain name access association source.
|
791
|
+
# @return [String]
|
792
|
+
#
|
793
|
+
# @!attribute [rw] access_association_source
|
794
|
+
# The identifier of the domain name access association source. For a
|
795
|
+
# VPCE, the value is the VPC endpoint ID.
|
796
|
+
# @return [String]
|
797
|
+
#
|
798
|
+
# @!attribute [rw] tags
|
799
|
+
# The key-value map of strings. The valid character set is
|
800
|
+
# \[a-zA-Z+-=.\_:/\]. The tag key can be up to 128 characters and must
|
801
|
+
# not start with `aws:`. The tag value can be up to 256 characters.
|
802
|
+
# @return [Hash<String,String>]
|
803
|
+
#
|
804
|
+
class CreateDomainNameAccessAssociationRequest < Struct.new(
|
805
|
+
:domain_name_arn,
|
806
|
+
:access_association_source_type,
|
807
|
+
:access_association_source,
|
808
|
+
:tags)
|
809
|
+
SENSITIVE = []
|
810
|
+
include Aws::Structure
|
811
|
+
end
|
812
|
+
|
779
813
|
# A request to create a new domain name.
|
780
814
|
#
|
781
815
|
# @!attribute [rw] domain_name
|
@@ -784,13 +818,13 @@ module Aws::APIGateway
|
|
784
818
|
#
|
785
819
|
# @!attribute [rw] certificate_name
|
786
820
|
# The user-friendly name of the certificate that will be used by
|
787
|
-
# edge-optimized endpoint for this domain name.
|
821
|
+
# edge-optimized endpoint or private endpoint for this domain name.
|
788
822
|
# @return [String]
|
789
823
|
#
|
790
824
|
# @!attribute [rw] certificate_body
|
791
825
|
# \[Deprecated\] The body of the server certificate that will be used
|
792
|
-
# by edge-optimized endpoint for this domain name
|
793
|
-
# certificate authority.
|
826
|
+
# by edge-optimized endpoint or private endpoint for this domain name
|
827
|
+
# provided by your certificate authority.
|
794
828
|
# @return [String]
|
795
829
|
#
|
796
830
|
# @!attribute [rw] certificate_private_key
|
@@ -811,8 +845,8 @@ module Aws::APIGateway
|
|
811
845
|
#
|
812
846
|
# @!attribute [rw] certificate_arn
|
813
847
|
# The reference to an Amazon Web Services-managed certificate that
|
814
|
-
# will be used by edge-optimized endpoint for this
|
815
|
-
# Certificate Manager is the only supported source.
|
848
|
+
# will be used by edge-optimized endpoint or private endpoint for this
|
849
|
+
# domain name. Certificate Manager is the only supported source.
|
816
850
|
# @return [String]
|
817
851
|
#
|
818
852
|
# @!attribute [rw] regional_certificate_name
|
@@ -856,6 +890,12 @@ module Aws::APIGateway
|
|
856
890
|
# as the regionalCertificateArn.
|
857
891
|
# @return [String]
|
858
892
|
#
|
893
|
+
# @!attribute [rw] policy
|
894
|
+
# A stringified JSON policy document that applies to the `execute-api`
|
895
|
+
# service for this DomainName regardless of the caller and Method
|
896
|
+
# configuration. Supported only for private custom domain names.
|
897
|
+
# @return [String]
|
898
|
+
#
|
859
899
|
class CreateDomainNameRequest < Struct.new(
|
860
900
|
:domain_name,
|
861
901
|
:certificate_name,
|
@@ -869,7 +909,8 @@ module Aws::APIGateway
|
|
869
909
|
:tags,
|
870
910
|
:security_policy,
|
871
911
|
:mutual_tls_authentication,
|
872
|
-
:ownership_verification_certificate_arn
|
912
|
+
:ownership_verification_certificate_arn,
|
913
|
+
:policy)
|
873
914
|
SENSITIVE = []
|
874
915
|
include Aws::Structure
|
875
916
|
end
|
@@ -1018,10 +1059,9 @@ module Aws::APIGateway
|
|
1018
1059
|
# @!attribute [rw] disable_execute_api_endpoint
|
1019
1060
|
# Specifies whether clients can invoke your API by using the default
|
1020
1061
|
# `execute-api` endpoint. By default, clients can invoke your API with
|
1021
|
-
# the default
|
1022
|
-
#
|
1023
|
-
#
|
1024
|
-
# disable the default endpoint
|
1062
|
+
# the default `https://{api_id}.execute-api.{region}.amazonaws.com`
|
1063
|
+
# endpoint. To require that clients use a custom domain name to invoke
|
1064
|
+
# your API, disable the default endpoint
|
1025
1065
|
# @return [Boolean]
|
1026
1066
|
#
|
1027
1067
|
class CreateRestApiRequest < Struct.new(
|
@@ -1250,6 +1290,11 @@ module Aws::APIGateway
|
|
1250
1290
|
# The domain name of the BasePathMapping resource to delete.
|
1251
1291
|
# @return [String]
|
1252
1292
|
#
|
1293
|
+
# @!attribute [rw] domain_name_id
|
1294
|
+
# The identifier for the domain name resource. Supported only for
|
1295
|
+
# private custom domain names.
|
1296
|
+
# @return [String]
|
1297
|
+
#
|
1253
1298
|
# @!attribute [rw] base_path
|
1254
1299
|
# The base path name of the BasePathMapping resource to delete.
|
1255
1300
|
#
|
@@ -1258,6 +1303,7 @@ module Aws::APIGateway
|
|
1258
1303
|
#
|
1259
1304
|
class DeleteBasePathMappingRequest < Struct.new(
|
1260
1305
|
:domain_name,
|
1306
|
+
:domain_name_id,
|
1261
1307
|
:base_path)
|
1262
1308
|
SENSITIVE = []
|
1263
1309
|
include Aws::Structure
|
@@ -1326,14 +1372,30 @@ module Aws::APIGateway
|
|
1326
1372
|
include Aws::Structure
|
1327
1373
|
end
|
1328
1374
|
|
1375
|
+
# @!attribute [rw] domain_name_access_association_arn
|
1376
|
+
# The ARN of the domain name access association resource.
|
1377
|
+
# @return [String]
|
1378
|
+
#
|
1379
|
+
class DeleteDomainNameAccessAssociationRequest < Struct.new(
|
1380
|
+
:domain_name_access_association_arn)
|
1381
|
+
SENSITIVE = []
|
1382
|
+
include Aws::Structure
|
1383
|
+
end
|
1384
|
+
|
1329
1385
|
# A request to delete the DomainName resource.
|
1330
1386
|
#
|
1331
1387
|
# @!attribute [rw] domain_name
|
1332
1388
|
# The name of the DomainName resource to be deleted.
|
1333
1389
|
# @return [String]
|
1334
1390
|
#
|
1391
|
+
# @!attribute [rw] domain_name_id
|
1392
|
+
# The identifier for the domain name resource. Supported only for
|
1393
|
+
# private custom domain names.
|
1394
|
+
# @return [String]
|
1395
|
+
#
|
1335
1396
|
class DeleteDomainNameRequest < Struct.new(
|
1336
|
-
:domain_name
|
1397
|
+
:domain_name,
|
1398
|
+
:domain_name_id)
|
1337
1399
|
SENSITIVE = []
|
1338
1400
|
include Aws::Structure
|
1339
1401
|
end
|
@@ -1676,7 +1738,7 @@ module Aws::APIGateway
|
|
1676
1738
|
# @!attribute [rw] properties
|
1677
1739
|
# A content map of API-specific key-value pairs describing the
|
1678
1740
|
# targeted API entity. The map must be encoded as a JSON string, e.g.,
|
1679
|
-
# `"
|
1741
|
+
# `"{ "description": "The API does ..." }"`. Only
|
1680
1742
|
# OpenAPI-compliant documentation-related fields from the properties
|
1681
1743
|
# map are exported and, hence, published as part of the API entity
|
1682
1744
|
# definitions, while the original documentation parts are exported in
|
@@ -1832,21 +1894,30 @@ module Aws::APIGateway
|
|
1832
1894
|
# `my-api.example.com`.
|
1833
1895
|
# @return [String]
|
1834
1896
|
#
|
1897
|
+
# @!attribute [rw] domain_name_id
|
1898
|
+
# The identifier for the domain name resource. Supported only for
|
1899
|
+
# private custom domain names.
|
1900
|
+
# @return [String]
|
1901
|
+
#
|
1902
|
+
# @!attribute [rw] domain_name_arn
|
1903
|
+
# The ARN of the domain name. Supported only for private custom domain
|
1904
|
+
# names.
|
1905
|
+
# @return [String]
|
1906
|
+
#
|
1835
1907
|
# @!attribute [rw] certificate_name
|
1836
1908
|
# The name of the certificate that will be used by edge-optimized
|
1837
|
-
# endpoint for this domain name.
|
1909
|
+
# endpoint or private endpoint for this domain name.
|
1838
1910
|
# @return [String]
|
1839
1911
|
#
|
1840
1912
|
# @!attribute [rw] certificate_arn
|
1841
1913
|
# The reference to an Amazon Web Services-managed certificate that
|
1842
|
-
# will be used by edge-optimized endpoint for this
|
1843
|
-
# Certificate Manager is the only supported source.
|
1914
|
+
# will be used by edge-optimized endpoint or private endpoint for this
|
1915
|
+
# domain name. Certificate Manager is the only supported source.
|
1844
1916
|
# @return [String]
|
1845
1917
|
#
|
1846
1918
|
# @!attribute [rw] certificate_upload_date
|
1847
1919
|
# The timestamp when the certificate that was used by edge-optimized
|
1848
|
-
# endpoint for this domain name was uploaded.
|
1849
|
-
# change this value if you update the certificate.
|
1920
|
+
# endpoint or private endpoint for this domain name was uploaded.
|
1850
1921
|
# @return [Time]
|
1851
1922
|
#
|
1852
1923
|
# @!attribute [rw] regional_domain_name
|
@@ -1930,8 +2001,24 @@ module Aws::APIGateway
|
|
1930
2001
|
# as the regionalCertificateArn.
|
1931
2002
|
# @return [String]
|
1932
2003
|
#
|
2004
|
+
# @!attribute [rw] management_policy
|
2005
|
+
# A stringified JSON policy document that applies to the API Gateway
|
2006
|
+
# Management service for this DomainName. This policy document
|
2007
|
+
# controls access for access association sources to create domain name
|
2008
|
+
# access associations with this DomainName. Supported only for private
|
2009
|
+
# custom domain names.
|
2010
|
+
# @return [String]
|
2011
|
+
#
|
2012
|
+
# @!attribute [rw] policy
|
2013
|
+
# A stringified JSON policy document that applies to the `execute-api`
|
2014
|
+
# service for this DomainName regardless of the caller and Method
|
2015
|
+
# configuration. Supported only for private custom domain names.
|
2016
|
+
# @return [String]
|
2017
|
+
#
|
1933
2018
|
class DomainName < Struct.new(
|
1934
2019
|
:domain_name,
|
2020
|
+
:domain_name_id,
|
2021
|
+
:domain_name_arn,
|
1935
2022
|
:certificate_name,
|
1936
2023
|
:certificate_arn,
|
1937
2024
|
:certificate_upload_date,
|
@@ -1947,7 +2034,60 @@ module Aws::APIGateway
|
|
1947
2034
|
:security_policy,
|
1948
2035
|
:tags,
|
1949
2036
|
:mutual_tls_authentication,
|
1950
|
-
:ownership_verification_certificate_arn
|
2037
|
+
:ownership_verification_certificate_arn,
|
2038
|
+
:management_policy,
|
2039
|
+
:policy)
|
2040
|
+
SENSITIVE = []
|
2041
|
+
include Aws::Structure
|
2042
|
+
end
|
2043
|
+
|
2044
|
+
# Represents a domain name access association between an access
|
2045
|
+
# association source and a private custom domain name. With a domain
|
2046
|
+
# name access association, an access association source can invoke a
|
2047
|
+
# private custom domain name while isolated from the public internet.
|
2048
|
+
#
|
2049
|
+
# @!attribute [rw] domain_name_access_association_arn
|
2050
|
+
# The ARN of the domain name access association resource.
|
2051
|
+
# @return [String]
|
2052
|
+
#
|
2053
|
+
# @!attribute [rw] domain_name_arn
|
2054
|
+
# The ARN of the domain name.
|
2055
|
+
# @return [String]
|
2056
|
+
#
|
2057
|
+
# @!attribute [rw] access_association_source_type
|
2058
|
+
# The type of the domain name access association source.
|
2059
|
+
# @return [String]
|
2060
|
+
#
|
2061
|
+
# @!attribute [rw] access_association_source
|
2062
|
+
# The ARN of the domain name access association source. For a VPCE,
|
2063
|
+
# the ARN must be a VPC endpoint.
|
2064
|
+
# @return [String]
|
2065
|
+
#
|
2066
|
+
# @!attribute [rw] tags
|
2067
|
+
# The collection of tags. Each tag element is associated with a given
|
2068
|
+
# resource.
|
2069
|
+
# @return [Hash<String,String>]
|
2070
|
+
#
|
2071
|
+
class DomainNameAccessAssociation < Struct.new(
|
2072
|
+
:domain_name_access_association_arn,
|
2073
|
+
:domain_name_arn,
|
2074
|
+
:access_association_source_type,
|
2075
|
+
:access_association_source,
|
2076
|
+
:tags)
|
2077
|
+
SENSITIVE = []
|
2078
|
+
include Aws::Structure
|
2079
|
+
end
|
2080
|
+
|
2081
|
+
# @!attribute [rw] position
|
2082
|
+
# @return [String]
|
2083
|
+
#
|
2084
|
+
# @!attribute [rw] items
|
2085
|
+
# The current page of elements from this collection.
|
2086
|
+
# @return [Array<Types::DomainNameAccessAssociation>]
|
2087
|
+
#
|
2088
|
+
class DomainNameAccessAssociations < Struct.new(
|
2089
|
+
:position,
|
2090
|
+
:items)
|
1951
2091
|
SENSITIVE = []
|
1952
2092
|
include Aws::Structure
|
1953
2093
|
end
|
@@ -2230,6 +2370,11 @@ module Aws::APIGateway
|
|
2230
2370
|
# The domain name of the BasePathMapping resource to be described.
|
2231
2371
|
# @return [String]
|
2232
2372
|
#
|
2373
|
+
# @!attribute [rw] domain_name_id
|
2374
|
+
# The identifier for the domain name resource. Supported only for
|
2375
|
+
# private custom domain names.
|
2376
|
+
# @return [String]
|
2377
|
+
#
|
2233
2378
|
# @!attribute [rw] base_path
|
2234
2379
|
# The base path name that callers of the API must provide as part of
|
2235
2380
|
# the URL after the domain name. This value must be unique for all of
|
@@ -2239,6 +2384,7 @@ module Aws::APIGateway
|
|
2239
2384
|
#
|
2240
2385
|
class GetBasePathMappingRequest < Struct.new(
|
2241
2386
|
:domain_name,
|
2387
|
+
:domain_name_id,
|
2242
2388
|
:base_path)
|
2243
2389
|
SENSITIVE = []
|
2244
2390
|
include Aws::Structure
|
@@ -2251,6 +2397,11 @@ module Aws::APIGateway
|
|
2251
2397
|
# The domain name of a BasePathMapping resource.
|
2252
2398
|
# @return [String]
|
2253
2399
|
#
|
2400
|
+
# @!attribute [rw] domain_name_id
|
2401
|
+
# The identifier for the domain name resource. Supported only for
|
2402
|
+
# private custom domain names.
|
2403
|
+
# @return [String]
|
2404
|
+
#
|
2254
2405
|
# @!attribute [rw] position
|
2255
2406
|
# The current pagination position in the paged result set.
|
2256
2407
|
# @return [String]
|
@@ -2262,6 +2413,7 @@ module Aws::APIGateway
|
|
2262
2413
|
#
|
2263
2414
|
class GetBasePathMappingsRequest < Struct.new(
|
2264
2415
|
:domain_name,
|
2416
|
+
:domain_name_id,
|
2265
2417
|
:position,
|
2266
2418
|
:limit)
|
2267
2419
|
SENSITIVE = []
|
@@ -2315,13 +2467,13 @@ module Aws::APIGateway
|
|
2315
2467
|
# the returned Deployment resource in the response. In a REST API
|
2316
2468
|
# call, this `embed` parameter value is a list of comma-separated
|
2317
2469
|
# strings, as in `GET
|
2318
|
-
# /restapis
|
2470
|
+
# /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2`.
|
2319
2471
|
# The SDK and other platform-dependent libraries might use a different
|
2320
2472
|
# format for the list. Currently, this request supports only retrieval
|
2321
2473
|
# of the embedded API summary this way. Hence, the parameter value
|
2322
2474
|
# must be a single-valued list containing only the `"apisummary"`
|
2323
2475
|
# string. For example, `GET
|
2324
|
-
# /restapis
|
2476
|
+
# /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary`.
|
2325
2477
|
# @return [Array<String>]
|
2326
2478
|
#
|
2327
2479
|
class GetDeploymentRequest < Struct.new(
|
@@ -2461,14 +2613,45 @@ module Aws::APIGateway
|
|
2461
2613
|
include Aws::Structure
|
2462
2614
|
end
|
2463
2615
|
|
2616
|
+
# @!attribute [rw] position
|
2617
|
+
# The current pagination position in the paged result set.
|
2618
|
+
# @return [String]
|
2619
|
+
#
|
2620
|
+
# @!attribute [rw] limit
|
2621
|
+
# The maximum number of returned results per page. The default value
|
2622
|
+
# is 25 and the maximum value is 500.
|
2623
|
+
# @return [Integer]
|
2624
|
+
#
|
2625
|
+
# @!attribute [rw] resource_owner
|
2626
|
+
# The owner of the domain name access association. Use `SELF` to only
|
2627
|
+
# list the domain name access associations owned by your own account.
|
2628
|
+
# Use `OTHER_ACCOUNTS` to list the domain name access associations
|
2629
|
+
# with your private custom domain names that are owned by other AWS
|
2630
|
+
# accounts.
|
2631
|
+
# @return [String]
|
2632
|
+
#
|
2633
|
+
class GetDomainNameAccessAssociationsRequest < Struct.new(
|
2634
|
+
:position,
|
2635
|
+
:limit,
|
2636
|
+
:resource_owner)
|
2637
|
+
SENSITIVE = []
|
2638
|
+
include Aws::Structure
|
2639
|
+
end
|
2640
|
+
|
2464
2641
|
# Request to get the name of a DomainName resource.
|
2465
2642
|
#
|
2466
2643
|
# @!attribute [rw] domain_name
|
2467
2644
|
# The name of the DomainName resource.
|
2468
2645
|
# @return [String]
|
2469
2646
|
#
|
2647
|
+
# @!attribute [rw] domain_name_id
|
2648
|
+
# The identifier for the domain name resource. Supported only for
|
2649
|
+
# private custom domain names.
|
2650
|
+
# @return [String]
|
2651
|
+
#
|
2470
2652
|
class GetDomainNameRequest < Struct.new(
|
2471
|
-
:domain_name
|
2653
|
+
:domain_name,
|
2654
|
+
:domain_name_id)
|
2472
2655
|
SENSITIVE = []
|
2473
2656
|
include Aws::Structure
|
2474
2657
|
end
|
@@ -2484,9 +2667,14 @@ module Aws::APIGateway
|
|
2484
2667
|
# is 25 and the maximum value is 500.
|
2485
2668
|
# @return [Integer]
|
2486
2669
|
#
|
2670
|
+
# @!attribute [rw] resource_owner
|
2671
|
+
# The owner of the domain name access association.
|
2672
|
+
# @return [String]
|
2673
|
+
#
|
2487
2674
|
class GetDomainNamesRequest < Struct.new(
|
2488
2675
|
:position,
|
2489
|
-
:limit
|
2676
|
+
:limit,
|
2677
|
+
:resource_owner)
|
2490
2678
|
SENSITIVE = []
|
2491
2679
|
include Aws::Structure
|
2492
2680
|
end
|
@@ -2803,7 +2991,7 @@ module Aws::APIGateway
|
|
2803
2991
|
# request supports only retrieval of the embedded Method resources
|
2804
2992
|
# this way. The query parameter value must be a single-valued list and
|
2805
2993
|
# contain the `"methods"` string. For example, `GET
|
2806
|
-
# /restapis
|
2994
|
+
# /restapis/{restapi_id}/resources/{resource_id}?embed=methods`.
|
2807
2995
|
# @return [Array<String>]
|
2808
2996
|
#
|
2809
2997
|
class GetResourceRequest < Struct.new(
|
@@ -2836,7 +3024,7 @@ module Aws::APIGateway
|
|
2836
3024
|
# request supports only retrieval of the embedded Method resources
|
2837
3025
|
# this way. The query parameter value must be a single-valued list and
|
2838
3026
|
# contain the `"methods"` string. For example, `GET
|
2839
|
-
# /restapis
|
3027
|
+
# /restapis/{restapi_id}/resources?embed=methods`.
|
2840
3028
|
# @return [Array<String>]
|
2841
3029
|
#
|
2842
3030
|
class GetResourcesRequest < Struct.new(
|
@@ -3293,23 +3481,22 @@ module Aws::APIGateway
|
|
3293
3481
|
# for standard integrations. If `connectionType` is `VPC_LINK` specify
|
3294
3482
|
# the Network Load Balancer DNS name. For `AWS` or `AWS_PROXY`
|
3295
3483
|
# integrations, the URI is of the form
|
3296
|
-
# `arn:aws:apigateway
|
3297
|
-
# Here,
|
3298
|
-
#
|
3299
|
-
#
|
3300
|
-
#
|
3301
|
-
#
|
3302
|
-
#
|
3303
|
-
#
|
3304
|
-
#
|
3305
|
-
#
|
3306
|
-
# can be used for an Amazon Web Services service path-based API. The
|
3484
|
+
# `arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}`.
|
3485
|
+
# Here, \{Region} is the API Gateway region (e.g., us-east-1);
|
3486
|
+
# \{service} is the name of the integrated Amazon Web Services service
|
3487
|
+
# (e.g., s3); and \{subdomain} is a designated subdomain supported by
|
3488
|
+
# certain Amazon Web Services service for fast host-name lookup.
|
3489
|
+
# action can be used for an Amazon Web Services service action-based
|
3490
|
+
# API, using an Action=\{name}&\{p1}=\{v1}&p2=\{v2}... query
|
3491
|
+
# string. The ensuing \{service\_api} refers to a supported action
|
3492
|
+
# \{name} plus any required input parameters. Alternatively, path can
|
3493
|
+
# be used for an Amazon Web Services service path-based API. The
|
3307
3494
|
# ensuing service\_api refers to the path to an Amazon Web Services
|
3308
3495
|
# service resource, including the region of the integrated Amazon Web
|
3309
3496
|
# Services service, if applicable. For example, for integration with
|
3310
3497
|
# the S3 API of GetObject, the uri can be either
|
3311
|
-
# `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket
|
3312
|
-
# or `arn:aws:apigateway:us-west-2:s3:path
|
3498
|
+
# `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}`
|
3499
|
+
# or `arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}`
|
3313
3500
|
# @return [String]
|
3314
3501
|
#
|
3315
3502
|
# @!attribute [rw] connection_type
|
@@ -3342,7 +3529,7 @@ module Aws::APIGateway
|
|
3342
3529
|
# parameter value or static value that must be enclosed within single
|
3343
3530
|
# quotes and pre-encoded as required by the back end. The method
|
3344
3531
|
# request parameter value must match the pattern of
|
3345
|
-
# `method.request
|
3532
|
+
# `method.request.{location}.{name}`, where `location` is
|
3346
3533
|
# `querystring`, `path`, or `header` and `name` must be a valid and
|
3347
3534
|
# unique method request parameter name.
|
3348
3535
|
# @return [Hash<String,String>]
|
@@ -3463,10 +3650,10 @@ module Aws::APIGateway
|
|
3463
3650
|
# response header value, a static value enclosed within a pair of
|
3464
3651
|
# single quotes, or a JSON expression from the integration response
|
3465
3652
|
# body. The mapping key must match the pattern of
|
3466
|
-
# `method.response.header
|
3467
|
-
#
|
3468
|
-
#
|
3469
|
-
# `integration.response.body
|
3653
|
+
# `method.response.header.{name}`, where `name` is a valid and unique
|
3654
|
+
# header name. The mapped non-static value must match the pattern of
|
3655
|
+
# `integration.response.header.{name}` or
|
3656
|
+
# `integration.response.body.{JSON-expression}`, where `name` is a
|
3470
3657
|
# valid and unique response header name and `JSON-expression` is a
|
3471
3658
|
# valid JSON expression without the `$` prefix.
|
3472
3659
|
# @return [Hash<String,String>]
|
@@ -3560,7 +3747,7 @@ module Aws::APIGateway
|
|
3560
3747
|
# A key-value map defining required or optional method request
|
3561
3748
|
# parameters that can be accepted by API Gateway. A key is a method
|
3562
3749
|
# request parameter name matching the pattern of
|
3563
|
-
# `method.request
|
3750
|
+
# `method.request.{location}.{name}`, where `location` is
|
3564
3751
|
# `querystring`, `path`, or `header` and `name` is a valid and unique
|
3565
3752
|
# parameter name. The value associated with the key is a Boolean flag
|
3566
3753
|
# indicating whether the parameter is required (`true`) or optional
|
@@ -3627,16 +3814,16 @@ module Aws::APIGateway
|
|
3627
3814
|
# that API Gateway can send back to the caller. A key defines a method
|
3628
3815
|
# response header and the value specifies whether the associated
|
3629
3816
|
# method response header is required or not. The expression of the key
|
3630
|
-
# must match the pattern `method.response.header
|
3631
|
-
#
|
3817
|
+
# must match the pattern `method.response.header.{name}`, where `name`
|
3818
|
+
# is a valid and unique header name. API Gateway passes certain
|
3632
3819
|
# integration response data to the method response headers specified
|
3633
3820
|
# here according to the mapping you prescribe in the API's
|
3634
3821
|
# IntegrationResponse. The integration response data that can be
|
3635
3822
|
# mapped include an integration response header expressed in
|
3636
|
-
# `integration.response.header
|
3637
|
-
#
|
3638
|
-
#
|
3639
|
-
# `integration.response.body
|
3823
|
+
# `integration.response.header.{name}`, a static value enclosed within
|
3824
|
+
# a pair of single quotes (e.g., `'application/json'`), or a JSON
|
3825
|
+
# expression from the back-end response payload in the form of
|
3826
|
+
# `integration.response.body.{JSON-expression}`, where
|
3640
3827
|
# `JSON-expression` is a valid JSON expression without the `$`
|
3641
3828
|
# prefix.)
|
3642
3829
|
# @return [Hash<String,Boolean>]
|
@@ -3898,20 +4085,20 @@ module Aws::APIGateway
|
|
3898
4085
|
# The op operation's target, as identified by a JSON Pointer value
|
3899
4086
|
# that references a location within the targeted resource. For
|
3900
4087
|
# example, if the target resource has an updateable property of
|
3901
|
-
#
|
3902
|
-
#
|
3903
|
-
#
|
3904
|
-
#
|
3905
|
-
#
|
3906
|
-
#
|
3907
|
-
#
|
4088
|
+
# \{"name":"value"}, the path for this property is /name. If the
|
4089
|
+
# name property value is a JSON object (e.g., \{"name":
|
4090
|
+
# \{"child/name": "child-value"}}), the path for the child/name
|
4091
|
+
# property will be /name/child~1name. Any slash ("/") character
|
4092
|
+
# appearing in path names must be escaped with "~1", as shown in the
|
4093
|
+
# example above. Each op operation can have only one path associated
|
4094
|
+
# with it.
|
3908
4095
|
# @return [String]
|
3909
4096
|
#
|
3910
4097
|
# @!attribute [rw] value
|
3911
4098
|
# The new target value of the update operation. It is applicable for
|
3912
4099
|
# the add or replace operation. When using AWS CLI to update a
|
3913
4100
|
# property of a JSON value, enclose the JSON object with a pair of
|
3914
|
-
# single quotes in a Linux shell, e.g., '
|
4101
|
+
# single quotes in a Linux shell, e.g., '\{"a": ...}'.
|
3915
4102
|
# @return [String]
|
3916
4103
|
#
|
3917
4104
|
# @!attribute [rw] from
|
@@ -3999,23 +4186,22 @@ module Aws::APIGateway
|
|
3999
4186
|
# `connectionType` is `VPC_LINK`. For a private HTTP integration, the
|
4000
4187
|
# URI is not used for routing. For `AWS` or `AWS_PROXY` integrations,
|
4001
4188
|
# the URI is of the form
|
4002
|
-
# `arn:aws:apigateway
|
4003
|
-
# Here,
|
4004
|
-
#
|
4005
|
-
#
|
4006
|
-
#
|
4007
|
-
#
|
4008
|
-
#
|
4009
|
-
#
|
4010
|
-
#
|
4011
|
-
#
|
4012
|
-
# can be used for an Amazon Web Services service path-based API. The
|
4189
|
+
# `arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api`}.
|
4190
|
+
# Here, \{Region} is the API Gateway region (e.g., us-east-1);
|
4191
|
+
# \{service} is the name of the integrated Amazon Web Services service
|
4192
|
+
# (e.g., s3); and \{subdomain} is a designated subdomain supported by
|
4193
|
+
# certain Amazon Web Services service for fast host-name lookup.
|
4194
|
+
# action can be used for an Amazon Web Services service action-based
|
4195
|
+
# API, using an Action=\{name}&\{p1}=\{v1}&p2=\{v2}... query
|
4196
|
+
# string. The ensuing \{service\_api} refers to a supported action
|
4197
|
+
# \{name} plus any required input parameters. Alternatively, path can
|
4198
|
+
# be used for an Amazon Web Services service path-based API. The
|
4013
4199
|
# ensuing service\_api refers to the path to an Amazon Web Services
|
4014
4200
|
# service resource, including the region of the integrated Amazon Web
|
4015
4201
|
# Services service, if applicable. For example, for integration with
|
4016
4202
|
# the S3 API of `GetObject`, the `uri` can be either
|
4017
|
-
# `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket
|
4018
|
-
# or `arn:aws:apigateway:us-west-2:s3:path
|
4203
|
+
# `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}`
|
4204
|
+
# or `arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}`.
|
4019
4205
|
# @return [String]
|
4020
4206
|
#
|
4021
4207
|
# @!attribute [rw] connection_type
|
@@ -4042,7 +4228,7 @@ module Aws::APIGateway
|
|
4042
4228
|
# parameter value or static value that must be enclosed within single
|
4043
4229
|
# quotes and pre-encoded as required by the back end. The method
|
4044
4230
|
# request parameter value must match the pattern of
|
4045
|
-
# `method.request
|
4231
|
+
# `method.request.{location}.{name}`, where `location` is
|
4046
4232
|
# `querystring`, `path`, or `header` and `name` must be a valid and
|
4047
4233
|
# unique method request parameter name.
|
4048
4234
|
# @return [Hash<String,String>]
|
@@ -4147,11 +4333,11 @@ module Aws::APIGateway
|
|
4147
4333
|
# response header value, a static value enclosed within a pair of
|
4148
4334
|
# single quotes, or a JSON expression from the integration response
|
4149
4335
|
# body. The mapping key must match the pattern of
|
4150
|
-
# `method.response.header
|
4151
|
-
#
|
4152
|
-
#
|
4153
|
-
# `integration.response.body
|
4154
|
-
#
|
4336
|
+
# `method.response.header.{name}`, where `name` is a valid and unique
|
4337
|
+
# header name. The mapped non-static value must match the pattern of
|
4338
|
+
# `integration.response.header.{name}` or
|
4339
|
+
# `integration.response.body.{JSON-expression}`, where `name` must be
|
4340
|
+
# a valid and unique response header name and `JSON-expression` a
|
4155
4341
|
# valid JSON expression without the `$` prefix.
|
4156
4342
|
# @return [Hash<String,String>]
|
4157
4343
|
#
|
@@ -4224,7 +4410,7 @@ module Aws::APIGateway
|
|
4224
4410
|
# A key-value map defining required or optional method request
|
4225
4411
|
# parameters that can be accepted by API Gateway. A key defines a
|
4226
4412
|
# method request parameter name matching the pattern of
|
4227
|
-
# `method.request
|
4413
|
+
# `method.request.{location}.{name}`, where `location` is
|
4228
4414
|
# `querystring`, `path`, or `header` and `name` is a valid and unique
|
4229
4415
|
# parameter name. The value associated with the key is a Boolean flag
|
4230
4416
|
# indicating whether the parameter is required (`true`) or optional
|
@@ -4296,14 +4482,14 @@ module Aws::APIGateway
|
|
4296
4482
|
# response header name and the associated value is a Boolean flag
|
4297
4483
|
# indicating whether the method response parameter is required or not.
|
4298
4484
|
# The method response header names must match the pattern of
|
4299
|
-
# `method.response.header
|
4300
|
-
#
|
4301
|
-
#
|
4302
|
-
#
|
4303
|
-
#
|
4304
|
-
#
|
4305
|
-
#
|
4306
|
-
# `integration.response.body
|
4485
|
+
# `method.response.header.{name}`, where `name` is a valid and unique
|
4486
|
+
# header name. The response parameter names defined here are available
|
4487
|
+
# in the integration response to be mapped from an integration
|
4488
|
+
# response header expressed in `integration.response.header.{name}`, a
|
4489
|
+
# static value enclosed within a pair of single quotes (e.g.,
|
4490
|
+
# `'application/json'`), or a JSON expression from the back-end
|
4491
|
+
# response payload in the form of
|
4492
|
+
# `integration.response.body.{JSON-expression}`, where
|
4307
4493
|
# `JSON-expression` is a valid JSON expression without the `$`
|
4308
4494
|
# prefix.)
|
4309
4495
|
# @return [Hash<String,Boolean>]
|
@@ -4394,6 +4580,21 @@ module Aws::APIGateway
|
|
4394
4580
|
include Aws::Structure
|
4395
4581
|
end
|
4396
4582
|
|
4583
|
+
# @!attribute [rw] domain_name_access_association_arn
|
4584
|
+
# The ARN of the domain name access association resource.
|
4585
|
+
# @return [String]
|
4586
|
+
#
|
4587
|
+
# @!attribute [rw] domain_name_arn
|
4588
|
+
# The ARN of the domain name.
|
4589
|
+
# @return [String]
|
4590
|
+
#
|
4591
|
+
class RejectDomainNameAccessAssociationRequest < Struct.new(
|
4592
|
+
:domain_name_access_association_arn,
|
4593
|
+
:domain_name_arn)
|
4594
|
+
SENSITIVE = []
|
4595
|
+
include Aws::Structure
|
4596
|
+
end
|
4597
|
+
|
4397
4598
|
# A set of validation rules for incoming Method requests.
|
4398
4599
|
#
|
4399
4600
|
# @!attribute [rw] id
|
@@ -4554,10 +4755,9 @@ module Aws::APIGateway
|
|
4554
4755
|
# @!attribute [rw] disable_execute_api_endpoint
|
4555
4756
|
# Specifies whether clients can invoke your API by using the default
|
4556
4757
|
# `execute-api` endpoint. By default, clients can invoke your API with
|
4557
|
-
# the default
|
4558
|
-
#
|
4559
|
-
#
|
4560
|
-
# disable the default endpoint.
|
4758
|
+
# the default `https://{api_id}.execute-api.{region}.amazonaws.com`
|
4759
|
+
# endpoint. To require that clients use a custom domain name to invoke
|
4760
|
+
# your API, disable the default endpoint.
|
4561
4761
|
# @return [Boolean]
|
4562
4762
|
#
|
4563
4763
|
# @!attribute [rw] root_resource_id
|
@@ -4761,10 +4961,9 @@ module Aws::APIGateway
|
|
4761
4961
|
#
|
4762
4962
|
# @!attribute [rw] method_settings
|
4763
4963
|
# A map that defines the method settings for a Stage resource. Keys
|
4764
|
-
# (designated as
|
4765
|
-
# defined as
|
4766
|
-
#
|
4767
|
-
# stage.
|
4964
|
+
# (designated as `/{method_setting_key` below) are method paths
|
4965
|
+
# defined as `{resource_path}/{http_method}` for an individual method
|
4966
|
+
# override, or `/*/*` for overriding all methods in the stage.
|
4768
4967
|
# @return [Hash<String,Types::MethodSetting>]
|
4769
4968
|
#
|
4770
4969
|
# @!attribute [rw] variables
|
@@ -4830,7 +5029,7 @@ module Aws::APIGateway
|
|
4830
5029
|
end
|
4831
5030
|
|
4832
5031
|
# A reference to a unique stage identified in the format
|
4833
|
-
#
|
5032
|
+
# `{restApiId}/{stage}`.
|
4834
5033
|
#
|
4835
5034
|
# @!attribute [rw] rest_api_id
|
4836
5035
|
# The string identifier of the associated RestApi.
|
@@ -5262,6 +5461,11 @@ module Aws::APIGateway
|
|
5262
5461
|
# The domain name of the BasePathMapping resource to change.
|
5263
5462
|
# @return [String]
|
5264
5463
|
#
|
5464
|
+
# @!attribute [rw] domain_name_id
|
5465
|
+
# The identifier for the domain name resource. Supported only for
|
5466
|
+
# private custom domain names.
|
5467
|
+
# @return [String]
|
5468
|
+
#
|
5265
5469
|
# @!attribute [rw] base_path
|
5266
5470
|
# The base path of the BasePathMapping resource to change.
|
5267
5471
|
#
|
@@ -5279,6 +5483,7 @@ module Aws::APIGateway
|
|
5279
5483
|
#
|
5280
5484
|
class UpdateBasePathMappingRequest < Struct.new(
|
5281
5485
|
:domain_name,
|
5486
|
+
:domain_name_id,
|
5282
5487
|
:base_path,
|
5283
5488
|
:patch_operations)
|
5284
5489
|
SENSITIVE = []
|
@@ -5396,6 +5601,11 @@ module Aws::APIGateway
|
|
5396
5601
|
# The name of the DomainName resource to be changed.
|
5397
5602
|
# @return [String]
|
5398
5603
|
#
|
5604
|
+
# @!attribute [rw] domain_name_id
|
5605
|
+
# The identifier for the domain name resource. Supported only for
|
5606
|
+
# private custom domain names.
|
5607
|
+
# @return [String]
|
5608
|
+
#
|
5399
5609
|
# @!attribute [rw] patch_operations
|
5400
5610
|
# For more information about supported patch operations, see [Patch
|
5401
5611
|
# Operations][1].
|
@@ -5407,6 +5617,7 @@ module Aws::APIGateway
|
|
5407
5617
|
#
|
5408
5618
|
class UpdateDomainNameRequest < Struct.new(
|
5409
5619
|
:domain_name,
|
5620
|
+
:domain_name_id,
|
5410
5621
|
:patch_operations)
|
5411
5622
|
SENSITIVE = []
|
5412
5623
|
include Aws::Structure
|
@@ -5803,10 +6014,9 @@ module Aws::APIGateway
|
|
5803
6014
|
# @!attribute [rw] items
|
5804
6015
|
# The usage data, as daily logs of used and remaining quotas, over the
|
5805
6016
|
# specified time interval indexed over the API keys in a usage plan.
|
5806
|
-
# For example,
|
5807
|
-
#
|
5808
|
-
#
|
5809
|
-
# quota]`.
|
6017
|
+
# For example, `{..., "values" : { "{api_key}" : [ [0, 100], [10, 90],
|
6018
|
+
# [100, 10]]}`, where `{api_key}` stands for an API key value and the
|
6019
|
+
# daily log entry is of the format `[used quota, remaining quota]`.
|
5810
6020
|
# @return [Hash<String,Array<Array<Integer>>>]
|
5811
6021
|
#
|
5812
6022
|
class Usage < Struct.new(
|