lib/aws-sdk-apigatewayv2/client.rb in aws-sdk-apigatewayv2-1.14.0 vs lib/aws-sdk-apigatewayv2/client.rb in aws-sdk-apigatewayv2-1.15.0
- old
+ new
@@ -262,68 +262,127 @@
#
#
#
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
#
+ # @option params [Types::Cors] :cors_configuration
+ # Represents a CORS configuration. Supported only for HTTP APIs. See
+ # [Configuring CORS][1] for more information.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html
+ #
+ # @option params [String] :credentials_arn
+ # Represents an Amazon Resource Name (ARN).
+ #
# @option params [String] :description
# A string with a length between \[0-1024\].
#
# @option params [Boolean] :disable_schema_validation
#
# @option params [required, String] :name
# A string with a length between \[1-128\].
#
# @option params [required, String] :protocol_type
+ # Represents a protocol type.
#
- # @option params [required, String] :route_selection_expression
+ # @option params [String] :route_key
+ # After evaluating a selection expression, the result is compared
+ # against one or more selection keys to find a matching key. See
+ # [Selection Expressions][1] for a list of expressions and each
+ # expression's associated selection key type.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
+ #
+ # @option params [String] :route_selection_expression
# An expression used to extract information at runtime. See [Selection
# Expressions][1] for more information.
#
#
#
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
#
+ # @option params [Hash<String,String>] :tags
+ # Represents a collection of tags associated with the resource.
+ #
+ # @option params [String] :target
+ # A string representation of a URI with a length between \[1-2048\].
+ #
# @option params [String] :version
# A string with a length between \[1-64\].
#
# @return [Types::CreateApiResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateApiResponse#api_endpoint #api_endpoint} => String
# * {Types::CreateApiResponse#api_id #api_id} => String
# * {Types::CreateApiResponse#api_key_selection_expression #api_key_selection_expression} => String
+ # * {Types::CreateApiResponse#cors_configuration #cors_configuration} => Types::Cors
# * {Types::CreateApiResponse#created_date #created_date} => Time
# * {Types::CreateApiResponse#description #description} => String
# * {Types::CreateApiResponse#disable_schema_validation #disable_schema_validation} => Boolean
+ # * {Types::CreateApiResponse#import_info #import_info} => Array<String>
# * {Types::CreateApiResponse#name #name} => String
# * {Types::CreateApiResponse#protocol_type #protocol_type} => String
# * {Types::CreateApiResponse#route_selection_expression #route_selection_expression} => String
+ # * {Types::CreateApiResponse#tags #tags} => Hash<String,String>
# * {Types::CreateApiResponse#version #version} => String
# * {Types::CreateApiResponse#warnings #warnings} => Array<String>
#
# @example Request syntax with placeholder values
#
# resp = client.create_api({
# api_key_selection_expression: "SelectionExpression",
+ # cors_configuration: {
+ # allow_credentials: false,
+ # allow_headers: ["__string"],
+ # allow_methods: ["StringWithLengthBetween1And64"],
+ # allow_origins: ["__string"],
+ # expose_headers: ["__string"],
+ # max_age: 1,
+ # },
+ # credentials_arn: "Arn",
# description: "StringWithLengthBetween0And1024",
# disable_schema_validation: false,
# name: "StringWithLengthBetween1And128", # required
- # protocol_type: "WEBSOCKET", # required, accepts WEBSOCKET
- # route_selection_expression: "SelectionExpression", # required
+ # protocol_type: "WEBSOCKET", # required, accepts WEBSOCKET, HTTP
+ # route_key: "SelectionKey",
+ # route_selection_expression: "SelectionExpression",
+ # tags: {
+ # "__string" => "StringWithLengthBetween1And1600",
+ # },
+ # target: "UriWithLengthBetween1And2048",
# version: "StringWithLengthBetween1And64",
# })
#
# @example Response structure
#
# resp.api_endpoint #=> String
# resp.api_id #=> String
# resp.api_key_selection_expression #=> String
+ # resp.cors_configuration.allow_credentials #=> Boolean
+ # resp.cors_configuration.allow_headers #=> Array
+ # resp.cors_configuration.allow_headers[0] #=> String
+ # resp.cors_configuration.allow_methods #=> Array
+ # resp.cors_configuration.allow_methods[0] #=> String
+ # resp.cors_configuration.allow_origins #=> Array
+ # resp.cors_configuration.allow_origins[0] #=> String
+ # resp.cors_configuration.expose_headers #=> Array
+ # resp.cors_configuration.expose_headers[0] #=> String
+ # resp.cors_configuration.max_age #=> Integer
# resp.created_date #=> Time
# resp.description #=> String
# resp.disable_schema_validation #=> Boolean
+ # resp.import_info #=> Array
+ # resp.import_info[0] #=> String
# resp.name #=> String
- # resp.protocol_type #=> String, one of "WEBSOCKET"
+ # resp.protocol_type #=> String, one of "WEBSOCKET", "HTTP"
# resp.route_selection_expression #=> String
+ # resp.tags #=> Hash
+ # resp.tags["__string"] #=> String
# resp.version #=> String
# resp.warnings #=> Array
# resp.warnings[0] #=> String
#
# @overload create_api(params = {})
@@ -337,11 +396,11 @@
#
# @option params [required, String] :api_id
# The identifier.
#
# @option params [String] :api_mapping_key
- # After evaulating a selection expression, the result is compared
+ # After evaluating a selection expression, the result is compared
# against one or more selection keys to find a matching key. See
# [Selection Expressions][1] for a list of expressions and each
# expression's associated selection key type.
#
#
@@ -392,14 +451,15 @@
#
# @option params [Integer] :authorizer_result_ttl_in_seconds
# An integer with a value between \[0-3600\].
#
# @option params [required, String] :authorizer_type
- # The authorizer type. Currently the only valid value is REQUEST, for a
- # Lambda function using incoming request parameters.
+ # The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda
+ # function using incoming request parameters. For HTTP APIs, specify JWT
+ # to use JSON Web Tokens.
#
- # @option params [required, String] :authorizer_uri
+ # @option params [String] :authorizer_uri
# A string representation of a URI with a length between \[1-2048\].
#
# @option params [required, Array<String>] :identity_source
# The identity source for which authorization is requested. For the
# REQUEST authorizer, this is required when authorization caching is
@@ -418,55 +478,60 @@
# authorization caching is not enabled, this property is optional.
#
# @option params [String] :identity_validation_expression
# A string with a length between \[0-1024\].
#
+ # @option params [Types::JWTConfiguration] :jwt_configuration
+ # Represents the configuration of a JWT authorizer. Required for the JWT
+ # authorizer type. Supported only for HTTP APIs.
+ #
# @option params [required, String] :name
# A string with a length between \[1-128\].
#
- # @option params [Array<String>] :provider_arns
- # For REQUEST authorizer, this is not defined.
- #
# @return [Types::CreateAuthorizerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateAuthorizerResponse#authorizer_credentials_arn #authorizer_credentials_arn} => String
# * {Types::CreateAuthorizerResponse#authorizer_id #authorizer_id} => String
# * {Types::CreateAuthorizerResponse#authorizer_result_ttl_in_seconds #authorizer_result_ttl_in_seconds} => Integer
# * {Types::CreateAuthorizerResponse#authorizer_type #authorizer_type} => String
# * {Types::CreateAuthorizerResponse#authorizer_uri #authorizer_uri} => String
# * {Types::CreateAuthorizerResponse#identity_source #identity_source} => Array<String>
# * {Types::CreateAuthorizerResponse#identity_validation_expression #identity_validation_expression} => String
+ # * {Types::CreateAuthorizerResponse#jwt_configuration #jwt_configuration} => Types::JWTConfiguration
# * {Types::CreateAuthorizerResponse#name #name} => String
- # * {Types::CreateAuthorizerResponse#provider_arns #provider_arns} => Array<String>
#
# @example Request syntax with placeholder values
#
# resp = client.create_authorizer({
# api_id: "__string", # required
# authorizer_credentials_arn: "Arn",
# authorizer_result_ttl_in_seconds: 1,
- # authorizer_type: "REQUEST", # required, accepts REQUEST
- # authorizer_uri: "UriWithLengthBetween1And2048", # required
+ # authorizer_type: "REQUEST", # required, accepts REQUEST, JWT
+ # authorizer_uri: "UriWithLengthBetween1And2048",
# identity_source: ["__string"], # required
# identity_validation_expression: "StringWithLengthBetween0And1024",
+ # jwt_configuration: {
+ # audience: ["__string"],
+ # issuer: "UriWithLengthBetween1And2048",
+ # },
# name: "StringWithLengthBetween1And128", # required
- # provider_arns: ["Arn"],
# })
#
# @example Response structure
#
# resp.authorizer_credentials_arn #=> String
# resp.authorizer_id #=> String
# resp.authorizer_result_ttl_in_seconds #=> Integer
- # resp.authorizer_type #=> String, one of "REQUEST"
+ # resp.authorizer_type #=> String, one of "REQUEST", "JWT"
# resp.authorizer_uri #=> String
# resp.identity_source #=> Array
# resp.identity_source[0] #=> String
# resp.identity_validation_expression #=> String
+ # resp.jwt_configuration.audience #=> Array
+ # resp.jwt_configuration.audience[0] #=> String
+ # resp.jwt_configuration.issuer #=> String
# resp.name #=> String
- # resp.provider_arns #=> Array
- # resp.provider_arns[0] #=> String
#
# @overload create_authorizer(params = {})
# @param [Hash] params ({})
def create_authorizer(params = {}, options = {})
req = build_request(:create_authorizer, params)
@@ -483,10 +548,11 @@
# @option params [String] :stage_name
# A string with a length between \[1-128\].
#
# @return [Types::CreateDeploymentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
+ # * {Types::CreateDeploymentResponse#auto_deployed #auto_deployed} => Boolean
# * {Types::CreateDeploymentResponse#created_date #created_date} => Time
# * {Types::CreateDeploymentResponse#deployment_id #deployment_id} => String
# * {Types::CreateDeploymentResponse#deployment_status #deployment_status} => String
# * {Types::CreateDeploymentResponse#deployment_status_message #deployment_status_message} => String
# * {Types::CreateDeploymentResponse#description #description} => String
@@ -499,10 +565,11 @@
# stage_name: "StringWithLengthBetween1And128",
# })
#
# @example Response structure
#
+ # resp.auto_deployed #=> Boolean
# resp.created_date #=> Time
# resp.deployment_id #=> String
# resp.deployment_status #=> String, one of "PENDING", "FAILED", "DEPLOYED"
# resp.deployment_status_message #=> String
# resp.description #=> String
@@ -521,12 +588,11 @@
#
# @option params [Array<Types::DomainNameConfiguration>] :domain_name_configurations
# The domain name configurations.
#
# @option params [Hash<String,String>] :tags
- # A key value pair of string with key length between\[1-128\] and value
- # length between\[1-256\]
+ # Represents a collection of tags associated with the resource.
#
# @return [Types::CreateDomainNameResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateDomainNameResponse#api_mapping_selection_expression #api_mapping_selection_expression} => String
# * {Types::CreateDomainNameResponse#domain_name #domain_name} => String
@@ -541,15 +607,15 @@
# {
# api_gateway_domain_name: "__string",
# certificate_arn: "Arn",
# certificate_name: "StringWithLengthBetween1And128",
# certificate_upload_date: Time.now,
+ # domain_name_status: "AVAILABLE", # accepts AVAILABLE, UPDATING
+ # domain_name_status_message: "__string",
# endpoint_type: "REGIONAL", # accepts REGIONAL, EDGE
# hosted_zone_id: "__string",
# security_policy: "TLS_1_0", # accepts TLS_1_0, TLS_1_2
- # domain_name_status: "AVAILABLE", # accepts AVAILABLE, UPDATING
- # domain_name_status_message: "__string",
# },
# ],
# tags: {
# "__string" => "StringWithLengthBetween1And1600",
# },
@@ -562,15 +628,15 @@
# resp.domain_name_configurations #=> Array
# resp.domain_name_configurations[0].api_gateway_domain_name #=> String
# resp.domain_name_configurations[0].certificate_arn #=> String
# resp.domain_name_configurations[0].certificate_name #=> String
# resp.domain_name_configurations[0].certificate_upload_date #=> Time
+ # resp.domain_name_configurations[0].domain_name_status #=> String, one of "AVAILABLE", "UPDATING"
+ # resp.domain_name_configurations[0].domain_name_status_message #=> String
# resp.domain_name_configurations[0].endpoint_type #=> String, one of "REGIONAL", "EDGE"
# resp.domain_name_configurations[0].hosted_zone_id #=> String
# resp.domain_name_configurations[0].security_policy #=> String, one of "TLS_1_0", "TLS_1_2"
- # resp.domain_name_configurations[0].domain_name_status #=> String, one of "AVAILABLE", "UPDATING"
- # resp.domain_name_configurations[0].domain_name_status_message #=> String
# resp.tags #=> Hash
# resp.tags["__string"] #=> String
#
# @overload create_domain_name(params = {})
# @param [Hash] params ({})
@@ -589,10 +655,11 @@
# @option params [String] :connection_type
# Represents a connection type.
#
# @option params [String] :content_handling_strategy
# Specifies how to handle response payload content type conversions.
+ # Supported only for WebSocket APIs.
#
# @option params [String] :credentials_arn
# Represents an Amazon Resource Name (ARN).
#
# @option params [String] :description
@@ -606,12 +673,16 @@
#
# @option params [String] :integration_uri
# A string representation of a URI with a length between \[1-2048\].
#
# @option params [String] :passthrough_behavior
- # Represents passthrough behavior for an integration response.
+ # Represents passthrough behavior for an integration response. Supported
+ # only for WebSocket APIs.
#
+ # @option params [String] :payload_format_version
+ # A string with a length between \[1-64\].
+ #
# @option params [Hash<String,String>] :request_parameters
# A key-value map specifying response parameters that are passed to the
# method response from the backend. The key is a method response header
# parameter name and the mapped value is an integration response header
# value, a static value enclosed within a pair of single quotes, or a
@@ -639,10 +710,11 @@
# @option params [Integer] :timeout_in_millis
# An integer with a value between \[50-29000\].
#
# @return [Types::CreateIntegrationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
+ # * {Types::CreateIntegrationResult#api_gateway_managed #api_gateway_managed} => Boolean
# * {Types::CreateIntegrationResult#connection_id #connection_id} => String
# * {Types::CreateIntegrationResult#connection_type #connection_type} => String
# * {Types::CreateIntegrationResult#content_handling_strategy #content_handling_strategy} => String
# * {Types::CreateIntegrationResult#credentials_arn #credentials_arn} => String
# * {Types::CreateIntegrationResult#description #description} => String
@@ -650,10 +722,11 @@
# * {Types::CreateIntegrationResult#integration_method #integration_method} => String
# * {Types::CreateIntegrationResult#integration_response_selection_expression #integration_response_selection_expression} => String
# * {Types::CreateIntegrationResult#integration_type #integration_type} => String
# * {Types::CreateIntegrationResult#integration_uri #integration_uri} => String
# * {Types::CreateIntegrationResult#passthrough_behavior #passthrough_behavior} => String
+ # * {Types::CreateIntegrationResult#payload_format_version #payload_format_version} => String
# * {Types::CreateIntegrationResult#request_parameters #request_parameters} => Hash<String,String>
# * {Types::CreateIntegrationResult#request_templates #request_templates} => Hash<String,String>
# * {Types::CreateIntegrationResult#template_selection_expression #template_selection_expression} => String
# * {Types::CreateIntegrationResult#timeout_in_millis #timeout_in_millis} => Integer
#
@@ -668,10 +741,11 @@
# description: "StringWithLengthBetween0And1024",
# integration_method: "StringWithLengthBetween1And64",
# integration_type: "AWS", # required, accepts AWS, HTTP, MOCK, HTTP_PROXY, AWS_PROXY
# integration_uri: "UriWithLengthBetween1And2048",
# passthrough_behavior: "WHEN_NO_MATCH", # accepts WHEN_NO_MATCH, NEVER, WHEN_NO_TEMPLATES
+ # payload_format_version: "StringWithLengthBetween1And64",
# request_parameters: {
# "__string" => "StringWithLengthBetween1And512",
# },
# request_templates: {
# "__string" => "StringWithLengthBetween0And32K",
@@ -680,10 +754,11 @@
# timeout_in_millis: 1,
# })
#
# @example Response structure
#
+ # resp.api_gateway_managed #=> Boolean
# resp.connection_id #=> String
# resp.connection_type #=> String, one of "INTERNET", "VPC_LINK"
# resp.content_handling_strategy #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
# resp.credentials_arn #=> String
# resp.description #=> String
@@ -691,10 +766,11 @@
# resp.integration_method #=> String
# resp.integration_response_selection_expression #=> String
# resp.integration_type #=> String, one of "AWS", "HTTP", "MOCK", "HTTP_PROXY", "AWS_PROXY"
# resp.integration_uri #=> String
# resp.passthrough_behavior #=> String, one of "WHEN_NO_MATCH", "NEVER", "WHEN_NO_TEMPLATES"
+ # resp.payload_format_version #=> String
# resp.request_parameters #=> Hash
# resp.request_parameters["__string"] #=> String
# resp.request_templates #=> Hash
# resp.request_templates["__string"] #=> String
# resp.template_selection_expression #=> String
@@ -711,15 +787,16 @@
#
# @option params [required, String] :api_id
#
# @option params [String] :content_handling_strategy
# Specifies how to handle response payload content type conversions.
+ # Supported only for WebSocket APIs.
#
# @option params [required, String] :integration_id
#
# @option params [required, String] :integration_response_key
- # After evaulating a selection expression, the result is compared
+ # After evaluating a selection expression, the result is compared
# against one or more selection keys to find a matching key. See
# [Selection Expressions][1] for a list of expressions and each
# expression's associated selection key type.
#
#
@@ -850,23 +927,23 @@
#
# @option params [Boolean] :api_key_required
#
# @option params [Array<String>] :authorization_scopes
# A list of authorization scopes configured on a route. The scopes are
- # used with a COGNITO\_USER\_POOLS authorizer to authorize the method
- # invocation. The authorization works by matching the route scopes
- # against the scopes parsed from the access token in the incoming
- # request. The method invocation is authorized if any route scope
- # matches a claimed scope in the access token. Otherwise, the invocation
- # is not authorized. When the route scope is configured, the client must
- # provide an access token instead of an identity token for authorization
- # purposes.
+ # used with a JWT authorizer to authorize the method invocation. The
+ # authorization works by matching the route scopes against the scopes
+ # parsed from the access token in the incoming request. The method
+ # invocation is authorized if any route scope matches a claimed scope in
+ # the access token. Otherwise, the invocation is not authorized. When
+ # the route scope is configured, the client must provide an access token
+ # instead of an identity token for authorization purposes.
#
# @option params [String] :authorization_type
- # The authorization type. Valid values are NONE for open access,
- # AWS\_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda
- # authorizer.
+ # The authorization type. For WebSocket APIs, valid values are NONE for
+ # open access, AWS\_IAM for using AWS IAM permissions, and CUSTOM for
+ # using a Lambda authorizer. For HTTP APIs, valid values are NONE for
+ # open access, or JWT for using JSON Web Tokens.
#
# @option params [String] :authorizer_id
# The identifier.
#
# @option params [String] :model_selection_expression
@@ -885,11 +962,11 @@
#
# @option params [Hash<String,Types::ParameterConstraints>] :request_parameters
# The route parameters.
#
# @option params [required, String] :route_key
- # After evaulating a selection expression, the result is compared
+ # After evaluating a selection expression, the result is compared
# against one or more selection keys to find a matching key. See
# [Selection Expressions][1] for a list of expressions and each
# expression's associated selection key type.
#
#
@@ -907,10 +984,11 @@
# @option params [String] :target
# A string with a length between \[1-128\].
#
# @return [Types::CreateRouteResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
+ # * {Types::CreateRouteResult#api_gateway_managed #api_gateway_managed} => Boolean
# * {Types::CreateRouteResult#api_key_required #api_key_required} => Boolean
# * {Types::CreateRouteResult#authorization_scopes #authorization_scopes} => Array<String>
# * {Types::CreateRouteResult#authorization_type #authorization_type} => String
# * {Types::CreateRouteResult#authorizer_id #authorizer_id} => String
# * {Types::CreateRouteResult#model_selection_expression #model_selection_expression} => String
@@ -926,11 +1004,11 @@
#
# resp = client.create_route({
# api_id: "__string", # required
# api_key_required: false,
# authorization_scopes: ["StringWithLengthBetween1And64"],
- # authorization_type: "NONE", # accepts NONE, AWS_IAM, CUSTOM
+ # authorization_type: "NONE", # accepts NONE, AWS_IAM, CUSTOM, JWT
# authorizer_id: "Id",
# model_selection_expression: "SelectionExpression",
# operation_name: "StringWithLengthBetween1And64",
# request_models: {
# "__string" => "StringWithLengthBetween1And128",
@@ -945,14 +1023,15 @@
# target: "StringWithLengthBetween1And128",
# })
#
# @example Response structure
#
+ # resp.api_gateway_managed #=> Boolean
# resp.api_key_required #=> Boolean
# resp.authorization_scopes #=> Array
# resp.authorization_scopes[0] #=> String
- # resp.authorization_type #=> String, one of "NONE", "AWS_IAM", "CUSTOM"
+ # resp.authorization_type #=> String, one of "NONE", "AWS_IAM", "CUSTOM", "JWT"
# resp.authorizer_id #=> String
# resp.model_selection_expression #=> String
# resp.operation_name #=> String
# resp.request_models #=> Hash
# resp.request_models["__string"] #=> String
@@ -989,11 +1068,11 @@
# The route parameters.
#
# @option params [required, String] :route_id
#
# @option params [required, String] :route_response_key
- # After evaulating a selection expression, the result is compared
+ # After evaluating a selection expression, the result is compared
# against one or more selection keys to find a matching key. See
# [Selection Expressions][1] for a list of expressions and each
# expression's associated selection key type.
#
#
@@ -1047,10 +1126,12 @@
# @option params [Types::AccessLogSettings] :access_log_settings
# Settings for logging access in a stage.
#
# @option params [required, String] :api_id
#
+ # @option params [Boolean] :auto_deploy
+ #
# @option params [String] :client_certificate_id
# The identifier.
#
# @option params [Types::RouteSettings] :default_route_settings
# Represents a collection of route settings.
@@ -1069,21 +1150,23 @@
#
# @option params [Hash<String,String>] :stage_variables
# The stage variable map.
#
# @option params [Hash<String,String>] :tags
- # A key value pair of string with key length between\[1-128\] and value
- # length between\[1-256\]
+ # Represents a collection of tags associated with the resource.
#
# @return [Types::CreateStageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateStageResponse#access_log_settings #access_log_settings} => Types::AccessLogSettings
+ # * {Types::CreateStageResponse#api_gateway_managed #api_gateway_managed} => Boolean
+ # * {Types::CreateStageResponse#auto_deploy #auto_deploy} => Boolean
# * {Types::CreateStageResponse#client_certificate_id #client_certificate_id} => String
# * {Types::CreateStageResponse#created_date #created_date} => Time
# * {Types::CreateStageResponse#default_route_settings #default_route_settings} => Types::RouteSettings
# * {Types::CreateStageResponse#deployment_id #deployment_id} => String
# * {Types::CreateStageResponse#description #description} => String
+ # * {Types::CreateStageResponse#last_deployment_status_message #last_deployment_status_message} => String
# * {Types::CreateStageResponse#last_updated_date #last_updated_date} => Time
# * {Types::CreateStageResponse#route_settings #route_settings} => Hash<String,Types::RouteSettings>
# * {Types::CreateStageResponse#stage_name #stage_name} => String
# * {Types::CreateStageResponse#stage_variables #stage_variables} => Hash<String,String>
# * {Types::CreateStageResponse#tags #tags} => Hash<String,String>
@@ -1094,10 +1177,11 @@
# access_log_settings: {
# destination_arn: "Arn",
# format: "StringWithLengthBetween1And1024",
# },
# api_id: "__string", # required
+ # auto_deploy: false,
# client_certificate_id: "Id",
# default_route_settings: {
# data_trace_enabled: false,
# detailed_metrics_enabled: false,
# logging_level: "ERROR", # accepts ERROR, INFO, false
@@ -1126,19 +1210,22 @@
#
# @example Response structure
#
# resp.access_log_settings.destination_arn #=> String
# resp.access_log_settings.format #=> String
+ # resp.api_gateway_managed #=> Boolean
+ # resp.auto_deploy #=> Boolean
# resp.client_certificate_id #=> String
# resp.created_date #=> Time
# resp.default_route_settings.data_trace_enabled #=> Boolean
# resp.default_route_settings.detailed_metrics_enabled #=> Boolean
# resp.default_route_settings.logging_level #=> String, one of "ERROR", "INFO", "false"
# resp.default_route_settings.throttling_burst_limit #=> Integer
# resp.default_route_settings.throttling_rate_limit #=> Float
# resp.deployment_id #=> String
# resp.description #=> String
+ # resp.last_deployment_status_message #=> String
# resp.last_updated_date #=> Time
# resp.route_settings #=> Hash
# resp.route_settings["__string"].data_trace_enabled #=> Boolean
# resp.route_settings["__string"].detailed_metrics_enabled #=> Boolean
# resp.route_settings["__string"].logging_level #=> String, one of "ERROR", "INFO", "false"
@@ -1218,10 +1305,29 @@
def delete_authorizer(params = {}, options = {})
req = build_request(:delete_authorizer, params)
req.send_request(options)
end
+ # Deletes a CORS configuration.
+ #
+ # @option params [required, String] :api_id
+ #
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.delete_cors_configuration({
+ # api_id: "__string", # required
+ # })
+ #
+ # @overload delete_cors_configuration(params = {})
+ # @param [Hash] params ({})
+ def delete_cors_configuration(params = {}, options = {})
+ req = build_request(:delete_cors_configuration, params)
+ req.send_request(options)
+ end
+
# Deletes a Deployment.
#
# @option params [required, String] :api_id
#
# @option params [required, String] :deployment_id
@@ -1375,10 +1481,43 @@
def delete_route_response(params = {}, options = {})
req = build_request(:delete_route_response, params)
req.send_request(options)
end
+ # Deletes the RouteSettings for a stage.
+ #
+ # @option params [required, String] :api_id
+ #
+ # @option params [required, String] :route_key
+ # After evaluating a selection expression, the result is compared
+ # against one or more selection keys to find a matching key. See
+ # [Selection Expressions][1] for a list of expressions and each
+ # expression's associated selection key type.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
+ #
+ # @option params [required, String] :stage_name
+ #
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.delete_route_settings({
+ # api_id: "__string", # required
+ # route_key: "SelectionKey", # required
+ # stage_name: "__string", # required
+ # })
+ #
+ # @overload delete_route_settings(params = {})
+ # @param [Hash] params ({})
+ def delete_route_settings(params = {}, options = {})
+ req = build_request(:delete_route_settings, params)
+ req.send_request(options)
+ end
+
# Deletes a Stage.
#
# @option params [required, String] :api_id
#
# @option params [required, String] :stage_name
@@ -1406,19 +1545,21 @@
# @return [Types::GetApiResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetApiResponse#api_endpoint #api_endpoint} => String
# * {Types::GetApiResponse#api_id #api_id} => String
# * {Types::GetApiResponse#api_key_selection_expression #api_key_selection_expression} => String
+ # * {Types::GetApiResponse#cors_configuration #cors_configuration} => Types::Cors
# * {Types::GetApiResponse#created_date #created_date} => Time
# * {Types::GetApiResponse#description #description} => String
# * {Types::GetApiResponse#disable_schema_validation #disable_schema_validation} => Boolean
+ # * {Types::GetApiResponse#import_info #import_info} => Array<String>
# * {Types::GetApiResponse#name #name} => String
# * {Types::GetApiResponse#protocol_type #protocol_type} => String
# * {Types::GetApiResponse#route_selection_expression #route_selection_expression} => String
+ # * {Types::GetApiResponse#tags #tags} => Hash<String,String>
# * {Types::GetApiResponse#version #version} => String
# * {Types::GetApiResponse#warnings #warnings} => Array<String>
- # * {Types::GetApiResponse#tags #tags} => Hash<String,String>
#
# @example Request syntax with placeholder values
#
# resp = client.get_api({
# api_id: "__string", # required
@@ -1427,30 +1568,42 @@
# @example Response structure
#
# resp.api_endpoint #=> String
# resp.api_id #=> String
# resp.api_key_selection_expression #=> String
+ # resp.cors_configuration.allow_credentials #=> Boolean
+ # resp.cors_configuration.allow_headers #=> Array
+ # resp.cors_configuration.allow_headers[0] #=> String
+ # resp.cors_configuration.allow_methods #=> Array
+ # resp.cors_configuration.allow_methods[0] #=> String
+ # resp.cors_configuration.allow_origins #=> Array
+ # resp.cors_configuration.allow_origins[0] #=> String
+ # resp.cors_configuration.expose_headers #=> Array
+ # resp.cors_configuration.expose_headers[0] #=> String
+ # resp.cors_configuration.max_age #=> Integer
# resp.created_date #=> Time
# resp.description #=> String
# resp.disable_schema_validation #=> Boolean
+ # resp.import_info #=> Array
+ # resp.import_info[0] #=> String
# resp.name #=> String
- # resp.protocol_type #=> String, one of "WEBSOCKET"
+ # resp.protocol_type #=> String, one of "WEBSOCKET", "HTTP"
# resp.route_selection_expression #=> String
+ # resp.tags #=> Hash
+ # resp.tags["__string"] #=> String
# resp.version #=> String
# resp.warnings #=> Array
# resp.warnings[0] #=> String
- # resp.tags #=> Hash
- # resp.tags["__string"] #=> String
#
# @overload get_api(params = {})
# @param [Hash] params ({})
def get_api(params = {}, options = {})
req = build_request(:get_api, params)
req.send_request(options)
end
- # The API mapping.
+ # Gets an API mapping.
#
# @option params [required, String] :api_mapping_id
#
# @option params [required, String] :domain_name
#
@@ -1480,11 +1633,11 @@
def get_api_mapping(params = {}, options = {})
req = build_request(:get_api_mapping, params)
req.send_request(options)
end
- # The API mappings.
+ # Gets API mappings.
#
# @option params [required, String] :domain_name
#
# @option params [String] :max_results
#
@@ -1541,21 +1694,33 @@
#
# resp.items #=> Array
# resp.items[0].api_endpoint #=> String
# resp.items[0].api_id #=> String
# resp.items[0].api_key_selection_expression #=> String
+ # resp.items[0].cors_configuration.allow_credentials #=> Boolean
+ # resp.items[0].cors_configuration.allow_headers #=> Array
+ # resp.items[0].cors_configuration.allow_headers[0] #=> String
+ # resp.items[0].cors_configuration.allow_methods #=> Array
+ # resp.items[0].cors_configuration.allow_methods[0] #=> String
+ # resp.items[0].cors_configuration.allow_origins #=> Array
+ # resp.items[0].cors_configuration.allow_origins[0] #=> String
+ # resp.items[0].cors_configuration.expose_headers #=> Array
+ # resp.items[0].cors_configuration.expose_headers[0] #=> String
+ # resp.items[0].cors_configuration.max_age #=> Integer
# resp.items[0].created_date #=> Time
# resp.items[0].description #=> String
# resp.items[0].disable_schema_validation #=> Boolean
+ # resp.items[0].import_info #=> Array
+ # resp.items[0].import_info[0] #=> String
# resp.items[0].name #=> String
- # resp.items[0].protocol_type #=> String, one of "WEBSOCKET"
+ # resp.items[0].protocol_type #=> String, one of "WEBSOCKET", "HTTP"
# resp.items[0].route_selection_expression #=> String
+ # resp.items[0].tags #=> Hash
+ # resp.items[0].tags["__string"] #=> String
# resp.items[0].version #=> String
# resp.items[0].warnings #=> Array
# resp.items[0].warnings[0] #=> String
- # resp.items[0].tags #=> Hash
- # resp.items[0].tags["__string"] #=> String
# resp.next_token #=> String
#
# @overload get_apis(params = {})
# @param [Hash] params ({})
def get_apis(params = {}, options = {})
@@ -1576,12 +1741,12 @@
# * {Types::GetAuthorizerResponse#authorizer_result_ttl_in_seconds #authorizer_result_ttl_in_seconds} => Integer
# * {Types::GetAuthorizerResponse#authorizer_type #authorizer_type} => String
# * {Types::GetAuthorizerResponse#authorizer_uri #authorizer_uri} => String
# * {Types::GetAuthorizerResponse#identity_source #identity_source} => Array<String>
# * {Types::GetAuthorizerResponse#identity_validation_expression #identity_validation_expression} => String
+ # * {Types::GetAuthorizerResponse#jwt_configuration #jwt_configuration} => Types::JWTConfiguration
# * {Types::GetAuthorizerResponse#name #name} => String
- # * {Types::GetAuthorizerResponse#provider_arns #provider_arns} => Array<String>
#
# @example Request syntax with placeholder values
#
# resp = client.get_authorizer({
# api_id: "__string", # required
@@ -1591,18 +1756,19 @@
# @example Response structure
#
# resp.authorizer_credentials_arn #=> String
# resp.authorizer_id #=> String
# resp.authorizer_result_ttl_in_seconds #=> Integer
- # resp.authorizer_type #=> String, one of "REQUEST"
+ # resp.authorizer_type #=> String, one of "REQUEST", "JWT"
# resp.authorizer_uri #=> String
# resp.identity_source #=> Array
# resp.identity_source[0] #=> String
# resp.identity_validation_expression #=> String
+ # resp.jwt_configuration.audience #=> Array
+ # resp.jwt_configuration.audience[0] #=> String
+ # resp.jwt_configuration.issuer #=> String
# resp.name #=> String
- # resp.provider_arns #=> Array
- # resp.provider_arns[0] #=> String
#
# @overload get_authorizer(params = {})
# @param [Hash] params ({})
def get_authorizer(params = {}, options = {})
req = build_request(:get_authorizer, params)
@@ -1634,18 +1800,19 @@
#
# resp.items #=> Array
# resp.items[0].authorizer_credentials_arn #=> String
# resp.items[0].authorizer_id #=> String
# resp.items[0].authorizer_result_ttl_in_seconds #=> Integer
- # resp.items[0].authorizer_type #=> String, one of "REQUEST"
+ # resp.items[0].authorizer_type #=> String, one of "REQUEST", "JWT"
# resp.items[0].authorizer_uri #=> String
# resp.items[0].identity_source #=> Array
# resp.items[0].identity_source[0] #=> String
# resp.items[0].identity_validation_expression #=> String
+ # resp.items[0].jwt_configuration.audience #=> Array
+ # resp.items[0].jwt_configuration.audience[0] #=> String
+ # resp.items[0].jwt_configuration.issuer #=> String
# resp.items[0].name #=> String
- # resp.items[0].provider_arns #=> Array
- # resp.items[0].provider_arns[0] #=> String
# resp.next_token #=> String
#
# @overload get_authorizers(params = {})
# @param [Hash] params ({})
def get_authorizers(params = {}, options = {})
@@ -1659,10 +1826,11 @@
#
# @option params [required, String] :deployment_id
#
# @return [Types::GetDeploymentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
+ # * {Types::GetDeploymentResponse#auto_deployed #auto_deployed} => Boolean
# * {Types::GetDeploymentResponse#created_date #created_date} => Time
# * {Types::GetDeploymentResponse#deployment_id #deployment_id} => String
# * {Types::GetDeploymentResponse#deployment_status #deployment_status} => String
# * {Types::GetDeploymentResponse#deployment_status_message #deployment_status_message} => String
# * {Types::GetDeploymentResponse#description #description} => String
@@ -1674,10 +1842,11 @@
# deployment_id: "__string", # required
# })
#
# @example Response structure
#
+ # resp.auto_deployed #=> Boolean
# resp.created_date #=> Time
# resp.deployment_id #=> String
# resp.deployment_status #=> String, one of "PENDING", "FAILED", "DEPLOYED"
# resp.deployment_status_message #=> String
# resp.description #=> String
@@ -1711,10 +1880,11 @@
# })
#
# @example Response structure
#
# resp.items #=> Array
+ # resp.items[0].auto_deployed #=> Boolean
# resp.items[0].created_date #=> Time
# resp.items[0].deployment_id #=> String
# resp.items[0].deployment_status #=> String, one of "PENDING", "FAILED", "DEPLOYED"
# resp.items[0].deployment_status_message #=> String
# resp.items[0].description #=> String
@@ -1751,15 +1921,15 @@
# resp.domain_name_configurations #=> Array
# resp.domain_name_configurations[0].api_gateway_domain_name #=> String
# resp.domain_name_configurations[0].certificate_arn #=> String
# resp.domain_name_configurations[0].certificate_name #=> String
# resp.domain_name_configurations[0].certificate_upload_date #=> Time
+ # resp.domain_name_configurations[0].domain_name_status #=> String, one of "AVAILABLE", "UPDATING"
+ # resp.domain_name_configurations[0].domain_name_status_message #=> String
# resp.domain_name_configurations[0].endpoint_type #=> String, one of "REGIONAL", "EDGE"
# resp.domain_name_configurations[0].hosted_zone_id #=> String
# resp.domain_name_configurations[0].security_policy #=> String, one of "TLS_1_0", "TLS_1_2"
- # resp.domain_name_configurations[0].domain_name_status #=> String, one of "AVAILABLE", "UPDATING"
- # resp.domain_name_configurations[0].domain_name_status_message #=> String
# resp.tags #=> Hash
# resp.tags["__string"] #=> String
#
# @overload get_domain_name(params = {})
# @param [Hash] params ({})
@@ -1794,15 +1964,15 @@
# resp.items[0].domain_name_configurations #=> Array
# resp.items[0].domain_name_configurations[0].api_gateway_domain_name #=> String
# resp.items[0].domain_name_configurations[0].certificate_arn #=> String
# resp.items[0].domain_name_configurations[0].certificate_name #=> String
# resp.items[0].domain_name_configurations[0].certificate_upload_date #=> Time
+ # resp.items[0].domain_name_configurations[0].domain_name_status #=> String, one of "AVAILABLE", "UPDATING"
+ # resp.items[0].domain_name_configurations[0].domain_name_status_message #=> String
# resp.items[0].domain_name_configurations[0].endpoint_type #=> String, one of "REGIONAL", "EDGE"
# resp.items[0].domain_name_configurations[0].hosted_zone_id #=> String
# resp.items[0].domain_name_configurations[0].security_policy #=> String, one of "TLS_1_0", "TLS_1_2"
- # resp.items[0].domain_name_configurations[0].domain_name_status #=> String, one of "AVAILABLE", "UPDATING"
- # resp.items[0].domain_name_configurations[0].domain_name_status_message #=> String
# resp.items[0].tags #=> Hash
# resp.items[0].tags["__string"] #=> String
# resp.next_token #=> String
#
# @overload get_domain_names(params = {})
@@ -1818,10 +1988,11 @@
#
# @option params [required, String] :integration_id
#
# @return [Types::GetIntegrationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
+ # * {Types::GetIntegrationResult#api_gateway_managed #api_gateway_managed} => Boolean
# * {Types::GetIntegrationResult#connection_id #connection_id} => String
# * {Types::GetIntegrationResult#connection_type #connection_type} => String
# * {Types::GetIntegrationResult#content_handling_strategy #content_handling_strategy} => String
# * {Types::GetIntegrationResult#credentials_arn #credentials_arn} => String
# * {Types::GetIntegrationResult#description #description} => String
@@ -1829,10 +2000,11 @@
# * {Types::GetIntegrationResult#integration_method #integration_method} => String
# * {Types::GetIntegrationResult#integration_response_selection_expression #integration_response_selection_expression} => String
# * {Types::GetIntegrationResult#integration_type #integration_type} => String
# * {Types::GetIntegrationResult#integration_uri #integration_uri} => String
# * {Types::GetIntegrationResult#passthrough_behavior #passthrough_behavior} => String
+ # * {Types::GetIntegrationResult#payload_format_version #payload_format_version} => String
# * {Types::GetIntegrationResult#request_parameters #request_parameters} => Hash<String,String>
# * {Types::GetIntegrationResult#request_templates #request_templates} => Hash<String,String>
# * {Types::GetIntegrationResult#template_selection_expression #template_selection_expression} => String
# * {Types::GetIntegrationResult#timeout_in_millis #timeout_in_millis} => Integer
#
@@ -1843,10 +2015,11 @@
# integration_id: "__string", # required
# })
#
# @example Response structure
#
+ # resp.api_gateway_managed #=> Boolean
# resp.connection_id #=> String
# resp.connection_type #=> String, one of "INTERNET", "VPC_LINK"
# resp.content_handling_strategy #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
# resp.credentials_arn #=> String
# resp.description #=> String
@@ -1854,10 +2027,11 @@
# resp.integration_method #=> String
# resp.integration_response_selection_expression #=> String
# resp.integration_type #=> String, one of "AWS", "HTTP", "MOCK", "HTTP_PROXY", "AWS_PROXY"
# resp.integration_uri #=> String
# resp.passthrough_behavior #=> String, one of "WHEN_NO_MATCH", "NEVER", "WHEN_NO_TEMPLATES"
+ # resp.payload_format_version #=> String
# resp.request_parameters #=> Hash
# resp.request_parameters["__string"] #=> String
# resp.request_templates #=> Hash
# resp.request_templates["__string"] #=> String
# resp.template_selection_expression #=> String
@@ -1979,10 +2153,11 @@
# })
#
# @example Response structure
#
# resp.items #=> Array
+ # resp.items[0].api_gateway_managed #=> Boolean
# resp.items[0].connection_id #=> String
# resp.items[0].connection_type #=> String, one of "INTERNET", "VPC_LINK"
# resp.items[0].content_handling_strategy #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
# resp.items[0].credentials_arn #=> String
# resp.items[0].description #=> String
@@ -1990,10 +2165,11 @@
# resp.items[0].integration_method #=> String
# resp.items[0].integration_response_selection_expression #=> String
# resp.items[0].integration_type #=> String, one of "AWS", "HTTP", "MOCK", "HTTP_PROXY", "AWS_PROXY"
# resp.items[0].integration_uri #=> String
# resp.items[0].passthrough_behavior #=> String, one of "WHEN_NO_MATCH", "NEVER", "WHEN_NO_TEMPLATES"
+ # resp.items[0].payload_format_version #=> String
# resp.items[0].request_parameters #=> Hash
# resp.items[0].request_parameters["__string"] #=> String
# resp.items[0].request_templates #=> Hash
# resp.items[0].request_templates["__string"] #=> String
# resp.items[0].template_selection_expression #=> String
@@ -2115,10 +2291,11 @@
#
# @option params [required, String] :route_id
#
# @return [Types::GetRouteResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
+ # * {Types::GetRouteResult#api_gateway_managed #api_gateway_managed} => Boolean
# * {Types::GetRouteResult#api_key_required #api_key_required} => Boolean
# * {Types::GetRouteResult#authorization_scopes #authorization_scopes} => Array<String>
# * {Types::GetRouteResult#authorization_type #authorization_type} => String
# * {Types::GetRouteResult#authorizer_id #authorizer_id} => String
# * {Types::GetRouteResult#model_selection_expression #model_selection_expression} => String
@@ -2137,14 +2314,15 @@
# route_id: "__string", # required
# })
#
# @example Response structure
#
+ # resp.api_gateway_managed #=> Boolean
# resp.api_key_required #=> Boolean
# resp.authorization_scopes #=> Array
# resp.authorization_scopes[0] #=> String
- # resp.authorization_type #=> String, one of "NONE", "AWS_IAM", "CUSTOM"
+ # resp.authorization_type #=> String, one of "NONE", "AWS_IAM", "CUSTOM", "JWT"
# resp.authorizer_id #=> String
# resp.model_selection_expression #=> String
# resp.operation_name #=> String
# resp.request_models #=> Hash
# resp.request_models["__string"] #=> String
@@ -2268,14 +2446,15 @@
# })
#
# @example Response structure
#
# resp.items #=> Array
+ # resp.items[0].api_gateway_managed #=> Boolean
# resp.items[0].api_key_required #=> Boolean
# resp.items[0].authorization_scopes #=> Array
# resp.items[0].authorization_scopes[0] #=> String
- # resp.items[0].authorization_type #=> String, one of "NONE", "AWS_IAM", "CUSTOM"
+ # resp.items[0].authorization_type #=> String, one of "NONE", "AWS_IAM", "CUSTOM", "JWT"
# resp.items[0].authorizer_id #=> String
# resp.items[0].model_selection_expression #=> String
# resp.items[0].operation_name #=> String
# resp.items[0].request_models #=> Hash
# resp.items[0].request_models["__string"] #=> String
@@ -2301,15 +2480,18 @@
# @option params [required, String] :stage_name
#
# @return [Types::GetStageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetStageResponse#access_log_settings #access_log_settings} => Types::AccessLogSettings
+ # * {Types::GetStageResponse#api_gateway_managed #api_gateway_managed} => Boolean
+ # * {Types::GetStageResponse#auto_deploy #auto_deploy} => Boolean
# * {Types::GetStageResponse#client_certificate_id #client_certificate_id} => String
# * {Types::GetStageResponse#created_date #created_date} => Time
# * {Types::GetStageResponse#default_route_settings #default_route_settings} => Types::RouteSettings
# * {Types::GetStageResponse#deployment_id #deployment_id} => String
# * {Types::GetStageResponse#description #description} => String
+ # * {Types::GetStageResponse#last_deployment_status_message #last_deployment_status_message} => String
# * {Types::GetStageResponse#last_updated_date #last_updated_date} => Time
# * {Types::GetStageResponse#route_settings #route_settings} => Hash<String,Types::RouteSettings>
# * {Types::GetStageResponse#stage_name #stage_name} => String
# * {Types::GetStageResponse#stage_variables #stage_variables} => Hash<String,String>
# * {Types::GetStageResponse#tags #tags} => Hash<String,String>
@@ -2323,19 +2505,22 @@
#
# @example Response structure
#
# resp.access_log_settings.destination_arn #=> String
# resp.access_log_settings.format #=> String
+ # resp.api_gateway_managed #=> Boolean
+ # resp.auto_deploy #=> Boolean
# resp.client_certificate_id #=> String
# resp.created_date #=> Time
# resp.default_route_settings.data_trace_enabled #=> Boolean
# resp.default_route_settings.detailed_metrics_enabled #=> Boolean
# resp.default_route_settings.logging_level #=> String, one of "ERROR", "INFO", "false"
# resp.default_route_settings.throttling_burst_limit #=> Integer
# resp.default_route_settings.throttling_rate_limit #=> Float
# resp.deployment_id #=> String
# resp.description #=> String
+ # resp.last_deployment_status_message #=> String
# resp.last_updated_date #=> Time
# resp.route_settings #=> Hash
# resp.route_settings["__string"].data_trace_enabled #=> Boolean
# resp.route_settings["__string"].detailed_metrics_enabled #=> Boolean
# resp.route_settings["__string"].logging_level #=> String, one of "ERROR", "INFO", "false"
@@ -2378,19 +2563,22 @@
# @example Response structure
#
# resp.items #=> Array
# resp.items[0].access_log_settings.destination_arn #=> String
# resp.items[0].access_log_settings.format #=> String
+ # resp.items[0].api_gateway_managed #=> Boolean
+ # resp.items[0].auto_deploy #=> Boolean
# resp.items[0].client_certificate_id #=> String
# resp.items[0].created_date #=> Time
# resp.items[0].default_route_settings.data_trace_enabled #=> Boolean
# resp.items[0].default_route_settings.detailed_metrics_enabled #=> Boolean
# resp.items[0].default_route_settings.logging_level #=> String, one of "ERROR", "INFO", "false"
# resp.items[0].default_route_settings.throttling_burst_limit #=> Integer
# resp.items[0].default_route_settings.throttling_rate_limit #=> Float
# resp.items[0].deployment_id #=> String
# resp.items[0].description #=> String
+ # resp.items[0].last_deployment_status_message #=> String
# resp.items[0].last_updated_date #=> Time
# resp.items[0].route_settings #=> Hash
# resp.items[0].route_settings["__string"].data_trace_enabled #=> Boolean
# resp.items[0].route_settings["__string"].detailed_metrics_enabled #=> Boolean
# resp.items[0].route_settings["__string"].logging_level #=> String, one of "ERROR", "INFO", "false"
@@ -2408,11 +2596,11 @@
def get_stages(params = {}, options = {})
req = build_request(:get_stages, params)
req.send_request(options)
end
- # Gets the Tags for a resource.
+ # Gets a collection of Tag resources.
#
# @option params [required, String] :resource_arn
#
# @return [Types::GetTagsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
@@ -2434,15 +2622,157 @@
def get_tags(params = {}, options = {})
req = build_request(:get_tags, params)
req.send_request(options)
end
+ # Imports an API.
+ #
+ # @option params [String] :basepath
+ #
+ # @option params [required, String] :body
+ #
+ # @option params [Boolean] :fail_on_warnings
+ #
+ # @return [Types::ImportApiResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::ImportApiResponse#api_endpoint #api_endpoint} => String
+ # * {Types::ImportApiResponse#api_id #api_id} => String
+ # * {Types::ImportApiResponse#api_key_selection_expression #api_key_selection_expression} => String
+ # * {Types::ImportApiResponse#cors_configuration #cors_configuration} => Types::Cors
+ # * {Types::ImportApiResponse#created_date #created_date} => Time
+ # * {Types::ImportApiResponse#description #description} => String
+ # * {Types::ImportApiResponse#disable_schema_validation #disable_schema_validation} => Boolean
+ # * {Types::ImportApiResponse#import_info #import_info} => Array<String>
+ # * {Types::ImportApiResponse#name #name} => String
+ # * {Types::ImportApiResponse#protocol_type #protocol_type} => String
+ # * {Types::ImportApiResponse#route_selection_expression #route_selection_expression} => String
+ # * {Types::ImportApiResponse#tags #tags} => Hash<String,String>
+ # * {Types::ImportApiResponse#version #version} => String
+ # * {Types::ImportApiResponse#warnings #warnings} => Array<String>
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.import_api({
+ # basepath: "__string",
+ # body: "__string", # required
+ # fail_on_warnings: false,
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.api_endpoint #=> String
+ # resp.api_id #=> String
+ # resp.api_key_selection_expression #=> String
+ # resp.cors_configuration.allow_credentials #=> Boolean
+ # resp.cors_configuration.allow_headers #=> Array
+ # resp.cors_configuration.allow_headers[0] #=> String
+ # resp.cors_configuration.allow_methods #=> Array
+ # resp.cors_configuration.allow_methods[0] #=> String
+ # resp.cors_configuration.allow_origins #=> Array
+ # resp.cors_configuration.allow_origins[0] #=> String
+ # resp.cors_configuration.expose_headers #=> Array
+ # resp.cors_configuration.expose_headers[0] #=> String
+ # resp.cors_configuration.max_age #=> Integer
+ # resp.created_date #=> Time
+ # resp.description #=> String
+ # resp.disable_schema_validation #=> Boolean
+ # resp.import_info #=> Array
+ # resp.import_info[0] #=> String
+ # resp.name #=> String
+ # resp.protocol_type #=> String, one of "WEBSOCKET", "HTTP"
+ # resp.route_selection_expression #=> String
+ # resp.tags #=> Hash
+ # resp.tags["__string"] #=> String
+ # resp.version #=> String
+ # resp.warnings #=> Array
+ # resp.warnings[0] #=> String
+ #
+ # @overload import_api(params = {})
+ # @param [Hash] params ({})
+ def import_api(params = {}, options = {})
+ req = build_request(:import_api, params)
+ req.send_request(options)
+ end
+
+ # Puts an Api resource.
+ #
+ # @option params [required, String] :api_id
+ #
+ # @option params [String] :basepath
+ #
+ # @option params [required, String] :body
+ #
+ # @option params [Boolean] :fail_on_warnings
+ #
+ # @return [Types::ReimportApiResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::ReimportApiResponse#api_endpoint #api_endpoint} => String
+ # * {Types::ReimportApiResponse#api_id #api_id} => String
+ # * {Types::ReimportApiResponse#api_key_selection_expression #api_key_selection_expression} => String
+ # * {Types::ReimportApiResponse#cors_configuration #cors_configuration} => Types::Cors
+ # * {Types::ReimportApiResponse#created_date #created_date} => Time
+ # * {Types::ReimportApiResponse#description #description} => String
+ # * {Types::ReimportApiResponse#disable_schema_validation #disable_schema_validation} => Boolean
+ # * {Types::ReimportApiResponse#import_info #import_info} => Array<String>
+ # * {Types::ReimportApiResponse#name #name} => String
+ # * {Types::ReimportApiResponse#protocol_type #protocol_type} => String
+ # * {Types::ReimportApiResponse#route_selection_expression #route_selection_expression} => String
+ # * {Types::ReimportApiResponse#tags #tags} => Hash<String,String>
+ # * {Types::ReimportApiResponse#version #version} => String
+ # * {Types::ReimportApiResponse#warnings #warnings} => Array<String>
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.reimport_api({
+ # api_id: "__string", # required
+ # basepath: "__string",
+ # body: "__string", # required
+ # fail_on_warnings: false,
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.api_endpoint #=> String
+ # resp.api_id #=> String
+ # resp.api_key_selection_expression #=> String
+ # resp.cors_configuration.allow_credentials #=> Boolean
+ # resp.cors_configuration.allow_headers #=> Array
+ # resp.cors_configuration.allow_headers[0] #=> String
+ # resp.cors_configuration.allow_methods #=> Array
+ # resp.cors_configuration.allow_methods[0] #=> String
+ # resp.cors_configuration.allow_origins #=> Array
+ # resp.cors_configuration.allow_origins[0] #=> String
+ # resp.cors_configuration.expose_headers #=> Array
+ # resp.cors_configuration.expose_headers[0] #=> String
+ # resp.cors_configuration.max_age #=> Integer
+ # resp.created_date #=> Time
+ # resp.description #=> String
+ # resp.disable_schema_validation #=> Boolean
+ # resp.import_info #=> Array
+ # resp.import_info[0] #=> String
+ # resp.name #=> String
+ # resp.protocol_type #=> String, one of "WEBSOCKET", "HTTP"
+ # resp.route_selection_expression #=> String
+ # resp.tags #=> Hash
+ # resp.tags["__string"] #=> String
+ # resp.version #=> String
+ # resp.warnings #=> Array
+ # resp.warnings[0] #=> String
+ #
+ # @overload reimport_api(params = {})
+ # @param [Hash] params ({})
+ def reimport_api(params = {}, options = {})
+ req = build_request(:reimport_api, params)
+ req.send_request(options)
+ end
+
+ # Creates a new Tag resource to represent a tag.
+ #
# @option params [required, String] :resource_arn
#
# @option params [Hash<String,String>] :tags
- # A key value pair of string with key length between\[1-128\] and value
- # length between\[1-256\]
+ # Represents a collection of tags associated with the resource.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
@@ -2458,10 +2788,12 @@
def tag_resource(params = {}, options = {})
req = build_request(:tag_resource, params)
req.send_request(options)
end
+ # Deletes a Tag.
+ #
# @option params [required, String] :resource_arn
#
# @option params [required, Array<String>] :tag_keys
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
@@ -2490,72 +2822,121 @@
#
#
#
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
#
+ # @option params [Types::Cors] :cors_configuration
+ # Represents a CORS configuration. Supported only for HTTP APIs. See
+ # [Configuring CORS][1] for more information.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html
+ #
+ # @option params [String] :credentials_arn
+ # Represents an Amazon Resource Name (ARN).
+ #
# @option params [String] :description
# A string with a length between \[0-1024\].
#
# @option params [Boolean] :disable_schema_validation
#
# @option params [String] :name
# A string with a length between \[1-128\].
#
+ # @option params [String] :route_key
+ # After evaluating a selection expression, the result is compared
+ # against one or more selection keys to find a matching key. See
+ # [Selection Expressions][1] for a list of expressions and each
+ # expression's associated selection key type.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
+ #
# @option params [String] :route_selection_expression
# An expression used to extract information at runtime. See [Selection
# Expressions][1] for more information.
#
#
#
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
#
+ # @option params [String] :target
+ # A string representation of a URI with a length between \[1-2048\].
+ #
# @option params [String] :version
# A string with a length between \[1-64\].
#
# @return [Types::UpdateApiResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateApiResponse#api_endpoint #api_endpoint} => String
# * {Types::UpdateApiResponse#api_id #api_id} => String
# * {Types::UpdateApiResponse#api_key_selection_expression #api_key_selection_expression} => String
+ # * {Types::UpdateApiResponse#cors_configuration #cors_configuration} => Types::Cors
# * {Types::UpdateApiResponse#created_date #created_date} => Time
# * {Types::UpdateApiResponse#description #description} => String
# * {Types::UpdateApiResponse#disable_schema_validation #disable_schema_validation} => Boolean
+ # * {Types::UpdateApiResponse#import_info #import_info} => Array<String>
# * {Types::UpdateApiResponse#name #name} => String
# * {Types::UpdateApiResponse#protocol_type #protocol_type} => String
# * {Types::UpdateApiResponse#route_selection_expression #route_selection_expression} => String
+ # * {Types::UpdateApiResponse#tags #tags} => Hash<String,String>
# * {Types::UpdateApiResponse#version #version} => String
# * {Types::UpdateApiResponse#warnings #warnings} => Array<String>
- # * {Types::UpdateApiResponse#tags #tags} => Hash<String,String>
#
# @example Request syntax with placeholder values
#
# resp = client.update_api({
# api_id: "__string", # required
# api_key_selection_expression: "SelectionExpression",
+ # cors_configuration: {
+ # allow_credentials: false,
+ # allow_headers: ["__string"],
+ # allow_methods: ["StringWithLengthBetween1And64"],
+ # allow_origins: ["__string"],
+ # expose_headers: ["__string"],
+ # max_age: 1,
+ # },
+ # credentials_arn: "Arn",
# description: "StringWithLengthBetween0And1024",
# disable_schema_validation: false,
# name: "StringWithLengthBetween1And128",
+ # route_key: "SelectionKey",
# route_selection_expression: "SelectionExpression",
+ # target: "UriWithLengthBetween1And2048",
# version: "StringWithLengthBetween1And64",
# })
#
# @example Response structure
#
# resp.api_endpoint #=> String
# resp.api_id #=> String
# resp.api_key_selection_expression #=> String
+ # resp.cors_configuration.allow_credentials #=> Boolean
+ # resp.cors_configuration.allow_headers #=> Array
+ # resp.cors_configuration.allow_headers[0] #=> String
+ # resp.cors_configuration.allow_methods #=> Array
+ # resp.cors_configuration.allow_methods[0] #=> String
+ # resp.cors_configuration.allow_origins #=> Array
+ # resp.cors_configuration.allow_origins[0] #=> String
+ # resp.cors_configuration.expose_headers #=> Array
+ # resp.cors_configuration.expose_headers[0] #=> String
+ # resp.cors_configuration.max_age #=> Integer
# resp.created_date #=> Time
# resp.description #=> String
# resp.disable_schema_validation #=> Boolean
+ # resp.import_info #=> Array
+ # resp.import_info[0] #=> String
# resp.name #=> String
- # resp.protocol_type #=> String, one of "WEBSOCKET"
+ # resp.protocol_type #=> String, one of "WEBSOCKET", "HTTP"
# resp.route_selection_expression #=> String
+ # resp.tags #=> Hash
+ # resp.tags["__string"] #=> String
# resp.version #=> String
# resp.warnings #=> Array
# resp.warnings[0] #=> String
- # resp.tags #=> Hash
- # resp.tags["__string"] #=> String
#
# @overload update_api(params = {})
# @param [Hash] params ({})
def update_api(params = {}, options = {})
req = build_request(:update_api, params)
@@ -2568,11 +2949,11 @@
# The identifier.
#
# @option params [required, String] :api_mapping_id
#
# @option params [String] :api_mapping_key
- # After evaulating a selection expression, the result is compared
+ # After evaluating a selection expression, the result is compared
# against one or more selection keys to find a matching key. See
# [Selection Expressions][1] for a list of expressions and each
# expression's associated selection key type.
#
#
@@ -2626,12 +3007,13 @@
#
# @option params [Integer] :authorizer_result_ttl_in_seconds
# An integer with a value between \[0-3600\].
#
# @option params [String] :authorizer_type
- # The authorizer type. Currently the only valid value is REQUEST, for a
- # Lambda function using incoming request parameters.
+ # The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda
+ # function using incoming request parameters. For HTTP APIs, specify JWT
+ # to use JSON Web Tokens.
#
# @option params [String] :authorizer_uri
# A string representation of a URI with a length between \[1-2048\].
#
# @option params [Array<String>] :identity_source
@@ -2652,56 +3034,61 @@
# authorization caching is not enabled, this property is optional.
#
# @option params [String] :identity_validation_expression
# A string with a length between \[0-1024\].
#
+ # @option params [Types::JWTConfiguration] :jwt_configuration
+ # Represents the configuration of a JWT authorizer. Required for the JWT
+ # authorizer type. Supported only for HTTP APIs.
+ #
# @option params [String] :name
# A string with a length between \[1-128\].
#
- # @option params [Array<String>] :provider_arns
- # For REQUEST authorizer, this is not defined.
- #
# @return [Types::UpdateAuthorizerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateAuthorizerResponse#authorizer_credentials_arn #authorizer_credentials_arn} => String
# * {Types::UpdateAuthorizerResponse#authorizer_id #authorizer_id} => String
# * {Types::UpdateAuthorizerResponse#authorizer_result_ttl_in_seconds #authorizer_result_ttl_in_seconds} => Integer
# * {Types::UpdateAuthorizerResponse#authorizer_type #authorizer_type} => String
# * {Types::UpdateAuthorizerResponse#authorizer_uri #authorizer_uri} => String
# * {Types::UpdateAuthorizerResponse#identity_source #identity_source} => Array<String>
# * {Types::UpdateAuthorizerResponse#identity_validation_expression #identity_validation_expression} => String
+ # * {Types::UpdateAuthorizerResponse#jwt_configuration #jwt_configuration} => Types::JWTConfiguration
# * {Types::UpdateAuthorizerResponse#name #name} => String
- # * {Types::UpdateAuthorizerResponse#provider_arns #provider_arns} => Array<String>
#
# @example Request syntax with placeholder values
#
# resp = client.update_authorizer({
# api_id: "__string", # required
# authorizer_credentials_arn: "Arn",
# authorizer_id: "__string", # required
# authorizer_result_ttl_in_seconds: 1,
- # authorizer_type: "REQUEST", # accepts REQUEST
+ # authorizer_type: "REQUEST", # accepts REQUEST, JWT
# authorizer_uri: "UriWithLengthBetween1And2048",
# identity_source: ["__string"],
# identity_validation_expression: "StringWithLengthBetween0And1024",
+ # jwt_configuration: {
+ # audience: ["__string"],
+ # issuer: "UriWithLengthBetween1And2048",
+ # },
# name: "StringWithLengthBetween1And128",
- # provider_arns: ["Arn"],
# })
#
# @example Response structure
#
# resp.authorizer_credentials_arn #=> String
# resp.authorizer_id #=> String
# resp.authorizer_result_ttl_in_seconds #=> Integer
- # resp.authorizer_type #=> String, one of "REQUEST"
+ # resp.authorizer_type #=> String, one of "REQUEST", "JWT"
# resp.authorizer_uri #=> String
# resp.identity_source #=> Array
# resp.identity_source[0] #=> String
# resp.identity_validation_expression #=> String
+ # resp.jwt_configuration.audience #=> Array
+ # resp.jwt_configuration.audience[0] #=> String
+ # resp.jwt_configuration.issuer #=> String
# resp.name #=> String
- # resp.provider_arns #=> Array
- # resp.provider_arns[0] #=> String
#
# @overload update_authorizer(params = {})
# @param [Hash] params ({})
def update_authorizer(params = {}, options = {})
req = build_request(:update_authorizer, params)
@@ -2717,10 +3104,11 @@
# @option params [String] :description
# A string with a length between \[0-1024\].
#
# @return [Types::UpdateDeploymentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
+ # * {Types::UpdateDeploymentResponse#auto_deployed #auto_deployed} => Boolean
# * {Types::UpdateDeploymentResponse#created_date #created_date} => Time
# * {Types::UpdateDeploymentResponse#deployment_id #deployment_id} => String
# * {Types::UpdateDeploymentResponse#deployment_status #deployment_status} => String
# * {Types::UpdateDeploymentResponse#deployment_status_message #deployment_status_message} => String
# * {Types::UpdateDeploymentResponse#description #description} => String
@@ -2733,10 +3121,11 @@
# description: "StringWithLengthBetween0And1024",
# })
#
# @example Response structure
#
+ # resp.auto_deployed #=> Boolean
# resp.created_date #=> Time
# resp.deployment_id #=> String
# resp.deployment_status #=> String, one of "PENDING", "FAILED", "DEPLOYED"
# resp.deployment_status_message #=> String
# resp.description #=> String
@@ -2770,15 +3159,15 @@
# {
# api_gateway_domain_name: "__string",
# certificate_arn: "Arn",
# certificate_name: "StringWithLengthBetween1And128",
# certificate_upload_date: Time.now,
+ # domain_name_status: "AVAILABLE", # accepts AVAILABLE, UPDATING
+ # domain_name_status_message: "__string",
# endpoint_type: "REGIONAL", # accepts REGIONAL, EDGE
# hosted_zone_id: "__string",
# security_policy: "TLS_1_0", # accepts TLS_1_0, TLS_1_2
- # domain_name_status: "AVAILABLE", # accepts AVAILABLE, UPDATING
- # domain_name_status_message: "__string",
# },
# ],
# })
#
# @example Response structure
@@ -2788,15 +3177,15 @@
# resp.domain_name_configurations #=> Array
# resp.domain_name_configurations[0].api_gateway_domain_name #=> String
# resp.domain_name_configurations[0].certificate_arn #=> String
# resp.domain_name_configurations[0].certificate_name #=> String
# resp.domain_name_configurations[0].certificate_upload_date #=> Time
+ # resp.domain_name_configurations[0].domain_name_status #=> String, one of "AVAILABLE", "UPDATING"
+ # resp.domain_name_configurations[0].domain_name_status_message #=> String
# resp.domain_name_configurations[0].endpoint_type #=> String, one of "REGIONAL", "EDGE"
# resp.domain_name_configurations[0].hosted_zone_id #=> String
# resp.domain_name_configurations[0].security_policy #=> String, one of "TLS_1_0", "TLS_1_2"
- # resp.domain_name_configurations[0].domain_name_status #=> String, one of "AVAILABLE", "UPDATING"
- # resp.domain_name_configurations[0].domain_name_status_message #=> String
# resp.tags #=> Hash
# resp.tags["__string"] #=> String
#
# @overload update_domain_name(params = {})
# @param [Hash] params ({})
@@ -2815,10 +3204,11 @@
# @option params [String] :connection_type
# Represents a connection type.
#
# @option params [String] :content_handling_strategy
# Specifies how to handle response payload content type conversions.
+ # Supported only for WebSocket APIs.
#
# @option params [String] :credentials_arn
# Represents an Amazon Resource Name (ARN).
#
# @option params [String] :description
@@ -2834,12 +3224,16 @@
#
# @option params [String] :integration_uri
# A string representation of a URI with a length between \[1-2048\].
#
# @option params [String] :passthrough_behavior
- # Represents passthrough behavior for an integration response.
+ # Represents passthrough behavior for an integration response. Supported
+ # only for WebSocket APIs.
#
+ # @option params [String] :payload_format_version
+ # A string with a length between \[1-64\].
+ #
# @option params [Hash<String,String>] :request_parameters
# A key-value map specifying response parameters that are passed to the
# method response from the backend. The key is a method response header
# parameter name and the mapped value is an integration response header
# value, a static value enclosed within a pair of single quotes, or a
@@ -2867,10 +3261,11 @@
# @option params [Integer] :timeout_in_millis
# An integer with a value between \[50-29000\].
#
# @return [Types::UpdateIntegrationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
+ # * {Types::UpdateIntegrationResult#api_gateway_managed #api_gateway_managed} => Boolean
# * {Types::UpdateIntegrationResult#connection_id #connection_id} => String
# * {Types::UpdateIntegrationResult#connection_type #connection_type} => String
# * {Types::UpdateIntegrationResult#content_handling_strategy #content_handling_strategy} => String
# * {Types::UpdateIntegrationResult#credentials_arn #credentials_arn} => String
# * {Types::UpdateIntegrationResult#description #description} => String
@@ -2878,10 +3273,11 @@
# * {Types::UpdateIntegrationResult#integration_method #integration_method} => String
# * {Types::UpdateIntegrationResult#integration_response_selection_expression #integration_response_selection_expression} => String
# * {Types::UpdateIntegrationResult#integration_type #integration_type} => String
# * {Types::UpdateIntegrationResult#integration_uri #integration_uri} => String
# * {Types::UpdateIntegrationResult#passthrough_behavior #passthrough_behavior} => String
+ # * {Types::UpdateIntegrationResult#payload_format_version #payload_format_version} => String
# * {Types::UpdateIntegrationResult#request_parameters #request_parameters} => Hash<String,String>
# * {Types::UpdateIntegrationResult#request_templates #request_templates} => Hash<String,String>
# * {Types::UpdateIntegrationResult#template_selection_expression #template_selection_expression} => String
# * {Types::UpdateIntegrationResult#timeout_in_millis #timeout_in_millis} => Integer
#
@@ -2897,10 +3293,11 @@
# integration_id: "__string", # required
# integration_method: "StringWithLengthBetween1And64",
# integration_type: "AWS", # accepts AWS, HTTP, MOCK, HTTP_PROXY, AWS_PROXY
# integration_uri: "UriWithLengthBetween1And2048",
# passthrough_behavior: "WHEN_NO_MATCH", # accepts WHEN_NO_MATCH, NEVER, WHEN_NO_TEMPLATES
+ # payload_format_version: "StringWithLengthBetween1And64",
# request_parameters: {
# "__string" => "StringWithLengthBetween1And512",
# },
# request_templates: {
# "__string" => "StringWithLengthBetween0And32K",
@@ -2909,10 +3306,11 @@
# timeout_in_millis: 1,
# })
#
# @example Response structure
#
+ # resp.api_gateway_managed #=> Boolean
# resp.connection_id #=> String
# resp.connection_type #=> String, one of "INTERNET", "VPC_LINK"
# resp.content_handling_strategy #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
# resp.credentials_arn #=> String
# resp.description #=> String
@@ -2920,10 +3318,11 @@
# resp.integration_method #=> String
# resp.integration_response_selection_expression #=> String
# resp.integration_type #=> String, one of "AWS", "HTTP", "MOCK", "HTTP_PROXY", "AWS_PROXY"
# resp.integration_uri #=> String
# resp.passthrough_behavior #=> String, one of "WHEN_NO_MATCH", "NEVER", "WHEN_NO_TEMPLATES"
+ # resp.payload_format_version #=> String
# resp.request_parameters #=> Hash
# resp.request_parameters["__string"] #=> String
# resp.request_templates #=> Hash
# resp.request_templates["__string"] #=> String
# resp.template_selection_expression #=> String
@@ -2940,17 +3339,18 @@
#
# @option params [required, String] :api_id
#
# @option params [String] :content_handling_strategy
# Specifies how to handle response payload content type conversions.
+ # Supported only for WebSocket APIs.
#
# @option params [required, String] :integration_id
#
# @option params [required, String] :integration_response_id
#
# @option params [String] :integration_response_key
- # After evaulating a selection expression, the result is compared
+ # After evaluating a selection expression, the result is compared
# against one or more selection keys to find a matching key. See
# [Selection Expressions][1] for a list of expressions and each
# expression's associated selection key type.
#
#
@@ -3085,23 +3485,23 @@
#
# @option params [Boolean] :api_key_required
#
# @option params [Array<String>] :authorization_scopes
# A list of authorization scopes configured on a route. The scopes are
- # used with a COGNITO\_USER\_POOLS authorizer to authorize the method
- # invocation. The authorization works by matching the route scopes
- # against the scopes parsed from the access token in the incoming
- # request. The method invocation is authorized if any route scope
- # matches a claimed scope in the access token. Otherwise, the invocation
- # is not authorized. When the route scope is configured, the client must
- # provide an access token instead of an identity token for authorization
- # purposes.
+ # used with a JWT authorizer to authorize the method invocation. The
+ # authorization works by matching the route scopes against the scopes
+ # parsed from the access token in the incoming request. The method
+ # invocation is authorized if any route scope matches a claimed scope in
+ # the access token. Otherwise, the invocation is not authorized. When
+ # the route scope is configured, the client must provide an access token
+ # instead of an identity token for authorization purposes.
#
# @option params [String] :authorization_type
- # The authorization type. Valid values are NONE for open access,
- # AWS\_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda
- # authorizer.
+ # The authorization type. For WebSocket APIs, valid values are NONE for
+ # open access, AWS\_IAM for using AWS IAM permissions, and CUSTOM for
+ # using a Lambda authorizer. For HTTP APIs, valid values are NONE for
+ # open access, or JWT for using JSON Web Tokens.
#
# @option params [String] :authorizer_id
# The identifier.
#
# @option params [String] :model_selection_expression
@@ -3122,11 +3522,11 @@
# The route parameters.
#
# @option params [required, String] :route_id
#
# @option params [String] :route_key
- # After evaulating a selection expression, the result is compared
+ # After evaluating a selection expression, the result is compared
# against one or more selection keys to find a matching key. See
# [Selection Expressions][1] for a list of expressions and each
# expression's associated selection key type.
#
#
@@ -3144,10 +3544,11 @@
# @option params [String] :target
# A string with a length between \[1-128\].
#
# @return [Types::UpdateRouteResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
+ # * {Types::UpdateRouteResult#api_gateway_managed #api_gateway_managed} => Boolean
# * {Types::UpdateRouteResult#api_key_required #api_key_required} => Boolean
# * {Types::UpdateRouteResult#authorization_scopes #authorization_scopes} => Array<String>
# * {Types::UpdateRouteResult#authorization_type #authorization_type} => String
# * {Types::UpdateRouteResult#authorizer_id #authorizer_id} => String
# * {Types::UpdateRouteResult#model_selection_expression #model_selection_expression} => String
@@ -3163,11 +3564,11 @@
#
# resp = client.update_route({
# api_id: "__string", # required
# api_key_required: false,
# authorization_scopes: ["StringWithLengthBetween1And64"],
- # authorization_type: "NONE", # accepts NONE, AWS_IAM, CUSTOM
+ # authorization_type: "NONE", # accepts NONE, AWS_IAM, CUSTOM, JWT
# authorizer_id: "Id",
# model_selection_expression: "SelectionExpression",
# operation_name: "StringWithLengthBetween1And64",
# request_models: {
# "__string" => "StringWithLengthBetween1And128",
@@ -3183,14 +3584,15 @@
# target: "StringWithLengthBetween1And128",
# })
#
# @example Response structure
#
+ # resp.api_gateway_managed #=> Boolean
# resp.api_key_required #=> Boolean
# resp.authorization_scopes #=> Array
# resp.authorization_scopes[0] #=> String
- # resp.authorization_type #=> String, one of "NONE", "AWS_IAM", "CUSTOM"
+ # resp.authorization_type #=> String, one of "NONE", "AWS_IAM", "CUSTOM", "JWT"
# resp.authorizer_id #=> String
# resp.model_selection_expression #=> String
# resp.operation_name #=> String
# resp.request_models #=> Hash
# resp.request_models["__string"] #=> String
@@ -3229,11 +3631,11 @@
# @option params [required, String] :route_id
#
# @option params [required, String] :route_response_id
#
# @option params [String] :route_response_key
- # After evaulating a selection expression, the result is compared
+ # After evaluating a selection expression, the result is compared
# against one or more selection keys to find a matching key. See
# [Selection Expressions][1] for a list of expressions and each
# expression's associated selection key type.
#
#
@@ -3288,10 +3690,12 @@
# @option params [Types::AccessLogSettings] :access_log_settings
# Settings for logging access in a stage.
#
# @option params [required, String] :api_id
#
+ # @option params [Boolean] :auto_deploy
+ #
# @option params [String] :client_certificate_id
# The identifier.
#
# @option params [Types::RouteSettings] :default_route_settings
# Represents a collection of route settings.
@@ -3311,15 +3715,18 @@
# The stage variable map.
#
# @return [Types::UpdateStageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateStageResponse#access_log_settings #access_log_settings} => Types::AccessLogSettings
+ # * {Types::UpdateStageResponse#api_gateway_managed #api_gateway_managed} => Boolean
+ # * {Types::UpdateStageResponse#auto_deploy #auto_deploy} => Boolean
# * {Types::UpdateStageResponse#client_certificate_id #client_certificate_id} => String
# * {Types::UpdateStageResponse#created_date #created_date} => Time
# * {Types::UpdateStageResponse#default_route_settings #default_route_settings} => Types::RouteSettings
# * {Types::UpdateStageResponse#deployment_id #deployment_id} => String
# * {Types::UpdateStageResponse#description #description} => String
+ # * {Types::UpdateStageResponse#last_deployment_status_message #last_deployment_status_message} => String
# * {Types::UpdateStageResponse#last_updated_date #last_updated_date} => Time
# * {Types::UpdateStageResponse#route_settings #route_settings} => Hash<String,Types::RouteSettings>
# * {Types::UpdateStageResponse#stage_name #stage_name} => String
# * {Types::UpdateStageResponse#stage_variables #stage_variables} => Hash<String,String>
# * {Types::UpdateStageResponse#tags #tags} => Hash<String,String>
@@ -3330,10 +3737,11 @@
# access_log_settings: {
# destination_arn: "Arn",
# format: "StringWithLengthBetween1And1024",
# },
# api_id: "__string", # required
+ # auto_deploy: false,
# client_certificate_id: "Id",
# default_route_settings: {
# data_trace_enabled: false,
# detailed_metrics_enabled: false,
# logging_level: "ERROR", # accepts ERROR, INFO, false
@@ -3359,19 +3767,22 @@
#
# @example Response structure
#
# resp.access_log_settings.destination_arn #=> String
# resp.access_log_settings.format #=> String
+ # resp.api_gateway_managed #=> Boolean
+ # resp.auto_deploy #=> Boolean
# resp.client_certificate_id #=> String
# resp.created_date #=> Time
# resp.default_route_settings.data_trace_enabled #=> Boolean
# resp.default_route_settings.detailed_metrics_enabled #=> Boolean
# resp.default_route_settings.logging_level #=> String, one of "ERROR", "INFO", "false"
# resp.default_route_settings.throttling_burst_limit #=> Integer
# resp.default_route_settings.throttling_rate_limit #=> Float
# resp.deployment_id #=> String
# resp.description #=> String
+ # resp.last_deployment_status_message #=> String
# resp.last_updated_date #=> Time
# resp.route_settings #=> Hash
# resp.route_settings["__string"].data_trace_enabled #=> Boolean
# resp.route_settings["__string"].detailed_metrics_enabled #=> Boolean
# resp.route_settings["__string"].logging_level #=> String, one of "ERROR", "INFO", "false"
@@ -3401,10 +3812,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-apigatewayv2'
- context[:gem_version] = '1.14.0'
+ context[:gem_version] = '1.15.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated