aws-sdk-apigateway 1.108.0 → 1.109.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-apigateway/client.rb +44 -47
- data/lib/aws-sdk-apigateway/types.rb +85 -91
- data/lib/aws-sdk-apigateway.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e270f31580647e112081484cb7e6a6d0197af32b15d15cf6af2bad721439a8f1
|
4
|
+
data.tar.gz: 4fdeeaa4b3964d9a1926d7567555b9a6fbb2de55977a6fca227da660dd5eaf6b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b1236d1ba98e20f00526ef380d88e5c3e8521a2cc65df22cd5dab3ca5929a8fce55a02d5b7e86709a561b357fbf45185725166d1f622f637a4e8bca5d7f30263
|
7
|
+
data.tar.gz: 857b819aa38203fa9a9f6cc471b5b4d0e5a39f9c1131fbc6b45216f86d8e72a8a45fdde3a986683240a9cebe1aaddf584c95b94823543d7404ec227813e3c5a6
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.109.0
|
@@ -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
|
@@ -1269,7 +1269,7 @@ module Aws::APIGateway
|
|
1269
1269
|
# @option params [Boolean] :disable_execute_api_endpoint
|
1270
1270
|
# Specifies whether clients can invoke your API by using the default
|
1271
1271
|
# `execute-api` endpoint. By default, clients can invoke your API with
|
1272
|
-
# the default `https
|
1272
|
+
# the default `https://{api_id}.execute-api.{region}.amazonaws.com`
|
1273
1273
|
# endpoint. To require that clients use a custom domain name to invoke
|
1274
1274
|
# your API, disable the default endpoint
|
1275
1275
|
#
|
@@ -2689,13 +2689,13 @@ module Aws::APIGateway
|
|
2689
2689
|
# returned Deployment resource in the response. In a REST API call, this
|
2690
2690
|
# `embed` parameter value is a list of comma-separated strings, as in
|
2691
2691
|
# `GET
|
2692
|
-
# /restapis
|
2692
|
+
# /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2`.
|
2693
2693
|
# The SDK and other platform-dependent libraries might use a different
|
2694
2694
|
# format for the list. Currently, this request supports only retrieval
|
2695
2695
|
# of the embedded API summary this way. Hence, the parameter value must
|
2696
2696
|
# be a single-valued list containing only the `"apisummary"` string. For
|
2697
2697
|
# example, `GET
|
2698
|
-
# /restapis
|
2698
|
+
# /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary`.
|
2699
2699
|
#
|
2700
2700
|
# @return [Types::Deployment] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2701
2701
|
#
|
@@ -3686,7 +3686,7 @@ module Aws::APIGateway
|
|
3686
3686
|
# request supports only retrieval of the embedded Method resources this
|
3687
3687
|
# way. The query parameter value must be a single-valued list and
|
3688
3688
|
# contain the `"methods"` string. For example, `GET
|
3689
|
-
# /restapis
|
3689
|
+
# /restapis/{restapi_id}/resources/{resource_id}?embed=methods`.
|
3690
3690
|
#
|
3691
3691
|
# @return [Types::Resource] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3692
3692
|
#
|
@@ -3781,7 +3781,7 @@ module Aws::APIGateway
|
|
3781
3781
|
# request supports only retrieval of the embedded Method resources this
|
3782
3782
|
# way. The query parameter value must be a single-valued list and
|
3783
3783
|
# contain the `"methods"` string. For example, `GET
|
3784
|
-
# /restapis
|
3784
|
+
# /restapis/{restapi_id}/resources?embed=methods`.
|
3785
3785
|
#
|
3786
3786
|
# @return [Types::Resources] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3787
3787
|
#
|
@@ -4883,23 +4883,22 @@ module Aws::APIGateway
|
|
4883
4883
|
# is not `VPC_LINK`, or private integration, where `connectionType` is
|
4884
4884
|
# `VPC_LINK`. For a private HTTP integration, the URI is not used for
|
4885
4885
|
# 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\}`.
|
4886
|
+
# `arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api`}.
|
4887
|
+
# Here, \{Region} is the API Gateway region (e.g., us-east-1);
|
4888
|
+
# \{service} is the name of the integrated Amazon Web Services service
|
4889
|
+
# (e.g., s3); and \{subdomain} is a designated subdomain supported by
|
4890
|
+
# certain Amazon Web Services service for fast host-name lookup. action
|
4891
|
+
# can be used for an Amazon Web Services service action-based API, using
|
4892
|
+
# an Action=\{name}&\{p1}=\{v1}&p2=\{v2}... query string. The
|
4893
|
+
# ensuing \{service\_api} refers to a supported action \{name} plus any
|
4894
|
+
# required input parameters. Alternatively, path can be used for an
|
4895
|
+
# Amazon Web Services service path-based API. The ensuing service\_api
|
4896
|
+
# refers to the path to an Amazon Web Services service resource,
|
4897
|
+
# including the region of the integrated Amazon Web Services service, if
|
4898
|
+
# applicable. For example, for integration with the S3 API of
|
4899
|
+
# `GetObject`, the `uri` can be either
|
4900
|
+
# `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}`
|
4901
|
+
# or `arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}`.
|
4903
4902
|
#
|
4904
4903
|
# @option params [String] :connection_type
|
4905
4904
|
# The type of the network connection to the integration endpoint. The
|
@@ -4920,10 +4919,9 @@ module Aws::APIGateway
|
|
4920
4919
|
# parameter name and the associated value is a method request parameter
|
4921
4920
|
# value or static value that must be enclosed within single quotes and
|
4922
4921
|
# 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.
|
4922
|
+
# value must match the pattern of `method.request.{location}.{name}`,
|
4923
|
+
# where `location` is `querystring`, `path`, or `header` and `name` must
|
4924
|
+
# be a valid and unique method request parameter name.
|
4927
4925
|
#
|
4928
4926
|
# @option params [Hash<String,String>] :request_templates
|
4929
4927
|
# Represents a map of Velocity templates that are applied on the request
|
@@ -5071,11 +5069,11 @@ module Aws::APIGateway
|
|
5071
5069
|
# parameter name and the mapped value is an integration response header
|
5072
5070
|
# value, a static value enclosed within a pair of single quotes, or a
|
5073
5071
|
# JSON expression from the integration response body. The mapping key
|
5074
|
-
# must match the pattern of `method.response.header
|
5072
|
+
# must match the pattern of `method.response.header.{name}`, where
|
5075
5073
|
# `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
|
-
#
|
5074
|
+
# must match the pattern of `integration.response.header.{name}` or
|
5075
|
+
# `integration.response.body.{JSON-expression}`, where `name` must be a
|
5076
|
+
# valid and unique response header name and `JSON-expression` a valid
|
5079
5077
|
# JSON expression without the `$` prefix.
|
5080
5078
|
#
|
5081
5079
|
# @option params [Hash<String,String>] :response_templates
|
@@ -5166,13 +5164,12 @@ module Aws::APIGateway
|
|
5166
5164
|
# A key-value map defining required or optional method request
|
5167
5165
|
# parameters that can be accepted by API Gateway. A key defines a method
|
5168
5166
|
# request parameter name matching the pattern of
|
5169
|
-
# `method.request
|
5170
|
-
# `
|
5171
|
-
#
|
5172
|
-
#
|
5173
|
-
#
|
5174
|
-
#
|
5175
|
-
# parameters or body-mapping templates.
|
5167
|
+
# `method.request.{location}.{name}`, where `location` is `querystring`,
|
5168
|
+
# `path`, or `header` and `name` is a valid and unique parameter name.
|
5169
|
+
# The value associated with the key is a Boolean flag indicating whether
|
5170
|
+
# the parameter is required (`true`) or optional (`false`). The method
|
5171
|
+
# request parameter names defined here are available in Integration to
|
5172
|
+
# be mapped to integration request parameters or body-mapping templates.
|
5176
5173
|
#
|
5177
5174
|
# @option params [Hash<String,String>] :request_models
|
5178
5175
|
# Specifies the Model resources used for the request's content type.
|
@@ -5301,15 +5298,15 @@ module Aws::APIGateway
|
|
5301
5298
|
# response header name and the associated value is a Boolean flag
|
5302
5299
|
# indicating whether the method response parameter is required or not.
|
5303
5300
|
# The method response header names must match the pattern of
|
5304
|
-
# `method.response.header
|
5301
|
+
# `method.response.header.{name}`, where `name` is a valid and unique
|
5305
5302
|
# header name. The response parameter names defined here are available
|
5306
5303
|
# in the integration response to be mapped from an integration response
|
5307
|
-
# header expressed in `integration.response.header
|
5304
|
+
# header expressed in `integration.response.header.{name}`, a static
|
5308
5305
|
# value enclosed within a pair of single quotes (e.g.,
|
5309
5306
|
# `'application/json'`), or a JSON expression from the back-end response
|
5310
|
-
# payload in the form of
|
5311
|
-
# `
|
5312
|
-
#
|
5307
|
+
# payload in the form of `integration.response.body.{JSON-expression}`,
|
5308
|
+
# where `JSON-expression` is a valid JSON expression without the `$`
|
5309
|
+
# prefix.)
|
5313
5310
|
#
|
5314
5311
|
# @option params [Hash<String,String>] :response_models
|
5315
5312
|
# Specifies the Model resources used for the response's content type.
|
@@ -7125,7 +7122,7 @@ module Aws::APIGateway
|
|
7125
7122
|
tracer: tracer
|
7126
7123
|
)
|
7127
7124
|
context[:gem_name] = 'aws-sdk-apigateway'
|
7128
|
-
context[:gem_version] = '1.
|
7125
|
+
context[:gem_version] = '1.109.0'
|
7129
7126
|
Seahorse::Client::Request.new(handlers, context)
|
7130
7127
|
end
|
7131
7128
|
|
@@ -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
|
@@ -1018,10 +1018,9 @@ module Aws::APIGateway
|
|
1018
1018
|
# @!attribute [rw] disable_execute_api_endpoint
|
1019
1019
|
# Specifies whether clients can invoke your API by using the default
|
1020
1020
|
# `execute-api` endpoint. By default, clients can invoke your API with
|
1021
|
-
# the default
|
1022
|
-
#
|
1023
|
-
#
|
1024
|
-
# disable the default endpoint
|
1021
|
+
# the default `https://{api_id}.execute-api.{region}.amazonaws.com`
|
1022
|
+
# endpoint. To require that clients use a custom domain name to invoke
|
1023
|
+
# your API, disable the default endpoint
|
1025
1024
|
# @return [Boolean]
|
1026
1025
|
#
|
1027
1026
|
class CreateRestApiRequest < Struct.new(
|
@@ -1676,7 +1675,7 @@ module Aws::APIGateway
|
|
1676
1675
|
# @!attribute [rw] properties
|
1677
1676
|
# A content map of API-specific key-value pairs describing the
|
1678
1677
|
# targeted API entity. The map must be encoded as a JSON string, e.g.,
|
1679
|
-
# `"
|
1678
|
+
# `"{ "description": "The API does ..." }"`. Only
|
1680
1679
|
# OpenAPI-compliant documentation-related fields from the properties
|
1681
1680
|
# map are exported and, hence, published as part of the API entity
|
1682
1681
|
# definitions, while the original documentation parts are exported in
|
@@ -2315,13 +2314,13 @@ module Aws::APIGateway
|
|
2315
2314
|
# the returned Deployment resource in the response. In a REST API
|
2316
2315
|
# call, this `embed` parameter value is a list of comma-separated
|
2317
2316
|
# strings, as in `GET
|
2318
|
-
# /restapis
|
2317
|
+
# /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2`.
|
2319
2318
|
# The SDK and other platform-dependent libraries might use a different
|
2320
2319
|
# format for the list. Currently, this request supports only retrieval
|
2321
2320
|
# of the embedded API summary this way. Hence, the parameter value
|
2322
2321
|
# must be a single-valued list containing only the `"apisummary"`
|
2323
2322
|
# string. For example, `GET
|
2324
|
-
# /restapis
|
2323
|
+
# /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary`.
|
2325
2324
|
# @return [Array<String>]
|
2326
2325
|
#
|
2327
2326
|
class GetDeploymentRequest < Struct.new(
|
@@ -2803,7 +2802,7 @@ module Aws::APIGateway
|
|
2803
2802
|
# request supports only retrieval of the embedded Method resources
|
2804
2803
|
# this way. The query parameter value must be a single-valued list and
|
2805
2804
|
# contain the `"methods"` string. For example, `GET
|
2806
|
-
# /restapis
|
2805
|
+
# /restapis/{restapi_id}/resources/{resource_id}?embed=methods`.
|
2807
2806
|
# @return [Array<String>]
|
2808
2807
|
#
|
2809
2808
|
class GetResourceRequest < Struct.new(
|
@@ -2836,7 +2835,7 @@ module Aws::APIGateway
|
|
2836
2835
|
# request supports only retrieval of the embedded Method resources
|
2837
2836
|
# this way. The query parameter value must be a single-valued list and
|
2838
2837
|
# contain the `"methods"` string. For example, `GET
|
2839
|
-
# /restapis
|
2838
|
+
# /restapis/{restapi_id}/resources?embed=methods`.
|
2840
2839
|
# @return [Array<String>]
|
2841
2840
|
#
|
2842
2841
|
class GetResourcesRequest < Struct.new(
|
@@ -3293,23 +3292,22 @@ module Aws::APIGateway
|
|
3293
3292
|
# for standard integrations. If `connectionType` is `VPC_LINK` specify
|
3294
3293
|
# the Network Load Balancer DNS name. For `AWS` or `AWS_PROXY`
|
3295
3294
|
# 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
|
3295
|
+
# `arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}`.
|
3296
|
+
# Here, \{Region} is the API Gateway region (e.g., us-east-1);
|
3297
|
+
# \{service} is the name of the integrated Amazon Web Services service
|
3298
|
+
# (e.g., s3); and \{subdomain} is a designated subdomain supported by
|
3299
|
+
# certain Amazon Web Services service for fast host-name lookup.
|
3300
|
+
# action can be used for an Amazon Web Services service action-based
|
3301
|
+
# API, using an Action=\{name}&\{p1}=\{v1}&p2=\{v2}... query
|
3302
|
+
# string. The ensuing \{service\_api} refers to a supported action
|
3303
|
+
# \{name} plus any required input parameters. Alternatively, path can
|
3304
|
+
# be used for an Amazon Web Services service path-based API. The
|
3307
3305
|
# ensuing service\_api refers to the path to an Amazon Web Services
|
3308
3306
|
# service resource, including the region of the integrated Amazon Web
|
3309
3307
|
# Services service, if applicable. For example, for integration with
|
3310
3308
|
# 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
|
3309
|
+
# `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}`
|
3310
|
+
# or `arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}`
|
3313
3311
|
# @return [String]
|
3314
3312
|
#
|
3315
3313
|
# @!attribute [rw] connection_type
|
@@ -3342,7 +3340,7 @@ module Aws::APIGateway
|
|
3342
3340
|
# parameter value or static value that must be enclosed within single
|
3343
3341
|
# quotes and pre-encoded as required by the back end. The method
|
3344
3342
|
# request parameter value must match the pattern of
|
3345
|
-
# `method.request
|
3343
|
+
# `method.request.{location}.{name}`, where `location` is
|
3346
3344
|
# `querystring`, `path`, or `header` and `name` must be a valid and
|
3347
3345
|
# unique method request parameter name.
|
3348
3346
|
# @return [Hash<String,String>]
|
@@ -3463,10 +3461,10 @@ module Aws::APIGateway
|
|
3463
3461
|
# response header value, a static value enclosed within a pair of
|
3464
3462
|
# single quotes, or a JSON expression from the integration response
|
3465
3463
|
# body. The mapping key must match the pattern of
|
3466
|
-
# `method.response.header
|
3467
|
-
#
|
3468
|
-
#
|
3469
|
-
# `integration.response.body
|
3464
|
+
# `method.response.header.{name}`, where `name` is a valid and unique
|
3465
|
+
# header name. The mapped non-static value must match the pattern of
|
3466
|
+
# `integration.response.header.{name}` or
|
3467
|
+
# `integration.response.body.{JSON-expression}`, where `name` is a
|
3470
3468
|
# valid and unique response header name and `JSON-expression` is a
|
3471
3469
|
# valid JSON expression without the `$` prefix.
|
3472
3470
|
# @return [Hash<String,String>]
|
@@ -3560,7 +3558,7 @@ module Aws::APIGateway
|
|
3560
3558
|
# A key-value map defining required or optional method request
|
3561
3559
|
# parameters that can be accepted by API Gateway. A key is a method
|
3562
3560
|
# request parameter name matching the pattern of
|
3563
|
-
# `method.request
|
3561
|
+
# `method.request.{location}.{name}`, where `location` is
|
3564
3562
|
# `querystring`, `path`, or `header` and `name` is a valid and unique
|
3565
3563
|
# parameter name. The value associated with the key is a Boolean flag
|
3566
3564
|
# indicating whether the parameter is required (`true`) or optional
|
@@ -3627,16 +3625,16 @@ module Aws::APIGateway
|
|
3627
3625
|
# that API Gateway can send back to the caller. A key defines a method
|
3628
3626
|
# response header and the value specifies whether the associated
|
3629
3627
|
# method response header is required or not. The expression of the key
|
3630
|
-
# must match the pattern `method.response.header
|
3631
|
-
#
|
3628
|
+
# must match the pattern `method.response.header.{name}`, where `name`
|
3629
|
+
# is a valid and unique header name. API Gateway passes certain
|
3632
3630
|
# integration response data to the method response headers specified
|
3633
3631
|
# here according to the mapping you prescribe in the API's
|
3634
3632
|
# IntegrationResponse. The integration response data that can be
|
3635
3633
|
# mapped include an integration response header expressed in
|
3636
|
-
# `integration.response.header
|
3637
|
-
#
|
3638
|
-
#
|
3639
|
-
# `integration.response.body
|
3634
|
+
# `integration.response.header.{name}`, a static value enclosed within
|
3635
|
+
# a pair of single quotes (e.g., `'application/json'`), or a JSON
|
3636
|
+
# expression from the back-end response payload in the form of
|
3637
|
+
# `integration.response.body.{JSON-expression}`, where
|
3640
3638
|
# `JSON-expression` is a valid JSON expression without the `$`
|
3641
3639
|
# prefix.)
|
3642
3640
|
# @return [Hash<String,Boolean>]
|
@@ -3898,20 +3896,20 @@ module Aws::APIGateway
|
|
3898
3896
|
# The op operation's target, as identified by a JSON Pointer value
|
3899
3897
|
# that references a location within the targeted resource. For
|
3900
3898
|
# example, if the target resource has an updateable property of
|
3901
|
-
#
|
3902
|
-
#
|
3903
|
-
#
|
3904
|
-
#
|
3905
|
-
#
|
3906
|
-
#
|
3907
|
-
#
|
3899
|
+
# \{"name":"value"}, the path for this property is /name. If the
|
3900
|
+
# name property value is a JSON object (e.g., \{"name":
|
3901
|
+
# \{"child/name": "child-value"}}), the path for the child/name
|
3902
|
+
# property will be /name/child~1name. Any slash ("/") character
|
3903
|
+
# appearing in path names must be escaped with "~1", as shown in the
|
3904
|
+
# example above. Each op operation can have only one path associated
|
3905
|
+
# with it.
|
3908
3906
|
# @return [String]
|
3909
3907
|
#
|
3910
3908
|
# @!attribute [rw] value
|
3911
3909
|
# The new target value of the update operation. It is applicable for
|
3912
3910
|
# the add or replace operation. When using AWS CLI to update a
|
3913
3911
|
# property of a JSON value, enclose the JSON object with a pair of
|
3914
|
-
# single quotes in a Linux shell, e.g., '
|
3912
|
+
# single quotes in a Linux shell, e.g., '\{"a": ...}'.
|
3915
3913
|
# @return [String]
|
3916
3914
|
#
|
3917
3915
|
# @!attribute [rw] from
|
@@ -3999,23 +3997,22 @@ module Aws::APIGateway
|
|
3999
3997
|
# `connectionType` is `VPC_LINK`. For a private HTTP integration, the
|
4000
3998
|
# URI is not used for routing. For `AWS` or `AWS_PROXY` integrations,
|
4001
3999
|
# 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
|
4000
|
+
# `arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api`}.
|
4001
|
+
# Here, \{Region} is the API Gateway region (e.g., us-east-1);
|
4002
|
+
# \{service} is the name of the integrated Amazon Web Services service
|
4003
|
+
# (e.g., s3); and \{subdomain} is a designated subdomain supported by
|
4004
|
+
# certain Amazon Web Services service for fast host-name lookup.
|
4005
|
+
# action can be used for an Amazon Web Services service action-based
|
4006
|
+
# API, using an Action=\{name}&\{p1}=\{v1}&p2=\{v2}... query
|
4007
|
+
# string. The ensuing \{service\_api} refers to a supported action
|
4008
|
+
# \{name} plus any required input parameters. Alternatively, path can
|
4009
|
+
# be used for an Amazon Web Services service path-based API. The
|
4013
4010
|
# ensuing service\_api refers to the path to an Amazon Web Services
|
4014
4011
|
# service resource, including the region of the integrated Amazon Web
|
4015
4012
|
# Services service, if applicable. For example, for integration with
|
4016
4013
|
# 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
|
4014
|
+
# `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}`
|
4015
|
+
# or `arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}`.
|
4019
4016
|
# @return [String]
|
4020
4017
|
#
|
4021
4018
|
# @!attribute [rw] connection_type
|
@@ -4042,7 +4039,7 @@ module Aws::APIGateway
|
|
4042
4039
|
# parameter value or static value that must be enclosed within single
|
4043
4040
|
# quotes and pre-encoded as required by the back end. The method
|
4044
4041
|
# request parameter value must match the pattern of
|
4045
|
-
# `method.request
|
4042
|
+
# `method.request.{location}.{name}`, where `location` is
|
4046
4043
|
# `querystring`, `path`, or `header` and `name` must be a valid and
|
4047
4044
|
# unique method request parameter name.
|
4048
4045
|
# @return [Hash<String,String>]
|
@@ -4147,11 +4144,11 @@ module Aws::APIGateway
|
|
4147
4144
|
# response header value, a static value enclosed within a pair of
|
4148
4145
|
# single quotes, or a JSON expression from the integration response
|
4149
4146
|
# body. The mapping key must match the pattern of
|
4150
|
-
# `method.response.header
|
4151
|
-
#
|
4152
|
-
#
|
4153
|
-
# `integration.response.body
|
4154
|
-
#
|
4147
|
+
# `method.response.header.{name}`, where `name` is a valid and unique
|
4148
|
+
# header name. The mapped non-static value must match the pattern of
|
4149
|
+
# `integration.response.header.{name}` or
|
4150
|
+
# `integration.response.body.{JSON-expression}`, where `name` must be
|
4151
|
+
# a valid and unique response header name and `JSON-expression` a
|
4155
4152
|
# valid JSON expression without the `$` prefix.
|
4156
4153
|
# @return [Hash<String,String>]
|
4157
4154
|
#
|
@@ -4224,7 +4221,7 @@ module Aws::APIGateway
|
|
4224
4221
|
# A key-value map defining required or optional method request
|
4225
4222
|
# parameters that can be accepted by API Gateway. A key defines a
|
4226
4223
|
# method request parameter name matching the pattern of
|
4227
|
-
# `method.request
|
4224
|
+
# `method.request.{location}.{name}`, where `location` is
|
4228
4225
|
# `querystring`, `path`, or `header` and `name` is a valid and unique
|
4229
4226
|
# parameter name. The value associated with the key is a Boolean flag
|
4230
4227
|
# indicating whether the parameter is required (`true`) or optional
|
@@ -4296,14 +4293,14 @@ module Aws::APIGateway
|
|
4296
4293
|
# response header name and the associated value is a Boolean flag
|
4297
4294
|
# indicating whether the method response parameter is required or not.
|
4298
4295
|
# The method response header names must match the pattern of
|
4299
|
-
# `method.response.header
|
4300
|
-
#
|
4301
|
-
#
|
4302
|
-
#
|
4303
|
-
#
|
4304
|
-
#
|
4305
|
-
#
|
4306
|
-
# `integration.response.body
|
4296
|
+
# `method.response.header.{name}`, where `name` is a valid and unique
|
4297
|
+
# header name. The response parameter names defined here are available
|
4298
|
+
# in the integration response to be mapped from an integration
|
4299
|
+
# response header expressed in `integration.response.header.{name}`, a
|
4300
|
+
# static value enclosed within a pair of single quotes (e.g.,
|
4301
|
+
# `'application/json'`), or a JSON expression from the back-end
|
4302
|
+
# response payload in the form of
|
4303
|
+
# `integration.response.body.{JSON-expression}`, where
|
4307
4304
|
# `JSON-expression` is a valid JSON expression without the `$`
|
4308
4305
|
# prefix.)
|
4309
4306
|
# @return [Hash<String,Boolean>]
|
@@ -4554,10 +4551,9 @@ module Aws::APIGateway
|
|
4554
4551
|
# @!attribute [rw] disable_execute_api_endpoint
|
4555
4552
|
# Specifies whether clients can invoke your API by using the default
|
4556
4553
|
# `execute-api` endpoint. By default, clients can invoke your API with
|
4557
|
-
# the default
|
4558
|
-
#
|
4559
|
-
#
|
4560
|
-
# disable the default endpoint.
|
4554
|
+
# the default `https://{api_id}.execute-api.{region}.amazonaws.com`
|
4555
|
+
# endpoint. To require that clients use a custom domain name to invoke
|
4556
|
+
# your API, disable the default endpoint.
|
4561
4557
|
# @return [Boolean]
|
4562
4558
|
#
|
4563
4559
|
# @!attribute [rw] root_resource_id
|
@@ -4761,10 +4757,9 @@ module Aws::APIGateway
|
|
4761
4757
|
#
|
4762
4758
|
# @!attribute [rw] method_settings
|
4763
4759
|
# A map that defines the method settings for a Stage resource. Keys
|
4764
|
-
# (designated as
|
4765
|
-
# defined as
|
4766
|
-
#
|
4767
|
-
# stage.
|
4760
|
+
# (designated as `/{method_setting_key` below) are method paths
|
4761
|
+
# defined as `{resource_path}/{http_method}` for an individual method
|
4762
|
+
# override, or `/*/*` for overriding all methods in the stage.
|
4768
4763
|
# @return [Hash<String,Types::MethodSetting>]
|
4769
4764
|
#
|
4770
4765
|
# @!attribute [rw] variables
|
@@ -4830,7 +4825,7 @@ module Aws::APIGateway
|
|
4830
4825
|
end
|
4831
4826
|
|
4832
4827
|
# A reference to a unique stage identified in the format
|
4833
|
-
#
|
4828
|
+
# `{restApiId}/{stage}`.
|
4834
4829
|
#
|
4835
4830
|
# @!attribute [rw] rest_api_id
|
4836
4831
|
# The string identifier of the associated RestApi.
|
@@ -5803,10 +5798,9 @@ module Aws::APIGateway
|
|
5803
5798
|
# @!attribute [rw] items
|
5804
5799
|
# The usage data, as daily logs of used and remaining quotas, over the
|
5805
5800
|
# specified time interval indexed over the API keys in a usage plan.
|
5806
|
-
# For example,
|
5807
|
-
#
|
5808
|
-
#
|
5809
|
-
# quota]`.
|
5801
|
+
# For example, `{..., "values" : { "{api_key}" : [ [0, 100], [10, 90],
|
5802
|
+
# [100, 10]]}`, where `{api_key}` stands for an API key value and the
|
5803
|
+
# daily log entry is of the format `[used quota, remaining quota]`.
|
5810
5804
|
# @return [Hash<String,Array<Array<Integer>>>]
|
5811
5805
|
#
|
5812
5806
|
class Usage < Struct.new(
|
data/lib/aws-sdk-apigateway.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-apigateway
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.109.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: 2024-
|
11
|
+
date: 2024-11-06 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|