get_integration_response¶
Operation¶
async
¶
get_integration_response(input: GetIntegrationResponseInput, plugins: list[Plugin] | None = None) -> GetIntegrationResponseOutput
Represents a get integration response.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetIntegrationResponseInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
GetIntegrationResponseOutput
|
An instance of |
Input¶
dataclass
¶
Represents a get integration response request.
Attributes¶
class-attribute
instance-attribute
¶
http_method: str | None = None
Specifies a get integration response request's HTTP method.
class-attribute
instance-attribute
¶
resource_id: str | None = None
Specifies a get integration response request's resource identifier.
class-attribute
instance-attribute
¶
rest_api_id: str | None = None
The string identifier of the associated RestApi.
class-attribute
instance-attribute
¶
status_code: str | None = None
Specifies a get integration response request's status code.
Output¶
dataclass
¶
Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.
Attributes¶
class-attribute
instance-attribute
¶
content_handling: ContentHandlingStrategy | None = None
Specifies how to handle response payload content type conversions.
Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the
following behaviors:
If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
class-attribute
instance-attribute
¶
response_parameters: dict[str, str] | None = None
A key-value map specifying response parameters that are passed to the
method response from the back end. 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.
class-attribute
instance-attribute
¶
response_templates: dict[str, str] | None = None
Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
class-attribute
instance-attribute
¶
selection_pattern: str | None = None
Specifies the regular expression (regex) pattern used to choose an
integration response based on the response from the back end. For
example, if the success response returns nothing and the error response
returns some string, you could use the `.+` regex to match error
response. However, make sure that the error response does not contain
any newline (`
`) character in such cases. If the back end is an Lambda function, the Lambda function error header is matched. For all other HTTP and Amazon Web Services back ends, the HTTP status code is matched.
class-attribute
instance-attribute
¶
status_code: str | None = None
Specifies the status code that is used to map the integration response to an existing MethodResponse.