lib/aws-sdk-apigatewayv2/client.rb in aws-sdk-apigatewayv2-1.29.0 vs lib/aws-sdk-apigatewayv2/client.rb in aws-sdk-apigatewayv2-1.30.0

- old
+ new

@@ -788,22 +788,47 @@ # # @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 - # JSON expression from the integration response body. The mapping key - # must match the pattern of method.response.header.\\\{name\\}, where - # name is a valid and unique header name. The mapped non-static value - # must match the pattern of integration.response.header.\\\{name\\} or - # integration.response.body.\\\{JSON-expression\\}, where name is a - # valid and unique response header name and JSON-expression is a valid - # JSON expression without the $ prefix. + # For WebSocket APIs, a key-value map specifying request parameters that + # are passed from the method request to the backend. The key is an + # integration request parameter name and the associated value is a + # method request parameter value or static value that must be enclosed + # within single quotes and pre-encoded as required by the backend. The + # method request parameter value must match the pattern of + # method.request.*\\\{location\\}*.*\\\{name\\}* , where + # *\\\{location\\}* is querystring, path, or header; and *\\\{name\\}* + # must be a valid and unique method request parameter name. # + # For HTTP API integrations with a specified integrationSubtype, request + # parameters are a key-value map specifying parameters that are passed + # to AWS\_PROXY integrations. You can provide static values, or map + # request data, stage variables, or context variables that are evaluated + # at runtime. To learn more, see [Working with AWS service integrations + # for HTTP APIs][1]. + # + # For HTTP API integrations without a specified integrationSubtype + # request parameters are a key-value map specifying how to transform + # HTTP requests before sending them to the backend. The key should + # follow the pattern + # &lt;action&gt;\:&lt;header\|querystring\|path&gt;.&lt;location&gt; + # where action can be append, overwrite or remove. For values, you can + # provide static values, or map request data, stage variables, or + # context variables that are evaluated at runtime. To learn more, see + # [Transforming API requests and responses][2]. + # + # + # + # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html + # [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html + # + # @option params [Hash<String,Hash>] :response_parameters + # Supported only for HTTP APIs. You use response parameters to transform + # the HTTP response from a backend integration before returning the + # response to clients. + # # @option params [Hash<String,String>] :request_templates # A mapping of identifier keys to templates. The value is an actual # template script. The key is typically a SelectionKey which is chosen # based on evaluating a selection expression. # @@ -838,10 +863,11 @@ # * {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&lt;String,String&gt; + # * {Types::CreateIntegrationResult#response_parameters #response_parameters} => Hash&lt;String,Hash&lt;String,String&gt;&gt; # * {Types::CreateIntegrationResult#request_templates #request_templates} => Hash&lt;String,String&gt; # * {Types::CreateIntegrationResult#template_selection_expression #template_selection_expression} => String # * {Types::CreateIntegrationResult#timeout_in_millis #timeout_in_millis} => Integer # * {Types::CreateIntegrationResult#tls_config #tls_config} => Types::TlsConfig # @@ -861,10 +887,15 @@ # passthrough_behavior: "WHEN_NO_MATCH", # accepts WHEN_NO_MATCH, NEVER, WHEN_NO_TEMPLATES # payload_format_version: "StringWithLengthBetween1And64", # request_parameters: { # "__string" => "StringWithLengthBetween1And512", # }, + # response_parameters: { + # "__string" => { + # "__string" => "StringWithLengthBetween1And512", + # }, + # }, # request_templates: { # "__string" => "StringWithLengthBetween0And32K", # }, # template_selection_expression: "SelectionExpression", # timeout_in_millis: 1, @@ -889,10 +920,13 @@ # 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.response_parameters #=> Hash + # resp.response_parameters["__string"] #=> Hash + # resp.response_parameters["__string"]["__string"] #=> String # resp.request_templates #=> Hash # resp.request_templates["__string"] #=> String # resp.template_selection_expression #=> String # resp.timeout_in_millis #=> Integer # resp.tls_config.server_name_to_verify #=> String @@ -923,22 +957,42 @@ # # # [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 - # value, a static value enclosed within a pair of single quotes, or a - # JSON expression from the integration response body. The mapping key - # must match the pattern of method.response.header.\\\{name\\}, where - # name is a valid and unique header name. The mapped non-static value - # must match the pattern of integration.response.header.\\\{name\\} or - # integration.response.body.\\\{JSON-expression\\}, where name is a - # valid and unique response header name and JSON-expression is a valid - # JSON expression without the $ prefix. + # For WebSocket APIs, a key-value map specifying request parameters that + # are passed from the method request to the backend. The key is an + # integration request parameter name and the associated value is a + # method request parameter value or static value that must be enclosed + # within single quotes and pre-encoded as required by the backend. The + # method request parameter value must match the pattern of + # method.request.*\\\{location\\}*.*\\\{name\\}* , where + # *\\\{location\\}* is querystring, path, or header; and *\\\{name\\}* + # must be a valid and unique method request parameter name. # + # For HTTP API integrations with a specified integrationSubtype, request + # parameters are a key-value map specifying parameters that are passed + # to AWS\_PROXY integrations. You can provide static values, or map + # request data, stage variables, or context variables that are evaluated + # at runtime. To learn more, see [Working with AWS service integrations + # for HTTP APIs][1]. + # + # For HTTP API integrations without a specified integrationSubtype + # request parameters are a key-value map specifying how to transform + # HTTP requests before sending them to the backend. The key should + # follow the pattern + # &lt;action&gt;\:&lt;header\|querystring\|path&gt;.&lt;location&gt; + # where action can be append, overwrite or remove. For values, you can + # provide static values, or map request data, stage variables, or + # context variables that are evaluated at runtime. To learn more, see + # [Transforming API requests and responses][2]. + # + # + # + # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html + # [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html + # # @option params [Hash<String,String>] :response_templates # A mapping of identifier keys to templates. The value is an actual # template script. The key is typically a SelectionKey which is chosen # based on evaluating a selection expression. # @@ -2328,10 +2382,11 @@ # * {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&lt;String,String&gt; + # * {Types::GetIntegrationResult#response_parameters #response_parameters} => Hash&lt;String,Hash&lt;String,String&gt;&gt; # * {Types::GetIntegrationResult#request_templates #request_templates} => Hash&lt;String,String&gt; # * {Types::GetIntegrationResult#template_selection_expression #template_selection_expression} => String # * {Types::GetIntegrationResult#timeout_in_millis #timeout_in_millis} => Integer # * {Types::GetIntegrationResult#tls_config #tls_config} => Types::TlsConfig # @@ -2358,10 +2413,13 @@ # 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.response_parameters #=> Hash + # resp.response_parameters["__string"] #=> Hash + # resp.response_parameters["__string"]["__string"] #=> String # resp.request_templates #=> Hash # resp.request_templates["__string"] #=> String # resp.template_selection_expression #=> String # resp.timeout_in_millis #=> Integer # resp.tls_config.server_name_to_verify #=> String @@ -2498,10 +2556,13 @@ # 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].response_parameters #=> Hash + # resp.items[0].response_parameters["__string"] #=> Hash + # resp.items[0].response_parameters["__string"]["__string"] #=> String # resp.items[0].request_templates #=> Hash # resp.items[0].request_templates["__string"] #=> String # resp.items[0].template_selection_expression #=> String # resp.items[0].timeout_in_millis #=> Integer # resp.items[0].tls_config.server_name_to_verify #=> String @@ -3691,22 +3752,47 @@ # # @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 - # JSON expression from the integration response body. The mapping key - # must match the pattern of method.response.header.\\\{name\\}, where - # name is a valid and unique header name. The mapped non-static value - # must match the pattern of integration.response.header.\\\{name\\} or - # integration.response.body.\\\{JSON-expression\\}, where name is a - # valid and unique response header name and JSON-expression is a valid - # JSON expression without the $ prefix. + # For WebSocket APIs, a key-value map specifying request parameters that + # are passed from the method request to the backend. The key is an + # integration request parameter name and the associated value is a + # method request parameter value or static value that must be enclosed + # within single quotes and pre-encoded as required by the backend. The + # method request parameter value must match the pattern of + # method.request.*\\\{location\\}*.*\\\{name\\}* , where + # *\\\{location\\}* is querystring, path, or header; and *\\\{name\\}* + # must be a valid and unique method request parameter name. # + # For HTTP API integrations with a specified integrationSubtype, request + # parameters are a key-value map specifying parameters that are passed + # to AWS\_PROXY integrations. You can provide static values, or map + # request data, stage variables, or context variables that are evaluated + # at runtime. To learn more, see [Working with AWS service integrations + # for HTTP APIs][1]. + # + # For HTTP API integrations without a specified integrationSubtype + # request parameters are a key-value map specifying how to transform + # HTTP requests before sending them to the backend. The key should + # follow the pattern + # &lt;action&gt;\:&lt;header\|querystring\|path&gt;.&lt;location&gt; + # where action can be append, overwrite or remove. For values, you can + # provide static values, or map request data, stage variables, or + # context variables that are evaluated at runtime. To learn more, see + # [Transforming API requests and responses][2]. + # + # + # + # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html + # [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html + # + # @option params [Hash<String,Hash>] :response_parameters + # Supported only for HTTP APIs. You use response parameters to transform + # the HTTP response from a backend integration before returning the + # response to clients. + # # @option params [Hash<String,String>] :request_templates # A mapping of identifier keys to templates. The value is an actual # template script. The key is typically a SelectionKey which is chosen # based on evaluating a selection expression. # @@ -3741,10 +3827,11 @@ # * {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&lt;String,String&gt; + # * {Types::UpdateIntegrationResult#response_parameters #response_parameters} => Hash&lt;String,Hash&lt;String,String&gt;&gt; # * {Types::UpdateIntegrationResult#request_templates #request_templates} => Hash&lt;String,String&gt; # * {Types::UpdateIntegrationResult#template_selection_expression #template_selection_expression} => String # * {Types::UpdateIntegrationResult#timeout_in_millis #timeout_in_millis} => Integer # * {Types::UpdateIntegrationResult#tls_config #tls_config} => Types::TlsConfig # @@ -3765,10 +3852,15 @@ # passthrough_behavior: "WHEN_NO_MATCH", # accepts WHEN_NO_MATCH, NEVER, WHEN_NO_TEMPLATES # payload_format_version: "StringWithLengthBetween1And64", # request_parameters: { # "__string" => "StringWithLengthBetween1And512", # }, + # response_parameters: { + # "__string" => { + # "__string" => "StringWithLengthBetween1And512", + # }, + # }, # request_templates: { # "__string" => "StringWithLengthBetween0And32K", # }, # template_selection_expression: "SelectionExpression", # timeout_in_millis: 1, @@ -3793,10 +3885,13 @@ # 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.response_parameters #=> Hash + # resp.response_parameters["__string"] #=> Hash + # resp.response_parameters["__string"]["__string"] #=> String # resp.request_templates #=> Hash # resp.request_templates["__string"] #=> String # resp.template_selection_expression #=> String # resp.timeout_in_millis #=> Integer # resp.tls_config.server_name_to_verify #=> String @@ -3829,22 +3924,42 @@ # # # [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 - # value, a static value enclosed within a pair of single quotes, or a - # JSON expression from the integration response body. The mapping key - # must match the pattern of method.response.header.\\\{name\\}, where - # name is a valid and unique header name. The mapped non-static value - # must match the pattern of integration.response.header.\\\{name\\} or - # integration.response.body.\\\{JSON-expression\\}, where name is a - # valid and unique response header name and JSON-expression is a valid - # JSON expression without the $ prefix. + # For WebSocket APIs, a key-value map specifying request parameters that + # are passed from the method request to the backend. The key is an + # integration request parameter name and the associated value is a + # method request parameter value or static value that must be enclosed + # within single quotes and pre-encoded as required by the backend. The + # method request parameter value must match the pattern of + # method.request.*\\\{location\\}*.*\\\{name\\}* , where + # *\\\{location\\}* is querystring, path, or header; and *\\\{name\\}* + # must be a valid and unique method request parameter name. # + # For HTTP API integrations with a specified integrationSubtype, request + # parameters are a key-value map specifying parameters that are passed + # to AWS\_PROXY integrations. You can provide static values, or map + # request data, stage variables, or context variables that are evaluated + # at runtime. To learn more, see [Working with AWS service integrations + # for HTTP APIs][1]. + # + # For HTTP API integrations without a specified integrationSubtype + # request parameters are a key-value map specifying how to transform + # HTTP requests before sending them to the backend. The key should + # follow the pattern + # &lt;action&gt;\:&lt;header\|querystring\|path&gt;.&lt;location&gt; + # where action can be append, overwrite or remove. For values, you can + # provide static values, or map request data, stage variables, or + # context variables that are evaluated at runtime. To learn more, see + # [Transforming API requests and responses][2]. + # + # + # + # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html + # [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html + # # @option params [Hash<String,String>] :response_templates # A mapping of identifier keys to templates. The value is an actual # template script. The key is typically a SelectionKey which is chosen # based on evaluating a selection expression. # @@ -4334,10 +4449,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-apigatewayv2' - context[:gem_version] = '1.29.0' + context[:gem_version] = '1.30.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated