Struct PutIntegrationResponseOutput

#[non_exhaustive]
pub struct PutIntegrationResponseOutput {
    pub status_code: Option<String>,
    pub selection_pattern: Option<String>,
    pub response_parameters: Option<HashMap<String, String>>,
    pub response_templates: Option<HashMap<String, String>>,
    pub content_handling: Option<ContentHandlingStrategy>,
    /* private fields */
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

status_code: Option<String>

Specifies the status code that is used to map the integration response to an existing MethodResponse.

selection_pattern: Option<String>

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 (\n) 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.

response_parameters: Option<HashMap<String, String>>

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.

response_templates: Option<HashMap<String, String>>

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.

content_handling: Option<ContentHandlingStrategy>

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.

Implementations

impl PutIntegrationResponseOutput

pub fn status_code(&self) -> Option<&str>

Specifies the status code that is used to map the integration response to an existing MethodResponse.

pub fn selection_pattern(&self) -> Option<&str>

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 (\n) 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.

pub fn response_parameters(&self) -> Option<&HashMap<String, String>>

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.

pub fn response_templates(&self) -> Option<&HashMap<String, String>>

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.

pub fn content_handling(&self) -> Option<&ContentHandlingStrategy>

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.

impl PutIntegrationResponseOutput

pub fn builder() -> PutIntegrationResponseOutputBuilder

Creates a new builder-style object to manufacture PutIntegrationResponseOutput.

Trait Implementations

impl Clone for PutIntegrationResponseOutput

fn clone(&self) -> PutIntegrationResponseOutput

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PutIntegrationResponseOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for PutIntegrationResponseOutput

fn eq(&self, other: &PutIntegrationResponseOutput) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for PutIntegrationResponseOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for PutIntegrationResponseOutput