lib/aws-sdk-apigatewayv2/client.rb in aws-sdk-apigatewayv2-1.0.0 vs lib/aws-sdk-apigatewayv2/client.rb in aws-sdk-apigatewayv2-1.1.0

- old
+ new

@@ -211,11 +211,11 @@ # 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 + # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions # # @option params [String] :description # A string with a length between \[0-1024\]. # # @option params [Boolean] :disable_schema_validation @@ -229,11 +229,11 @@ # 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 + # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions # # @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: @@ -285,21 +285,21 @@ end # Creates an API mapping. # # @option params [required, String] :api_id - # An API Gateway-generated, unique identifier. + # The identifier. # # @option params [String] :api_mapping_key # After evaulating 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 + # [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] :domain_name # # @option params [required, String] :stage # A string with a length between \[1-128\]. @@ -350,17 +350,16 @@ # # @option params [required, 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 enabled. The value is a comma-separated string of one or - # more mapping expressions of the specified request parameters. For - # example, if an Auth header, a Name query string parameter are defined - # as identity sources, this value is $method.request.header.Auth, + # The identity source for which authorization is requested. For the + # REQUEST authorizer, this is required when authorization caching is + # enabled. The value is a comma-separated string of one or more mapping + # expressions of the specified request parameters. For example, if an + # Auth header, a Name query string parameter are defined as identity + # sources, this value is $method.request.header.Auth, # $method.request.querystring.Name. These parameters will be used to # derive the authorization caching key and to perform runtime validation # of the REQUEST authorizer by verifying all of the identity-related # request parameters are present, not null and non-empty. Only when this # is true does the authorizer invoke the authorizer Lambda function, @@ -535,11 +534,11 @@ # A string with a length between \[0-1024\]. # # @option params [String] :integration_method # A string with a length between \[1-64\]. # - # @option params [String] :integration_type + # @option params [required, String] :integration_type # Represents an API method integration type. # # @option params [String] :integration_uri # A string representation of a URI with a length between \[1-2048\]. # @@ -568,11 +567,11 @@ # 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 + # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions # # @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: @@ -601,11 +600,11 @@ # connection_type: "INTERNET", # accepts INTERNET, VPC_LINK # content_handling_strategy: "CONVERT_TO_BINARY", # accepts CONVERT_TO_BINARY, CONVERT_TO_TEXT # credentials_arn: "Arn", # description: "StringWithLengthBetween0And1024", # integration_method: "StringWithLengthBetween1And64", - # integration_type: "AWS", # accepts AWS, HTTP, MOCK, HTTP_PROXY, AWS_PROXY + # 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 # request_parameters: { # "__string" => "StringWithLengthBetween1And512", # }, @@ -658,11 +657,11 @@ # [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 + # [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>] :response_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 @@ -684,11 +683,11 @@ # 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 + # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions # # @return [Types::CreateIntegrationResponseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateIntegrationResponseResponse#content_handling_strategy #content_handling_strategy} => String # * {Types::CreateIntegrationResponseResponse#integration_response_id #integration_response_id} => String @@ -742,11 +741,11 @@ # A string with a length between \[0-1024\]. # # @option params [required, String] :name # A string with a length between \[1-128\]. # - # @option params [String] :schema + # @option params [required, String] :schema # A string with a length between \[0-32768\]. # # @return [Types::CreateModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateModelResponse#content_type #content_type} => String @@ -760,11 +759,11 @@ # resp = client.create_model({ # api_id: "__string", # required # content_type: "StringWithLengthBetween1And256", # description: "StringWithLengthBetween0And1024", # name: "StringWithLengthBetween1And128", # required - # schema: "StringWithLengthBetween0And32K", + # schema: "StringWithLengthBetween0And32K", # required # }) # # @example Response structure # # resp.content_type #=> String @@ -801,19 +800,19 @@ # The authorization type. Valid values are NONE for open access, # AWS\_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda # authorizer. # # @option params [String] :authorizer_id - # An API Gateway-generated, unique identifier. + # The identifier. # # @option params [String] :model_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 + # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions # # @option params [String] :operation_name # A string with a length between \[1-64\]. # # @option params [Hash<String,String>] :request_models @@ -828,19 +827,19 @@ # [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 + # [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_response_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 + # [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 with a length between \[1-128\]. # # @return [Types::CreateRouteResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -914,11 +913,11 @@ # 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 + # [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>] :response_models # The route models. # # @option params [Hash<String,Types::ParameterConstraints>] :response_parameters @@ -932,11 +931,11 @@ # [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 + # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions # # @return [Types::CreateRouteResponseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateRouteResponseResponse#model_selection_expression #model_selection_expression} => String # * {Types::CreateRouteResponseResponse#response_models #response_models} => Hash&lt;String,String&gt; @@ -984,17 +983,17 @@ # Settings for logging access in a stage. # # @option params [required, String] :api_id # # @option params [String] :client_certificate_id - # An API Gateway-generated, unique identifier. + # The identifier. # # @option params [Types::RouteSettings] :default_route_settings # Represents a collection of route settings. # # @option params [String] :deployment_id - # An API Gateway-generated, unique identifier. + # The identifier. # # @option params [String] :description # A string with a length between \[0-1024\]. # # @option params [Hash<String,Types::RouteSettings>] :route_settings @@ -1102,22 +1101,19 @@ req.send_request(options) end # Deletes an API mapping. # - # @option params [required, String] :api_id - # # @option params [required, String] :api_mapping_id # # @option params [required, String] :domain_name # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_api_mapping({ - # api_id: "__string", # required # api_mapping_id: "__string", # required # domain_name: "__string", # required # }) # # @overload delete_api_mapping(params = {}) @@ -1374,12 +1370,10 @@ req.send_request(options) end # The API mapping. # - # @option params [required, String] :api_id - # # @option params [required, String] :api_mapping_id # # @option params [required, String] :domain_name # # @return [Types::GetApiMappingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -1390,11 +1384,10 @@ # * {Types::GetApiMappingResponse#stage #stage} => String # # @example Request syntax with placeholder values # # resp = client.get_api_mapping({ - # api_id: "__string", # required # api_mapping_id: "__string", # required # domain_name: "__string", # required # }) # # @example Response structure @@ -1419,14 +1412,12 @@ # # @option params [String] :next_token # # @return [Types::GetApiMappingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::GetApiMappingsResponse#api_id #api_id} => String - # * {Types::GetApiMappingsResponse#api_mapping_id #api_mapping_id} => String - # * {Types::GetApiMappingsResponse#api_mapping_key #api_mapping_key} => String - # * {Types::GetApiMappingsResponse#stage #stage} => String + # * {Types::GetApiMappingsResponse#items #items} => Array&lt;Types::ApiMapping&gt; + # * {Types::GetApiMappingsResponse#next_token #next_token} => String # # @example Request syntax with placeholder values # # resp = client.get_api_mappings({ # domain_name: "__string", # required @@ -1434,14 +1425,16 @@ # next_token: "__string", # }) # # @example Response structure # - # resp.api_id #=> String - # resp.api_mapping_id #=> String - # resp.api_mapping_key #=> String - # resp.stage #=> String + # resp.items #=> Array + # resp.items[0].api_id #=> String + # resp.items[0].api_mapping_id #=> String + # resp.items[0].api_mapping_key #=> String + # resp.items[0].stage #=> String + # resp.next_token #=> String # # @overload get_api_mappings(params = {}) # @param [Hash] params ({}) def get_api_mappings(params = {}, options = {}) req = build_request(:get_api_mappings, params) @@ -2329,11 +2322,11 @@ # 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 + # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions # # @option params [String] :description # A string with a length between \[0-1024\]. # # @option params [Boolean] :disable_schema_validation @@ -2345,11 +2338,11 @@ # 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 + # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions # # @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: @@ -2401,11 +2394,11 @@ end # The API mapping. # # @option params [required, String] :api_id - # An API Gateway-generated, unique identifier. + # The identifier. # # @option params [required, String] :api_mapping_id # # @option params [String] :api_mapping_key # After evaulating a selection expression, the result is compared @@ -2413,11 +2406,11 @@ # [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 + # [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] :domain_name # # @option params [String] :stage # A string with a length between \[1-128\]. @@ -2471,17 +2464,16 @@ # # @option params [String] :authorizer_uri # A string representation of a URI with a length between \[1-2048\]. # # @option params [Array<String>] :identity_source - # The identity source for which authorization is requested. - # - # For the REQUEST authorizer, this is required when authorization - # caching is enabled. The value is a comma-separated string of one or - # more mapping expressions of the specified request parameters. For - # example, if an Auth header, a Name query string parameter are defined - # as identity sources, this value is $method.request.header.Auth, + # The identity source for which authorization is requested. For the + # REQUEST authorizer, this is required when authorization caching is + # enabled. The value is a comma-separated string of one or more mapping + # expressions of the specified request parameters. For example, if an + # Auth header, a Name query string parameter are defined as identity + # sources, this value is $method.request.header.Auth, # $method.request.querystring.Name. These parameters will be used to # derive the authorization caching key and to perform runtime validation # of the REQUEST authorizer by verifying all of the identity-related # request parameters are present, not null and non-empty. Only when this # is true does the authorizer invoke the authorizer Lambda function, @@ -2690,11 +2682,11 @@ # 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 + # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions # # @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: @@ -2783,11 +2775,11 @@ # [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 + # [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>] :response_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 @@ -2809,11 +2801,11 @@ # 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 + # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions # # @return [Types::UpdateIntegrationResponseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateIntegrationResponseResponse#content_handling_strategy #content_handling_strategy} => String # * {Types::UpdateIntegrationResponseResponse#integration_response_id #integration_response_id} => String @@ -2930,19 +2922,19 @@ # The authorization type. Valid values are NONE for open access, # AWS\_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda # authorizer. # # @option params [String] :authorizer_id - # An API Gateway-generated, unique identifier. + # The identifier. # # @option params [String] :model_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 + # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions # # @option params [String] :operation_name # A string with a length between \[1-64\]. # # @option params [Hash<String,String>] :request_models @@ -2959,19 +2951,19 @@ # [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 + # [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_response_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 + # [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 with a length between \[1-128\]. # # @return [Types::UpdateRouteResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -3046,11 +3038,11 @@ # 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 + # [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>] :response_models # The route models. # # @option params [Hash<String,Types::ParameterConstraints>] :response_parameters @@ -3066,11 +3058,11 @@ # [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 + # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions # # @return [Types::UpdateRouteResponseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateRouteResponseResponse#model_selection_expression #model_selection_expression} => String # * {Types::UpdateRouteResponseResponse#response_models #response_models} => Hash&lt;String,String&gt; @@ -3119,17 +3111,17 @@ # Settings for logging access in a stage. # # @option params [required, String] :api_id # # @option params [String] :client_certificate_id - # An API Gateway-generated, unique identifier. + # The identifier. # # @option params [Types::RouteSettings] :default_route_settings # Represents a collection of route settings. # # @option params [String] :deployment_id - # An API Gateway-generated, unique identifier. + # The identifier. # # @option params [String] :description # A string with a length between \[0-1024\]. # # @option params [Hash<String,Types::RouteSettings>] :route_settings @@ -3228,10 +3220,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-apigatewayv2' - context[:gem_version] = '1.0.0' + context[:gem_version] = '1.1.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated