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

#include <UpdateIntegrationResponseResult.h>

Public Member Functions

 UpdateIntegrationResponseResult ()
 
 UpdateIntegrationResponseResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
UpdateIntegrationResponseResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetStatusCode () const
 
void SetStatusCode (const Aws::String &value)
 
void SetStatusCode (Aws::String &&value)
 
void SetStatusCode (const char *value)
 
UpdateIntegrationResponseResultWithStatusCode (const Aws::String &value)
 
UpdateIntegrationResponseResultWithStatusCode (Aws::String &&value)
 
UpdateIntegrationResponseResultWithStatusCode (const char *value)
 
const Aws::StringGetSelectionPattern () const
 
void SetSelectionPattern (const Aws::String &value)
 
void SetSelectionPattern (Aws::String &&value)
 
void SetSelectionPattern (const char *value)
 
UpdateIntegrationResponseResultWithSelectionPattern (const Aws::String &value)
 
UpdateIntegrationResponseResultWithSelectionPattern (Aws::String &&value)
 
UpdateIntegrationResponseResultWithSelectionPattern (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetResponseParameters () const
 
void SetResponseParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetResponseParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
UpdateIntegrationResponseResultWithResponseParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
UpdateIntegrationResponseResultWithResponseParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
UpdateIntegrationResponseResultAddResponseParameters (const Aws::String &key, const Aws::String &value)
 
UpdateIntegrationResponseResultAddResponseParameters (Aws::String &&key, const Aws::String &value)
 
UpdateIntegrationResponseResultAddResponseParameters (const Aws::String &key, Aws::String &&value)
 
UpdateIntegrationResponseResultAddResponseParameters (Aws::String &&key, Aws::String &&value)
 
UpdateIntegrationResponseResultAddResponseParameters (const char *key, Aws::String &&value)
 
UpdateIntegrationResponseResultAddResponseParameters (Aws::String &&key, const char *value)
 
UpdateIntegrationResponseResultAddResponseParameters (const char *key, const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetResponseTemplates () const
 
void SetResponseTemplates (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetResponseTemplates (Aws::Map< Aws::String, Aws::String > &&value)
 
UpdateIntegrationResponseResultWithResponseTemplates (const Aws::Map< Aws::String, Aws::String > &value)
 
UpdateIntegrationResponseResultWithResponseTemplates (Aws::Map< Aws::String, Aws::String > &&value)
 
UpdateIntegrationResponseResultAddResponseTemplates (const Aws::String &key, const Aws::String &value)
 
UpdateIntegrationResponseResultAddResponseTemplates (Aws::String &&key, const Aws::String &value)
 
UpdateIntegrationResponseResultAddResponseTemplates (const Aws::String &key, Aws::String &&value)
 
UpdateIntegrationResponseResultAddResponseTemplates (Aws::String &&key, Aws::String &&value)
 
UpdateIntegrationResponseResultAddResponseTemplates (const char *key, Aws::String &&value)
 
UpdateIntegrationResponseResultAddResponseTemplates (Aws::String &&key, const char *value)
 
UpdateIntegrationResponseResultAddResponseTemplates (const char *key, const char *value)
 
const ContentHandlingStrategyGetContentHandling () const
 
void SetContentHandling (const ContentHandlingStrategy &value)
 
void SetContentHandling (ContentHandlingStrategy &&value)
 
UpdateIntegrationResponseResultWithContentHandling (const ContentHandlingStrategy &value)
 
UpdateIntegrationResponseResultWithContentHandling (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 38 of file UpdateIntegrationResponseResult.h.

Constructor & Destructor Documentation

◆ UpdateIntegrationResponseResult() [1/2]

Aws::APIGateway::Model::UpdateIntegrationResponseResult::UpdateIntegrationResponseResult ( )

◆ UpdateIntegrationResponseResult() [2/2]

Aws::APIGateway::Model::UpdateIntegrationResponseResult::UpdateIntegrationResponseResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ AddResponseParameters() [1/7]

UpdateIntegrationResponseResult& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 316 of file UpdateIntegrationResponseResult.h.

◆ AddResponseParameters() [2/7]

UpdateIntegrationResponseResult& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 284 of file UpdateIntegrationResponseResult.h.

◆ AddResponseParameters() [3/7]

UpdateIntegrationResponseResult& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 348 of file UpdateIntegrationResponseResult.h.

◆ AddResponseParameters() [4/7]

UpdateIntegrationResponseResult& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 300 of file UpdateIntegrationResponseResult.h.

◆ AddResponseParameters() [5/7]

UpdateIntegrationResponseResult& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 268 of file UpdateIntegrationResponseResult.h.

◆ AddResponseParameters() [6/7]

UpdateIntegrationResponseResult& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 332 of file UpdateIntegrationResponseResult.h.

◆ AddResponseParameters() [7/7]

UpdateIntegrationResponseResult& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 364 of file UpdateIntegrationResponseResult.h.

◆ AddResponseTemplates() [1/7]

UpdateIntegrationResponseResult& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 428 of file UpdateIntegrationResponseResult.h.

◆ AddResponseTemplates() [2/7]

UpdateIntegrationResponseResult& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 414 of file UpdateIntegrationResponseResult.h.

◆ AddResponseTemplates() [3/7]

UpdateIntegrationResponseResult& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 442 of file UpdateIntegrationResponseResult.h.

◆ AddResponseTemplates() [4/7]

UpdateIntegrationResponseResult& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 421 of file UpdateIntegrationResponseResult.h.

◆ AddResponseTemplates() [5/7]

UpdateIntegrationResponseResult& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 407 of file UpdateIntegrationResponseResult.h.

◆ AddResponseTemplates() [6/7]

UpdateIntegrationResponseResult& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 435 of file UpdateIntegrationResponseResult.h.

◆ AddResponseTemplates() [7/7]

UpdateIntegrationResponseResult& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 449 of file UpdateIntegrationResponseResult.h.

◆ GetContentHandling()

const ContentHandlingStrategy& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 462 of file UpdateIntegrationResponseResult.h.

◆ GetResponseParameters()

const Aws::Map<Aws::String, Aws::String>& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 188 of file UpdateIntegrationResponseResult.h.

◆ GetResponseTemplates()

const Aws::Map<Aws::String, Aws::String>& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 372 of file UpdateIntegrationResponseResult.h.

◆ GetSelectionPattern()

const Aws::String& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 99 of file UpdateIntegrationResponseResult.h.

◆ GetStatusCode()

const Aws::String& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 UpdateIntegrationResponseResult.h.

◆ operator=()

UpdateIntegrationResponseResult& Aws::APIGateway::Model::UpdateIntegrationResponseResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetContentHandling() [1/2]

void Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 474 of file UpdateIntegrationResponseResult.h.

◆ SetContentHandling() [2/2]

void Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 486 of file UpdateIntegrationResponseResult.h.

◆ SetResponseParameters() [1/2]

void Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 220 of file UpdateIntegrationResponseResult.h.

◆ SetResponseParameters() [2/2]

void Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 204 of file UpdateIntegrationResponseResult.h.

◆ SetResponseTemplates() [1/2]

void Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 386 of file UpdateIntegrationResponseResult.h.

◆ SetResponseTemplates() [2/2]

void Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 379 of file UpdateIntegrationResponseResult.h.

◆ SetSelectionPattern() [1/3]

void Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 123 of file UpdateIntegrationResponseResult.h.

◆ SetSelectionPattern() [2/3]

void Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 111 of file UpdateIntegrationResponseResult.h.

◆ SetSelectionPattern() [3/3]

void Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 135 of file UpdateIntegrationResponseResult.h.

◆ SetStatusCode() [1/3]

void Aws::APIGateway::Model::UpdateIntegrationResponseResult::SetStatusCode ( 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 UpdateIntegrationResponseResult.h.

◆ SetStatusCode() [2/3]

void Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 56 of file UpdateIntegrationResponseResult.h.

◆ SetStatusCode() [3/3]

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

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

Definition at line 68 of file UpdateIntegrationResponseResult.h.

◆ WithContentHandling() [1/2]

UpdateIntegrationResponseResult& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 498 of file UpdateIntegrationResponseResult.h.

◆ WithContentHandling() [2/2]

UpdateIntegrationResponseResult& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 510 of file UpdateIntegrationResponseResult.h.

◆ WithResponseParameters() [1/2]

UpdateIntegrationResponseResult& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 252 of file UpdateIntegrationResponseResult.h.

◆ WithResponseParameters() [2/2]

UpdateIntegrationResponseResult& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 236 of file UpdateIntegrationResponseResult.h.

◆ WithResponseTemplates() [1/2]

UpdateIntegrationResponseResult& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 400 of file UpdateIntegrationResponseResult.h.

◆ WithResponseTemplates() [2/2]

UpdateIntegrationResponseResult& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 393 of file UpdateIntegrationResponseResult.h.

◆ WithSelectionPattern() [1/3]

UpdateIntegrationResponseResult& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 159 of file UpdateIntegrationResponseResult.h.

◆ WithSelectionPattern() [2/3]

UpdateIntegrationResponseResult& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 147 of file UpdateIntegrationResponseResult.h.

◆ WithSelectionPattern() [3/3]

UpdateIntegrationResponseResult& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 171 of file UpdateIntegrationResponseResult.h.

◆ WithStatusCode() [1/3]

UpdateIntegrationResponseResult& Aws::APIGateway::Model::UpdateIntegrationResponseResult::WithStatusCode ( 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 UpdateIntegrationResponseResult.h.

◆ WithStatusCode() [2/3]

UpdateIntegrationResponseResult& Aws::APIGateway::Model::UpdateIntegrationResponseResult::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 74 of file UpdateIntegrationResponseResult.h.

◆ WithStatusCode() [3/3]

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

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

Definition at line 86 of file UpdateIntegrationResponseResult.h.


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