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
@@ -553,7 +553,7 @@ module Aws::APIGateway
|
|
553
553
|
# @option params [Array<String>] :provider_arns
|
554
554
|
# A list of the Amazon Cognito user pool ARNs for the
|
555
555
|
# `COGNITO_USER_POOLS` authorizer. Each element is of this format:
|
556
|
-
# `arn:aws:cognito-idp
|
556
|
+
# `arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}`.
|
557
557
|
# For a `TOKEN` or `REQUEST` authorizer, this is not defined.
|
558
558
|
#
|
559
559
|
# @option params [String] :auth_type
|
@@ -564,10 +564,10 @@ module Aws::APIGateway
|
|
564
564
|
# Specifies the authorizer's Uniform Resource Identifier (URI). For
|
565
565
|
# `TOKEN` or `REQUEST` authorizers, this must be a well-formed Lambda
|
566
566
|
# function URI, for example,
|
567
|
-
# `arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2
|
567
|
+
# `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`.
|
568
568
|
# In general, the URI has this form
|
569
|
-
# `arn:aws:apigateway
|
570
|
-
#
|
569
|
+
# `arn:aws:apigateway:{region}:lambda:path/{service_api}`, where
|
570
|
+
# `{region}` is the same as the region hosting the Lambda function,
|
571
571
|
# `path` indicates that the remaining substring in the URI should be
|
572
572
|
# treated as the path to the resource, including the initial `/`. For
|
573
573
|
# Lambda functions, this is usually of the form
|
@@ -671,6 +671,10 @@ module Aws::APIGateway
|
|
671
671
|
# @option params [required, String] :domain_name
|
672
672
|
# The domain name of the BasePathMapping resource to create.
|
673
673
|
#
|
674
|
+
# @option params [String] :domain_name_id
|
675
|
+
# The identifier for the domain name resource. Supported only for
|
676
|
+
# private custom domain names.
|
677
|
+
#
|
674
678
|
# @option params [String] :base_path
|
675
679
|
# The base path name that callers of the API must provide as part of the
|
676
680
|
# URL after the domain name. This value must be unique for all of the
|
@@ -695,6 +699,7 @@ module Aws::APIGateway
|
|
695
699
|
#
|
696
700
|
# resp = client.create_base_path_mapping({
|
697
701
|
# domain_name: "String", # required
|
702
|
+
# domain_name_id: "String",
|
698
703
|
# base_path: "String",
|
699
704
|
# rest_api_id: "String", # required
|
700
705
|
# stage: "String",
|
@@ -899,12 +904,12 @@ module Aws::APIGateway
|
|
899
904
|
#
|
900
905
|
# @option params [String] :certificate_name
|
901
906
|
# The user-friendly name of the certificate that will be used by
|
902
|
-
# edge-optimized endpoint for this domain name.
|
907
|
+
# edge-optimized endpoint or private endpoint for this domain name.
|
903
908
|
#
|
904
909
|
# @option params [String] :certificate_body
|
905
910
|
# \[Deprecated\] The body of the server certificate that will be used by
|
906
|
-
# edge-optimized endpoint for this domain name
|
907
|
-
# certificate authority.
|
911
|
+
# edge-optimized endpoint or private endpoint for this domain name
|
912
|
+
# provided by your certificate authority.
|
908
913
|
#
|
909
914
|
# @option params [String] :certificate_private_key
|
910
915
|
# \[Deprecated\] Your edge-optimized endpoint's domain name
|
@@ -921,8 +926,8 @@ module Aws::APIGateway
|
|
921
926
|
#
|
922
927
|
# @option params [String] :certificate_arn
|
923
928
|
# The reference to an Amazon Web Services-managed certificate that will
|
924
|
-
# be used by edge-optimized endpoint for this domain
|
925
|
-
# Manager is the only supported source.
|
929
|
+
# be used by edge-optimized endpoint or private endpoint for this domain
|
930
|
+
# name. Certificate Manager is the only supported source.
|
926
931
|
#
|
927
932
|
# @option params [String] :regional_certificate_name
|
928
933
|
# The user-friendly name of the certificate that will be used by
|
@@ -958,9 +963,16 @@ module Aws::APIGateway
|
|
958
963
|
# using an ACM imported or private CA certificate ARN as the
|
959
964
|
# regionalCertificateArn.
|
960
965
|
#
|
966
|
+
# @option params [String] :policy
|
967
|
+
# A stringified JSON policy document that applies to the `execute-api`
|
968
|
+
# service for this DomainName regardless of the caller and Method
|
969
|
+
# configuration. Supported only for private custom domain names.
|
970
|
+
#
|
961
971
|
# @return [Types::DomainName] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
962
972
|
#
|
963
973
|
# * {Types::DomainName#domain_name #domain_name} => String
|
974
|
+
# * {Types::DomainName#domain_name_id #domain_name_id} => String
|
975
|
+
# * {Types::DomainName#domain_name_arn #domain_name_arn} => String
|
964
976
|
# * {Types::DomainName#certificate_name #certificate_name} => String
|
965
977
|
# * {Types::DomainName#certificate_arn #certificate_arn} => String
|
966
978
|
# * {Types::DomainName#certificate_upload_date #certificate_upload_date} => Time
|
@@ -977,6 +989,8 @@ module Aws::APIGateway
|
|
977
989
|
# * {Types::DomainName#tags #tags} => Hash<String,String>
|
978
990
|
# * {Types::DomainName#mutual_tls_authentication #mutual_tls_authentication} => Types::MutualTlsAuthentication
|
979
991
|
# * {Types::DomainName#ownership_verification_certificate_arn #ownership_verification_certificate_arn} => String
|
992
|
+
# * {Types::DomainName#management_policy #management_policy} => String
|
993
|
+
# * {Types::DomainName#policy #policy} => String
|
980
994
|
#
|
981
995
|
# @example Request syntax with placeholder values
|
982
996
|
#
|
@@ -1002,11 +1016,14 @@ module Aws::APIGateway
|
|
1002
1016
|
# truststore_version: "String",
|
1003
1017
|
# },
|
1004
1018
|
# ownership_verification_certificate_arn: "String",
|
1019
|
+
# policy: "String",
|
1005
1020
|
# })
|
1006
1021
|
#
|
1007
1022
|
# @example Response structure
|
1008
1023
|
#
|
1009
1024
|
# resp.domain_name #=> String
|
1025
|
+
# resp.domain_name_id #=> String
|
1026
|
+
# resp.domain_name_arn #=> String
|
1010
1027
|
# resp.certificate_name #=> String
|
1011
1028
|
# resp.certificate_arn #=> String
|
1012
1029
|
# resp.certificate_upload_date #=> Time
|
@@ -1030,6 +1047,8 @@ module Aws::APIGateway
|
|
1030
1047
|
# resp.mutual_tls_authentication.truststore_warnings #=> Array
|
1031
1048
|
# resp.mutual_tls_authentication.truststore_warnings[0] #=> String
|
1032
1049
|
# resp.ownership_verification_certificate_arn #=> String
|
1050
|
+
# resp.management_policy #=> String
|
1051
|
+
# resp.policy #=> String
|
1033
1052
|
#
|
1034
1053
|
# @overload create_domain_name(params = {})
|
1035
1054
|
# @param [Hash] params ({})
|
@@ -1038,6 +1057,59 @@ module Aws::APIGateway
|
|
1038
1057
|
req.send_request(options)
|
1039
1058
|
end
|
1040
1059
|
|
1060
|
+
# Creates a domain name access association resource between an access
|
1061
|
+
# association source and a private custom domain name.
|
1062
|
+
#
|
1063
|
+
# @option params [required, String] :domain_name_arn
|
1064
|
+
# The ARN of the domain name.
|
1065
|
+
#
|
1066
|
+
# @option params [required, String] :access_association_source_type
|
1067
|
+
# The type of the domain name access association source.
|
1068
|
+
#
|
1069
|
+
# @option params [required, String] :access_association_source
|
1070
|
+
# The identifier of the domain name access association source. For a
|
1071
|
+
# VPCE, the value is the VPC endpoint ID.
|
1072
|
+
#
|
1073
|
+
# @option params [Hash<String,String>] :tags
|
1074
|
+
# The key-value map of strings. The valid character set is
|
1075
|
+
# \[a-zA-Z+-=.\_:/\]. The tag key can be up to 128 characters and must
|
1076
|
+
# not start with `aws:`. The tag value can be up to 256 characters.
|
1077
|
+
#
|
1078
|
+
# @return [Types::DomainNameAccessAssociation] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1079
|
+
#
|
1080
|
+
# * {Types::DomainNameAccessAssociation#domain_name_access_association_arn #domain_name_access_association_arn} => String
|
1081
|
+
# * {Types::DomainNameAccessAssociation#domain_name_arn #domain_name_arn} => String
|
1082
|
+
# * {Types::DomainNameAccessAssociation#access_association_source_type #access_association_source_type} => String
|
1083
|
+
# * {Types::DomainNameAccessAssociation#access_association_source #access_association_source} => String
|
1084
|
+
# * {Types::DomainNameAccessAssociation#tags #tags} => Hash<String,String>
|
1085
|
+
#
|
1086
|
+
# @example Request syntax with placeholder values
|
1087
|
+
#
|
1088
|
+
# resp = client.create_domain_name_access_association({
|
1089
|
+
# domain_name_arn: "String", # required
|
1090
|
+
# access_association_source_type: "VPCE", # required, accepts VPCE
|
1091
|
+
# access_association_source: "String", # required
|
1092
|
+
# tags: {
|
1093
|
+
# "String" => "String",
|
1094
|
+
# },
|
1095
|
+
# })
|
1096
|
+
#
|
1097
|
+
# @example Response structure
|
1098
|
+
#
|
1099
|
+
# resp.domain_name_access_association_arn #=> String
|
1100
|
+
# resp.domain_name_arn #=> String
|
1101
|
+
# resp.access_association_source_type #=> String, one of "VPCE"
|
1102
|
+
# resp.access_association_source #=> String
|
1103
|
+
# resp.tags #=> Hash
|
1104
|
+
# resp.tags["String"] #=> String
|
1105
|
+
#
|
1106
|
+
# @overload create_domain_name_access_association(params = {})
|
1107
|
+
# @param [Hash] params ({})
|
1108
|
+
def create_domain_name_access_association(params = {}, options = {})
|
1109
|
+
req = build_request(:create_domain_name_access_association, params)
|
1110
|
+
req.send_request(options)
|
1111
|
+
end
|
1112
|
+
|
1041
1113
|
# Adds a new Model resource to an existing RestApi resource.
|
1042
1114
|
#
|
1043
1115
|
# @option params [required, String] :rest_api_id
|
@@ -1269,7 +1341,7 @@ module Aws::APIGateway
|
|
1269
1341
|
# @option params [Boolean] :disable_execute_api_endpoint
|
1270
1342
|
# Specifies whether clients can invoke your API by using the default
|
1271
1343
|
# `execute-api` endpoint. By default, clients can invoke your API with
|
1272
|
-
# the default `https
|
1344
|
+
# the default `https://{api_id}.execute-api.{region}.amazonaws.com`
|
1273
1345
|
# endpoint. To require that clients use a custom domain name to invoke
|
1274
1346
|
# your API, disable the default endpoint
|
1275
1347
|
#
|
@@ -1724,6 +1796,10 @@ module Aws::APIGateway
|
|
1724
1796
|
# @option params [required, String] :domain_name
|
1725
1797
|
# The domain name of the BasePathMapping resource to delete.
|
1726
1798
|
#
|
1799
|
+
# @option params [String] :domain_name_id
|
1800
|
+
# The identifier for the domain name resource. Supported only for
|
1801
|
+
# private custom domain names.
|
1802
|
+
#
|
1727
1803
|
# @option params [required, String] :base_path
|
1728
1804
|
# The base path name of the BasePathMapping resource to delete.
|
1729
1805
|
#
|
@@ -1735,6 +1811,7 @@ module Aws::APIGateway
|
|
1735
1811
|
#
|
1736
1812
|
# resp = client.delete_base_path_mapping({
|
1737
1813
|
# domain_name: "String", # required
|
1814
|
+
# domain_name_id: "String",
|
1738
1815
|
# base_path: "String", # required
|
1739
1816
|
# })
|
1740
1817
|
#
|
@@ -1843,12 +1920,17 @@ module Aws::APIGateway
|
|
1843
1920
|
# @option params [required, String] :domain_name
|
1844
1921
|
# The name of the DomainName resource to be deleted.
|
1845
1922
|
#
|
1923
|
+
# @option params [String] :domain_name_id
|
1924
|
+
# The identifier for the domain name resource. Supported only for
|
1925
|
+
# private custom domain names.
|
1926
|
+
#
|
1846
1927
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1847
1928
|
#
|
1848
1929
|
# @example Request syntax with placeholder values
|
1849
1930
|
#
|
1850
1931
|
# resp = client.delete_domain_name({
|
1851
1932
|
# domain_name: "String", # required
|
1933
|
+
# domain_name_id: "String",
|
1852
1934
|
# })
|
1853
1935
|
#
|
1854
1936
|
# @overload delete_domain_name(params = {})
|
@@ -1858,6 +1940,31 @@ module Aws::APIGateway
|
|
1858
1940
|
req.send_request(options)
|
1859
1941
|
end
|
1860
1942
|
|
1943
|
+
# Deletes the DomainNameAccessAssociation resource.
|
1944
|
+
#
|
1945
|
+
# Only the AWS account that created the DomainNameAccessAssociation
|
1946
|
+
# resource can delete it. To stop an access association source in
|
1947
|
+
# another AWS account from accessing your private custom domain name,
|
1948
|
+
# use the RejectDomainNameAccessAssociation operation.
|
1949
|
+
#
|
1950
|
+
# @option params [required, String] :domain_name_access_association_arn
|
1951
|
+
# The ARN of the domain name access association resource.
|
1952
|
+
#
|
1953
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1954
|
+
#
|
1955
|
+
# @example Request syntax with placeholder values
|
1956
|
+
#
|
1957
|
+
# resp = client.delete_domain_name_access_association({
|
1958
|
+
# domain_name_access_association_arn: "String", # required
|
1959
|
+
# })
|
1960
|
+
#
|
1961
|
+
# @overload delete_domain_name_access_association(params = {})
|
1962
|
+
# @param [Hash] params ({})
|
1963
|
+
def delete_domain_name_access_association(params = {}, options = {})
|
1964
|
+
req = build_request(:delete_domain_name_access_association, params)
|
1965
|
+
req.send_request(options)
|
1966
|
+
end
|
1967
|
+
|
1861
1968
|
# Clears any customization of a GatewayResponse of a specified response
|
1862
1969
|
# type on the given RestApi and resets it with the default settings.
|
1863
1970
|
#
|
@@ -2523,6 +2630,10 @@ module Aws::APIGateway
|
|
2523
2630
|
# @option params [required, String] :domain_name
|
2524
2631
|
# The domain name of the BasePathMapping resource to be described.
|
2525
2632
|
#
|
2633
|
+
# @option params [String] :domain_name_id
|
2634
|
+
# The identifier for the domain name resource. Supported only for
|
2635
|
+
# private custom domain names.
|
2636
|
+
#
|
2526
2637
|
# @option params [required, String] :base_path
|
2527
2638
|
# The base path name that callers of the API must provide as part of the
|
2528
2639
|
# URL after the domain name. This value must be unique for all of the
|
@@ -2539,6 +2650,7 @@ module Aws::APIGateway
|
|
2539
2650
|
#
|
2540
2651
|
# resp = client.get_base_path_mapping({
|
2541
2652
|
# domain_name: "String", # required
|
2653
|
+
# domain_name_id: "String",
|
2542
2654
|
# base_path: "String", # required
|
2543
2655
|
# })
|
2544
2656
|
#
|
@@ -2560,6 +2672,10 @@ module Aws::APIGateway
|
|
2560
2672
|
# @option params [required, String] :domain_name
|
2561
2673
|
# The domain name of a BasePathMapping resource.
|
2562
2674
|
#
|
2675
|
+
# @option params [String] :domain_name_id
|
2676
|
+
# The identifier for the domain name resource. Supported only for
|
2677
|
+
# private custom domain names.
|
2678
|
+
#
|
2563
2679
|
# @option params [String] :position
|
2564
2680
|
# The current pagination position in the paged result set.
|
2565
2681
|
#
|
@@ -2578,6 +2694,7 @@ module Aws::APIGateway
|
|
2578
2694
|
#
|
2579
2695
|
# resp = client.get_base_path_mappings({
|
2580
2696
|
# domain_name: "String", # required
|
2697
|
+
# domain_name_id: "String",
|
2581
2698
|
# position: "String",
|
2582
2699
|
# limit: 1,
|
2583
2700
|
# })
|
@@ -2689,13 +2806,13 @@ module Aws::APIGateway
|
|
2689
2806
|
# returned Deployment resource in the response. In a REST API call, this
|
2690
2807
|
# `embed` parameter value is a list of comma-separated strings, as in
|
2691
2808
|
# `GET
|
2692
|
-
# /restapis
|
2809
|
+
# /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2`.
|
2693
2810
|
# The SDK and other platform-dependent libraries might use a different
|
2694
2811
|
# format for the list. Currently, this request supports only retrieval
|
2695
2812
|
# of the embedded API summary this way. Hence, the parameter value must
|
2696
2813
|
# be a single-valued list containing only the `"apisummary"` string. For
|
2697
2814
|
# example, `GET
|
2698
|
-
# /restapis
|
2815
|
+
# /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary`.
|
2699
2816
|
#
|
2700
2817
|
# @return [Types::Deployment] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2701
2818
|
#
|
@@ -2956,9 +3073,15 @@ module Aws::APIGateway
|
|
2956
3073
|
# @option params [required, String] :domain_name
|
2957
3074
|
# The name of the DomainName resource.
|
2958
3075
|
#
|
3076
|
+
# @option params [String] :domain_name_id
|
3077
|
+
# The identifier for the domain name resource. Supported only for
|
3078
|
+
# private custom domain names.
|
3079
|
+
#
|
2959
3080
|
# @return [Types::DomainName] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2960
3081
|
#
|
2961
3082
|
# * {Types::DomainName#domain_name #domain_name} => String
|
3083
|
+
# * {Types::DomainName#domain_name_id #domain_name_id} => String
|
3084
|
+
# * {Types::DomainName#domain_name_arn #domain_name_arn} => String
|
2962
3085
|
# * {Types::DomainName#certificate_name #certificate_name} => String
|
2963
3086
|
# * {Types::DomainName#certificate_arn #certificate_arn} => String
|
2964
3087
|
# * {Types::DomainName#certificate_upload_date #certificate_upload_date} => Time
|
@@ -2975,16 +3098,21 @@ module Aws::APIGateway
|
|
2975
3098
|
# * {Types::DomainName#tags #tags} => Hash<String,String>
|
2976
3099
|
# * {Types::DomainName#mutual_tls_authentication #mutual_tls_authentication} => Types::MutualTlsAuthentication
|
2977
3100
|
# * {Types::DomainName#ownership_verification_certificate_arn #ownership_verification_certificate_arn} => String
|
3101
|
+
# * {Types::DomainName#management_policy #management_policy} => String
|
3102
|
+
# * {Types::DomainName#policy #policy} => String
|
2978
3103
|
#
|
2979
3104
|
# @example Request syntax with placeholder values
|
2980
3105
|
#
|
2981
3106
|
# resp = client.get_domain_name({
|
2982
3107
|
# domain_name: "String", # required
|
3108
|
+
# domain_name_id: "String",
|
2983
3109
|
# })
|
2984
3110
|
#
|
2985
3111
|
# @example Response structure
|
2986
3112
|
#
|
2987
3113
|
# resp.domain_name #=> String
|
3114
|
+
# resp.domain_name_id #=> String
|
3115
|
+
# resp.domain_name_arn #=> String
|
2988
3116
|
# resp.certificate_name #=> String
|
2989
3117
|
# resp.certificate_arn #=> String
|
2990
3118
|
# resp.certificate_upload_date #=> Time
|
@@ -3008,6 +3136,8 @@ module Aws::APIGateway
|
|
3008
3136
|
# resp.mutual_tls_authentication.truststore_warnings #=> Array
|
3009
3137
|
# resp.mutual_tls_authentication.truststore_warnings[0] #=> String
|
3010
3138
|
# resp.ownership_verification_certificate_arn #=> String
|
3139
|
+
# resp.management_policy #=> String
|
3140
|
+
# resp.policy #=> String
|
3011
3141
|
#
|
3012
3142
|
# @overload get_domain_name(params = {})
|
3013
3143
|
# @param [Hash] params ({})
|
@@ -3016,6 +3146,52 @@ module Aws::APIGateway
|
|
3016
3146
|
req.send_request(options)
|
3017
3147
|
end
|
3018
3148
|
|
3149
|
+
# Represents a collection on DomainNameAccessAssociations resources.
|
3150
|
+
#
|
3151
|
+
# @option params [String] :position
|
3152
|
+
# The current pagination position in the paged result set.
|
3153
|
+
#
|
3154
|
+
# @option params [Integer] :limit
|
3155
|
+
# The maximum number of returned results per page. The default value is
|
3156
|
+
# 25 and the maximum value is 500.
|
3157
|
+
#
|
3158
|
+
# @option params [String] :resource_owner
|
3159
|
+
# The owner of the domain name access association. Use `SELF` to only
|
3160
|
+
# list the domain name access associations owned by your own account.
|
3161
|
+
# Use `OTHER_ACCOUNTS` to list the domain name access associations with
|
3162
|
+
# your private custom domain names that are owned by other AWS accounts.
|
3163
|
+
#
|
3164
|
+
# @return [Types::DomainNameAccessAssociations] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3165
|
+
#
|
3166
|
+
# * {Types::DomainNameAccessAssociations#position #position} => String
|
3167
|
+
# * {Types::DomainNameAccessAssociations#items #items} => Array<Types::DomainNameAccessAssociation>
|
3168
|
+
#
|
3169
|
+
# @example Request syntax with placeholder values
|
3170
|
+
#
|
3171
|
+
# resp = client.get_domain_name_access_associations({
|
3172
|
+
# position: "String",
|
3173
|
+
# limit: 1,
|
3174
|
+
# resource_owner: "SELF", # accepts SELF, OTHER_ACCOUNTS
|
3175
|
+
# })
|
3176
|
+
#
|
3177
|
+
# @example Response structure
|
3178
|
+
#
|
3179
|
+
# resp.position #=> String
|
3180
|
+
# resp.items #=> Array
|
3181
|
+
# resp.items[0].domain_name_access_association_arn #=> String
|
3182
|
+
# resp.items[0].domain_name_arn #=> String
|
3183
|
+
# resp.items[0].access_association_source_type #=> String, one of "VPCE"
|
3184
|
+
# resp.items[0].access_association_source #=> String
|
3185
|
+
# resp.items[0].tags #=> Hash
|
3186
|
+
# resp.items[0].tags["String"] #=> String
|
3187
|
+
#
|
3188
|
+
# @overload get_domain_name_access_associations(params = {})
|
3189
|
+
# @param [Hash] params ({})
|
3190
|
+
def get_domain_name_access_associations(params = {}, options = {})
|
3191
|
+
req = build_request(:get_domain_name_access_associations, params)
|
3192
|
+
req.send_request(options)
|
3193
|
+
end
|
3194
|
+
|
3019
3195
|
# Represents a collection of DomainName resources.
|
3020
3196
|
#
|
3021
3197
|
# @option params [String] :position
|
@@ -3025,6 +3201,9 @@ module Aws::APIGateway
|
|
3025
3201
|
# The maximum number of returned results per page. The default value is
|
3026
3202
|
# 25 and the maximum value is 500.
|
3027
3203
|
#
|
3204
|
+
# @option params [String] :resource_owner
|
3205
|
+
# The owner of the domain name access association.
|
3206
|
+
#
|
3028
3207
|
# @return [Types::DomainNames] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3029
3208
|
#
|
3030
3209
|
# * {Types::DomainNames#position #position} => String
|
@@ -3037,6 +3216,7 @@ module Aws::APIGateway
|
|
3037
3216
|
# resp = client.get_domain_names({
|
3038
3217
|
# position: "String",
|
3039
3218
|
# limit: 1,
|
3219
|
+
# resource_owner: "SELF", # accepts SELF, OTHER_ACCOUNTS
|
3040
3220
|
# })
|
3041
3221
|
#
|
3042
3222
|
# @example Response structure
|
@@ -3044,6 +3224,8 @@ module Aws::APIGateway
|
|
3044
3224
|
# resp.position #=> String
|
3045
3225
|
# resp.items #=> Array
|
3046
3226
|
# resp.items[0].domain_name #=> String
|
3227
|
+
# resp.items[0].domain_name_id #=> String
|
3228
|
+
# resp.items[0].domain_name_arn #=> String
|
3047
3229
|
# resp.items[0].certificate_name #=> String
|
3048
3230
|
# resp.items[0].certificate_arn #=> String
|
3049
3231
|
# resp.items[0].certificate_upload_date #=> Time
|
@@ -3067,6 +3249,8 @@ module Aws::APIGateway
|
|
3067
3249
|
# resp.items[0].mutual_tls_authentication.truststore_warnings #=> Array
|
3068
3250
|
# resp.items[0].mutual_tls_authentication.truststore_warnings[0] #=> String
|
3069
3251
|
# resp.items[0].ownership_verification_certificate_arn #=> String
|
3252
|
+
# resp.items[0].management_policy #=> String
|
3253
|
+
# resp.items[0].policy #=> String
|
3070
3254
|
#
|
3071
3255
|
# @overload get_domain_names(params = {})
|
3072
3256
|
# @param [Hash] params ({})
|
@@ -3686,7 +3870,7 @@ module Aws::APIGateway
|
|
3686
3870
|
# request supports only retrieval of the embedded Method resources this
|
3687
3871
|
# way. The query parameter value must be a single-valued list and
|
3688
3872
|
# contain the `"methods"` string. For example, `GET
|
3689
|
-
# /restapis
|
3873
|
+
# /restapis/{restapi_id}/resources/{resource_id}?embed=methods`.
|
3690
3874
|
#
|
3691
3875
|
# @return [Types::Resource] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3692
3876
|
#
|
@@ -3781,7 +3965,7 @@ module Aws::APIGateway
|
|
3781
3965
|
# request supports only retrieval of the embedded Method resources this
|
3782
3966
|
# way. The query parameter value must be a single-valued list and
|
3783
3967
|
# contain the `"methods"` string. For example, `GET
|
3784
|
-
# /restapis
|
3968
|
+
# /restapis/{restapi_id}/resources?embed=methods`.
|
3785
3969
|
#
|
3786
3970
|
# @return [Types::Resources] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3787
3971
|
#
|
@@ -4883,23 +5067,22 @@ module Aws::APIGateway
|
|
4883
5067
|
# is not `VPC_LINK`, or private integration, where `connectionType` is
|
4884
5068
|
# `VPC_LINK`. For a private HTTP integration, the URI is not used for
|
4885
5069
|
# routing. For `AWS` or `AWS_PROXY` integrations, the URI is of the form
|
4886
|
-
# `arn:aws:apigateway
|
4887
|
-
# Here,
|
4888
|
-
#
|
4889
|
-
#
|
4890
|
-
#
|
4891
|
-
#
|
4892
|
-
#
|
4893
|
-
#
|
4894
|
-
#
|
4895
|
-
#
|
4896
|
-
#
|
4897
|
-
#
|
4898
|
-
#
|
4899
|
-
#
|
4900
|
-
#
|
4901
|
-
# `arn:aws:apigateway:us-west-2:s3:
|
4902
|
-
# or `arn:aws:apigateway:us-west-2:s3:path/\{bucket\}/\{key\}`.
|
5070
|
+
# `arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api`}.
|
5071
|
+
# Here, \{Region} is the API Gateway region (e.g., us-east-1);
|
5072
|
+
# \{service} is the name of the integrated Amazon Web Services service
|
5073
|
+
# (e.g., s3); and \{subdomain} is a designated subdomain supported by
|
5074
|
+
# certain Amazon Web Services service for fast host-name lookup. action
|
5075
|
+
# can be used for an Amazon Web Services service action-based API, using
|
5076
|
+
# an Action=\{name}&\{p1}=\{v1}&p2=\{v2}... query string. The
|
5077
|
+
# ensuing \{service\_api} refers to a supported action \{name} plus any
|
5078
|
+
# required input parameters. Alternatively, path can be used for an
|
5079
|
+
# Amazon Web Services service path-based API. The ensuing service\_api
|
5080
|
+
# refers to the path to an Amazon Web Services service resource,
|
5081
|
+
# including the region of the integrated Amazon Web Services service, if
|
5082
|
+
# applicable. For example, for integration with the S3 API of
|
5083
|
+
# `GetObject`, the `uri` can be either
|
5084
|
+
# `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}`
|
5085
|
+
# or `arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}`.
|
4903
5086
|
#
|
4904
5087
|
# @option params [String] :connection_type
|
4905
5088
|
# The type of the network connection to the integration endpoint. The
|
@@ -4920,10 +5103,9 @@ module Aws::APIGateway
|
|
4920
5103
|
# parameter name and the associated value is a method request parameter
|
4921
5104
|
# value or static value that must be enclosed within single quotes and
|
4922
5105
|
# pre-encoded as required by the back end. The method request parameter
|
4923
|
-
# value must match the pattern of
|
4924
|
-
# `
|
4925
|
-
#
|
4926
|
-
# unique method request parameter name.
|
5106
|
+
# value must match the pattern of `method.request.{location}.{name}`,
|
5107
|
+
# where `location` is `querystring`, `path`, or `header` and `name` must
|
5108
|
+
# be a valid and unique method request parameter name.
|
4927
5109
|
#
|
4928
5110
|
# @option params [Hash<String,String>] :request_templates
|
4929
5111
|
# Represents a map of Velocity templates that are applied on the request
|
@@ -5071,11 +5253,11 @@ module Aws::APIGateway
|
|
5071
5253
|
# parameter name and the mapped value is an integration response header
|
5072
5254
|
# value, a static value enclosed within a pair of single quotes, or a
|
5073
5255
|
# JSON expression from the integration response body. The mapping key
|
5074
|
-
# must match the pattern of `method.response.header
|
5256
|
+
# must match the pattern of `method.response.header.{name}`, where
|
5075
5257
|
# `name` is a valid and unique header name. The mapped non-static value
|
5076
|
-
# must match the pattern of `integration.response.header
|
5077
|
-
# `integration.response.body
|
5078
|
-
#
|
5258
|
+
# must match the pattern of `integration.response.header.{name}` or
|
5259
|
+
# `integration.response.body.{JSON-expression}`, where `name` must be a
|
5260
|
+
# valid and unique response header name and `JSON-expression` a valid
|
5079
5261
|
# JSON expression without the `$` prefix.
|
5080
5262
|
#
|
5081
5263
|
# @option params [Hash<String,String>] :response_templates
|
@@ -5166,13 +5348,12 @@ module Aws::APIGateway
|
|
5166
5348
|
# A key-value map defining required or optional method request
|
5167
5349
|
# parameters that can be accepted by API Gateway. A key defines a method
|
5168
5350
|
# request parameter name matching the pattern of
|
5169
|
-
# `method.request
|
5170
|
-
# `
|
5171
|
-
#
|
5172
|
-
#
|
5173
|
-
#
|
5174
|
-
#
|
5175
|
-
# parameters or body-mapping templates.
|
5351
|
+
# `method.request.{location}.{name}`, where `location` is `querystring`,
|
5352
|
+
# `path`, or `header` and `name` is a valid and unique parameter name.
|
5353
|
+
# The value associated with the key is a Boolean flag indicating whether
|
5354
|
+
# the parameter is required (`true`) or optional (`false`). The method
|
5355
|
+
# request parameter names defined here are available in Integration to
|
5356
|
+
# be mapped to integration request parameters or body-mapping templates.
|
5176
5357
|
#
|
5177
5358
|
# @option params [Hash<String,String>] :request_models
|
5178
5359
|
# Specifies the Model resources used for the request's content type.
|
@@ -5301,15 +5482,15 @@ module Aws::APIGateway
|
|
5301
5482
|
# response header name and the associated value is a Boolean flag
|
5302
5483
|
# indicating whether the method response parameter is required or not.
|
5303
5484
|
# The method response header names must match the pattern of
|
5304
|
-
# `method.response.header
|
5485
|
+
# `method.response.header.{name}`, where `name` is a valid and unique
|
5305
5486
|
# header name. The response parameter names defined here are available
|
5306
5487
|
# in the integration response to be mapped from an integration response
|
5307
|
-
# header expressed in `integration.response.header
|
5488
|
+
# header expressed in `integration.response.header.{name}`, a static
|
5308
5489
|
# value enclosed within a pair of single quotes (e.g.,
|
5309
5490
|
# `'application/json'`), or a JSON expression from the back-end response
|
5310
|
-
# payload in the form of
|
5311
|
-
# `
|
5312
|
-
#
|
5491
|
+
# payload in the form of `integration.response.body.{JSON-expression}`,
|
5492
|
+
# where `JSON-expression` is a valid JSON expression without the `$`
|
5493
|
+
# prefix.)
|
5313
5494
|
#
|
5314
5495
|
# @option params [Hash<String,String>] :response_models
|
5315
5496
|
# Specifies the Model resources used for the response's content type.
|
@@ -5441,6 +5622,36 @@ module Aws::APIGateway
|
|
5441
5622
|
req.send_request(options)
|
5442
5623
|
end
|
5443
5624
|
|
5625
|
+
# Rejects a domain name access association with a private custom domain
|
5626
|
+
# name.
|
5627
|
+
#
|
5628
|
+
# To reject a domain name access association with an access association
|
5629
|
+
# source in another AWS account, use this operation. To remove a domain
|
5630
|
+
# name access association with an access association source in your own
|
5631
|
+
# account, use the DeleteDomainNameAccessAssociation operation.
|
5632
|
+
#
|
5633
|
+
# @option params [required, String] :domain_name_access_association_arn
|
5634
|
+
# The ARN of the domain name access association resource.
|
5635
|
+
#
|
5636
|
+
# @option params [required, String] :domain_name_arn
|
5637
|
+
# The ARN of the domain name.
|
5638
|
+
#
|
5639
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5640
|
+
#
|
5641
|
+
# @example Request syntax with placeholder values
|
5642
|
+
#
|
5643
|
+
# resp = client.reject_domain_name_access_association({
|
5644
|
+
# domain_name_access_association_arn: "String", # required
|
5645
|
+
# domain_name_arn: "String", # required
|
5646
|
+
# })
|
5647
|
+
#
|
5648
|
+
# @overload reject_domain_name_access_association(params = {})
|
5649
|
+
# @param [Hash] params ({})
|
5650
|
+
def reject_domain_name_access_association(params = {}, options = {})
|
5651
|
+
req = build_request(:reject_domain_name_access_association, params)
|
5652
|
+
req.send_request(options)
|
5653
|
+
end
|
5654
|
+
|
5444
5655
|
# Adds or updates a tag on a given resource.
|
5445
5656
|
#
|
5446
5657
|
# @option params [required, String] :resource_arn
|
@@ -5840,6 +6051,10 @@ module Aws::APIGateway
|
|
5840
6051
|
# @option params [required, String] :domain_name
|
5841
6052
|
# The domain name of the BasePathMapping resource to change.
|
5842
6053
|
#
|
6054
|
+
# @option params [String] :domain_name_id
|
6055
|
+
# The identifier for the domain name resource. Supported only for
|
6056
|
+
# private custom domain names.
|
6057
|
+
#
|
5843
6058
|
# @option params [required, String] :base_path
|
5844
6059
|
# The base path of the BasePathMapping resource to change.
|
5845
6060
|
#
|
@@ -5863,6 +6078,7 @@ module Aws::APIGateway
|
|
5863
6078
|
#
|
5864
6079
|
# resp = client.update_base_path_mapping({
|
5865
6080
|
# domain_name: "String", # required
|
6081
|
+
# domain_name_id: "String",
|
5866
6082
|
# base_path: "String", # required
|
5867
6083
|
# patch_operations: [
|
5868
6084
|
# {
|
@@ -6105,6 +6321,10 @@ module Aws::APIGateway
|
|
6105
6321
|
# @option params [required, String] :domain_name
|
6106
6322
|
# The name of the DomainName resource to be changed.
|
6107
6323
|
#
|
6324
|
+
# @option params [String] :domain_name_id
|
6325
|
+
# The identifier for the domain name resource. Supported only for
|
6326
|
+
# private custom domain names.
|
6327
|
+
#
|
6108
6328
|
# @option params [Array<Types::PatchOperation>] :patch_operations
|
6109
6329
|
# For more information about supported patch operations, see [Patch
|
6110
6330
|
# Operations][1].
|
@@ -6116,6 +6336,8 @@ module Aws::APIGateway
|
|
6116
6336
|
# @return [Types::DomainName] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6117
6337
|
#
|
6118
6338
|
# * {Types::DomainName#domain_name #domain_name} => String
|
6339
|
+
# * {Types::DomainName#domain_name_id #domain_name_id} => String
|
6340
|
+
# * {Types::DomainName#domain_name_arn #domain_name_arn} => String
|
6119
6341
|
# * {Types::DomainName#certificate_name #certificate_name} => String
|
6120
6342
|
# * {Types::DomainName#certificate_arn #certificate_arn} => String
|
6121
6343
|
# * {Types::DomainName#certificate_upload_date #certificate_upload_date} => Time
|
@@ -6132,11 +6354,14 @@ module Aws::APIGateway
|
|
6132
6354
|
# * {Types::DomainName#tags #tags} => Hash<String,String>
|
6133
6355
|
# * {Types::DomainName#mutual_tls_authentication #mutual_tls_authentication} => Types::MutualTlsAuthentication
|
6134
6356
|
# * {Types::DomainName#ownership_verification_certificate_arn #ownership_verification_certificate_arn} => String
|
6357
|
+
# * {Types::DomainName#management_policy #management_policy} => String
|
6358
|
+
# * {Types::DomainName#policy #policy} => String
|
6135
6359
|
#
|
6136
6360
|
# @example Request syntax with placeholder values
|
6137
6361
|
#
|
6138
6362
|
# resp = client.update_domain_name({
|
6139
6363
|
# domain_name: "String", # required
|
6364
|
+
# domain_name_id: "String",
|
6140
6365
|
# patch_operations: [
|
6141
6366
|
# {
|
6142
6367
|
# op: "add", # accepts add, remove, replace, move, copy, test
|
@@ -6150,6 +6375,8 @@ module Aws::APIGateway
|
|
6150
6375
|
# @example Response structure
|
6151
6376
|
#
|
6152
6377
|
# resp.domain_name #=> String
|
6378
|
+
# resp.domain_name_id #=> String
|
6379
|
+
# resp.domain_name_arn #=> String
|
6153
6380
|
# resp.certificate_name #=> String
|
6154
6381
|
# resp.certificate_arn #=> String
|
6155
6382
|
# resp.certificate_upload_date #=> Time
|
@@ -6173,6 +6400,8 @@ module Aws::APIGateway
|
|
6173
6400
|
# resp.mutual_tls_authentication.truststore_warnings #=> Array
|
6174
6401
|
# resp.mutual_tls_authentication.truststore_warnings[0] #=> String
|
6175
6402
|
# resp.ownership_verification_certificate_arn #=> String
|
6403
|
+
# resp.management_policy #=> String
|
6404
|
+
# resp.policy #=> String
|
6176
6405
|
#
|
6177
6406
|
# @overload update_domain_name(params = {})
|
6178
6407
|
# @param [Hash] params ({})
|
@@ -7125,7 +7354,7 @@ module Aws::APIGateway
|
|
7125
7354
|
tracer: tracer
|
7126
7355
|
)
|
7127
7356
|
context[:gem_name] = 'aws-sdk-apigateway'
|
7128
|
-
context[:gem_version] = '1.
|
7357
|
+
context[:gem_version] = '1.110.0'
|
7129
7358
|
Seahorse::Client::Request.new(handlers, context)
|
7130
7359
|
end
|
7131
7360
|
|