Struct PutMethodResponseInput

#[non_exhaustive]
pub struct PutMethodResponseInput {
    pub rest_api_id: Option<String>,
    pub resource_id: Option<String>,
    pub http_method: Option<String>,
    pub status_code: Option<String>,
    pub response_parameters: Option<HashMap<String, bool>>,
    pub response_models: Option<HashMap<String, String>>,
}

Request to add a MethodResponse to an existing Method resource.

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.

rest_api_id: Option<String>

The string identifier of the associated RestApi.

resource_id: Option<String>

The Resource identifier for the Method resource.

http_method: Option<String>

The HTTP verb of the Method resource.

status_code: Option<String>

The method response's status code.

response_parameters: Option<HashMap<String, bool>>

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

response_models: Option<HashMap<String, String>>

Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.

Implementations

impl PutMethodResponseInput

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

The string identifier of the associated RestApi.

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

The Resource identifier for the Method resource.

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

The HTTP verb of the Method resource.

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

The method response's status code.

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

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

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

Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.

impl PutMethodResponseInput

pub fn builder() -> PutMethodResponseInputBuilder

Creates a new builder-style object to manufacture PutMethodResponseInput.

Trait Implementations

impl Clone for PutMethodResponseInput

fn clone(&self) -> PutMethodResponseInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PutMethodResponseInput

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

Formats the value using the given formatter.

impl PartialEq for PutMethodResponseInput

fn eq(&self, other: &PutMethodResponseInput) -> 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 StructuralPartialEq for PutMethodResponseInput