Struct GetIntegrationResponseOutput

#[non_exhaustive]
pub struct GetIntegrationResponseOutput {
    pub content_handling_strategy: Option<ContentHandlingStrategy>,
    pub integration_response_id: Option<String>,
    pub integration_response_key: Option<String>,
    pub response_parameters: Option<HashMap<String, String>>,
    pub response_templates: Option<HashMap<String, String>>,
    pub template_selection_expression: Option<String>,
    /* private fields */
}

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.

content_handling_strategy: Option<ContentHandlingStrategy>

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

integration_response_id: Option<String>

The integration response ID.

integration_response_key: Option<String>

The integration response key.

response_parameters: Option<HashMap<String, String>>

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.

response_templates: Option<HashMap<String, String>>

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

template_selection_expression: Option<String>

The template selection expressions for the integration response.

Implementations

impl GetIntegrationResponseOutput

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

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

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

The integration response ID.

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

The integration response key.

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 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.

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

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

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

The template selection expressions for the integration response.

impl GetIntegrationResponseOutput

pub fn builder() -> GetIntegrationResponseOutputBuilder

Creates a new builder-style object to manufacture GetIntegrationResponseOutput.

Trait Implementations

impl Clone for GetIntegrationResponseOutput

fn clone(&self) -> GetIntegrationResponseOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetIntegrationResponseOutput

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

Formats the value using the given formatter.

impl PartialEq for GetIntegrationResponseOutput

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

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

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 GetIntegrationResponseOutput

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

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

impl StructuralPartialEq for GetIntegrationResponseOutput