AWS SDK for C++  1.8.126
AWS SDK for C++
Public Member Functions | List of all members
Aws::APIGateway::Model::IntegrationResponse Class Reference

#include <IntegrationResponse.h>

Public Member Functions

 IntegrationResponse ()
 
 IntegrationResponse (Aws::Utils::Json::JsonView jsonValue)
 
IntegrationResponseoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetStatusCode () const
 
bool StatusCodeHasBeenSet () const
 
void SetStatusCode (const Aws::String &value)
 
void SetStatusCode (Aws::String &&value)
 
void SetStatusCode (const char *value)
 
IntegrationResponseWithStatusCode (const Aws::String &value)
 
IntegrationResponseWithStatusCode (Aws::String &&value)
 
IntegrationResponseWithStatusCode (const char *value)
 
const Aws::StringGetSelectionPattern () const
 
bool SelectionPatternHasBeenSet () const
 
void SetSelectionPattern (const Aws::String &value)
 
void SetSelectionPattern (Aws::String &&value)
 
void SetSelectionPattern (const char *value)
 
IntegrationResponseWithSelectionPattern (const Aws::String &value)
 
IntegrationResponseWithSelectionPattern (Aws::String &&value)
 
IntegrationResponseWithSelectionPattern (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetResponseParameters () const
 
bool ResponseParametersHasBeenSet () const
 
void SetResponseParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetResponseParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
IntegrationResponseWithResponseParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
IntegrationResponseWithResponseParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
IntegrationResponseAddResponseParameters (const Aws::String &key, const Aws::String &value)
 
IntegrationResponseAddResponseParameters (Aws::String &&key, const Aws::String &value)
 
IntegrationResponseAddResponseParameters (const Aws::String &key, Aws::String &&value)
 
IntegrationResponseAddResponseParameters (Aws::String &&key, Aws::String &&value)
 
IntegrationResponseAddResponseParameters (const char *key, Aws::String &&value)
 
IntegrationResponseAddResponseParameters (Aws::String &&key, const char *value)
 
IntegrationResponseAddResponseParameters (const char *key, const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetResponseTemplates () const
 
bool ResponseTemplatesHasBeenSet () const
 
void SetResponseTemplates (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetResponseTemplates (Aws::Map< Aws::String, Aws::String > &&value)
 
IntegrationResponseWithResponseTemplates (const Aws::Map< Aws::String, Aws::String > &value)
 
IntegrationResponseWithResponseTemplates (Aws::Map< Aws::String, Aws::String > &&value)
 
IntegrationResponseAddResponseTemplates (const Aws::String &key, const Aws::String &value)
 
IntegrationResponseAddResponseTemplates (Aws::String &&key, const Aws::String &value)
 
IntegrationResponseAddResponseTemplates (const Aws::String &key, Aws::String &&value)
 
IntegrationResponseAddResponseTemplates (Aws::String &&key, Aws::String &&value)
 
IntegrationResponseAddResponseTemplates (const char *key, Aws::String &&value)
 
IntegrationResponseAddResponseTemplates (Aws::String &&key, const char *value)
 
IntegrationResponseAddResponseTemplates (const char *key, const char *value)
 
const ContentHandlingStrategyGetContentHandling () const
 
bool ContentHandlingHasBeenSet () const
 
void SetContentHandling (const ContentHandlingStrategy &value)
 
void SetContentHandling (ContentHandlingStrategy &&value)
 
IntegrationResponseWithContentHandling (const ContentHandlingStrategy &value)
 
IntegrationResponseWithContentHandling (ContentHandlingStrategy &&value)
 

Detailed Description

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.

See Also:

AWS API Reference

Definition at line 37 of file IntegrationResponse.h.

Constructor & Destructor Documentation

◆ IntegrationResponse() [1/2]

Aws::APIGateway::Model::IntegrationResponse::IntegrationResponse ( )

◆ IntegrationResponse() [2/2]

Aws::APIGateway::Model::IntegrationResponse::IntegrationResponse ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddResponseParameters() [1/7]

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::AddResponseParameters ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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.

Definition at line 350 of file IntegrationResponse.h.

◆ AddResponseParameters() [2/7]

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::AddResponseParameters ( Aws::String &&  key,
const Aws::String value 
)
inline

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.

Definition at line 318 of file IntegrationResponse.h.

◆ AddResponseParameters() [3/7]

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::AddResponseParameters ( Aws::String &&  key,
const char *  value 
)
inline

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.

Definition at line 382 of file IntegrationResponse.h.

◆ AddResponseParameters() [4/7]

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::AddResponseParameters ( const Aws::String key,
Aws::String &&  value 
)
inline

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.

Definition at line 334 of file IntegrationResponse.h.

◆ AddResponseParameters() [5/7]

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::AddResponseParameters ( const Aws::String key,
const Aws::String value 
)
inline

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.

Definition at line 302 of file IntegrationResponse.h.

◆ AddResponseParameters() [6/7]

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::AddResponseParameters ( const char *  key,
Aws::String &&  value 
)
inline

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.

Definition at line 366 of file IntegrationResponse.h.

◆ AddResponseParameters() [7/7]

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::AddResponseParameters ( const char *  key,
const char *  value 
)
inline

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.

Definition at line 398 of file IntegrationResponse.h.

◆ AddResponseTemplates() [1/7]

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::AddResponseTemplates ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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.

Definition at line 469 of file IntegrationResponse.h.

◆ AddResponseTemplates() [2/7]

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::AddResponseTemplates ( Aws::String &&  key,
const Aws::String value 
)
inline

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.

Definition at line 455 of file IntegrationResponse.h.

◆ AddResponseTemplates() [3/7]

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::AddResponseTemplates ( Aws::String &&  key,
const char *  value 
)
inline

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.

Definition at line 483 of file IntegrationResponse.h.

◆ AddResponseTemplates() [4/7]

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::AddResponseTemplates ( const Aws::String key,
Aws::String &&  value 
)
inline

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.

Definition at line 462 of file IntegrationResponse.h.

◆ AddResponseTemplates() [5/7]

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::AddResponseTemplates ( const Aws::String key,
const Aws::String value 
)
inline

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.

Definition at line 448 of file IntegrationResponse.h.

◆ AddResponseTemplates() [6/7]

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::AddResponseTemplates ( const char *  key,
Aws::String &&  value 
)
inline

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.

Definition at line 476 of file IntegrationResponse.h.

◆ AddResponseTemplates() [7/7]

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::AddResponseTemplates ( const char *  key,
const char *  value 
)
inline

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.

Definition at line 490 of file IntegrationResponse.h.

◆ ContentHandlingHasBeenSet()

bool Aws::APIGateway::Model::IntegrationResponse::ContentHandlingHasBeenSet ( ) const
inline

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 method response without modification.

Definition at line 515 of file IntegrationResponse.h.

◆ GetContentHandling()

const ContentHandlingStrategy& Aws::APIGateway::Model::IntegrationResponse::GetContentHandling ( ) const
inline

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 method response without modification.

Definition at line 503 of file IntegrationResponse.h.

◆ GetResponseParameters()

const Aws::Map<Aws::String, Aws::String>& Aws::APIGateway::Model::IntegrationResponse::GetResponseParameters ( ) const
inline

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.

Definition at line 206 of file IntegrationResponse.h.

◆ GetResponseTemplates()

const Aws::Map<Aws::String, Aws::String>& Aws::APIGateway::Model::IntegrationResponse::GetResponseTemplates ( ) const
inline

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.

Definition at line 406 of file IntegrationResponse.h.

◆ GetSelectionPattern()

const Aws::String& Aws::APIGateway::Model::IntegrationResponse::GetSelectionPattern ( ) const
inline

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 AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

Definition at line 105 of file IntegrationResponse.h.

◆ GetStatusCode()

const Aws::String& Aws::APIGateway::Model::IntegrationResponse::GetStatusCode ( ) const
inline

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

Definition at line 50 of file IntegrationResponse.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::APIGateway::Model::IntegrationResponse::Jsonize ( ) const

◆ operator=()

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ ResponseParametersHasBeenSet()

bool Aws::APIGateway::Model::IntegrationResponse::ResponseParametersHasBeenSet ( ) const
inline

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.

Definition at line 222 of file IntegrationResponse.h.

◆ ResponseTemplatesHasBeenSet()

bool Aws::APIGateway::Model::IntegrationResponse::ResponseTemplatesHasBeenSet ( ) const
inline

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.

Definition at line 413 of file IntegrationResponse.h.

◆ SelectionPatternHasBeenSet()

bool Aws::APIGateway::Model::IntegrationResponse::SelectionPatternHasBeenSet ( ) const
inline

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 AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

Definition at line 117 of file IntegrationResponse.h.

◆ SetContentHandling() [1/2]

void Aws::APIGateway::Model::IntegrationResponse::SetContentHandling ( const ContentHandlingStrategy value)
inline

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 method response without modification.

Definition at line 527 of file IntegrationResponse.h.

◆ SetContentHandling() [2/2]

void Aws::APIGateway::Model::IntegrationResponse::SetContentHandling ( ContentHandlingStrategy &&  value)
inline

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 method response without modification.

Definition at line 539 of file IntegrationResponse.h.

◆ SetResponseParameters() [1/2]

void Aws::APIGateway::Model::IntegrationResponse::SetResponseParameters ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 254 of file IntegrationResponse.h.

◆ SetResponseParameters() [2/2]

void Aws::APIGateway::Model::IntegrationResponse::SetResponseParameters ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 238 of file IntegrationResponse.h.

◆ SetResponseTemplates() [1/2]

void Aws::APIGateway::Model::IntegrationResponse::SetResponseTemplates ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 427 of file IntegrationResponse.h.

◆ SetResponseTemplates() [2/2]

void Aws::APIGateway::Model::IntegrationResponse::SetResponseTemplates ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 420 of file IntegrationResponse.h.

◆ SetSelectionPattern() [1/3]

void Aws::APIGateway::Model::IntegrationResponse::SetSelectionPattern ( Aws::String &&  value)
inline

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 AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

Definition at line 141 of file IntegrationResponse.h.

◆ SetSelectionPattern() [2/3]

void Aws::APIGateway::Model::IntegrationResponse::SetSelectionPattern ( const Aws::String value)
inline

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 AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

Definition at line 129 of file IntegrationResponse.h.

◆ SetSelectionPattern() [3/3]

void Aws::APIGateway::Model::IntegrationResponse::SetSelectionPattern ( const char *  value)
inline

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 AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

Definition at line 153 of file IntegrationResponse.h.

◆ SetStatusCode() [1/3]

void Aws::APIGateway::Model::IntegrationResponse::SetStatusCode ( Aws::String &&  value)
inline

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

Definition at line 68 of file IntegrationResponse.h.

◆ SetStatusCode() [2/3]

void Aws::APIGateway::Model::IntegrationResponse::SetStatusCode ( const Aws::String value)
inline

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

Definition at line 62 of file IntegrationResponse.h.

◆ SetStatusCode() [3/3]

void Aws::APIGateway::Model::IntegrationResponse::SetStatusCode ( const char *  value)
inline

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

Definition at line 74 of file IntegrationResponse.h.

◆ StatusCodeHasBeenSet()

bool Aws::APIGateway::Model::IntegrationResponse::StatusCodeHasBeenSet ( ) const
inline

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

Definition at line 56 of file IntegrationResponse.h.

◆ WithContentHandling() [1/2]

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::WithContentHandling ( const ContentHandlingStrategy value)
inline

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 method response without modification.

Definition at line 551 of file IntegrationResponse.h.

◆ WithContentHandling() [2/2]

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::WithContentHandling ( ContentHandlingStrategy &&  value)
inline

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 method response without modification.

Definition at line 563 of file IntegrationResponse.h.

◆ WithResponseParameters() [1/2]

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::WithResponseParameters ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 286 of file IntegrationResponse.h.

◆ WithResponseParameters() [2/2]

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::WithResponseParameters ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 270 of file IntegrationResponse.h.

◆ WithResponseTemplates() [1/2]

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::WithResponseTemplates ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 441 of file IntegrationResponse.h.

◆ WithResponseTemplates() [2/2]

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::WithResponseTemplates ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 434 of file IntegrationResponse.h.

◆ WithSelectionPattern() [1/3]

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::WithSelectionPattern ( Aws::String &&  value)
inline

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 AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

Definition at line 177 of file IntegrationResponse.h.

◆ WithSelectionPattern() [2/3]

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::WithSelectionPattern ( const Aws::String value)
inline

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 AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

Definition at line 165 of file IntegrationResponse.h.

◆ WithSelectionPattern() [3/3]

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::WithSelectionPattern ( const char *  value)
inline

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 AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

Definition at line 189 of file IntegrationResponse.h.

◆ WithStatusCode() [1/3]

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::WithStatusCode ( Aws::String &&  value)
inline

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

Definition at line 86 of file IntegrationResponse.h.

◆ WithStatusCode() [2/3]

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::WithStatusCode ( const Aws::String value)
inline

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

Definition at line 80 of file IntegrationResponse.h.

◆ WithStatusCode() [3/3]

IntegrationResponse& Aws::APIGateway::Model::IntegrationResponse::WithStatusCode ( const char *  value)
inline

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

Definition at line 92 of file IntegrationResponse.h.


The documentation for this class was generated from the following file: