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

#include <PutIntegrationResponseRequest.h>

+ Inheritance diagram for Aws::APIGateway::Model::PutIntegrationResponseRequest:

Public Member Functions

 PutIntegrationResponseRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetRestApiId () const
 
bool RestApiIdHasBeenSet () const
 
void SetRestApiId (const Aws::String &value)
 
void SetRestApiId (Aws::String &&value)
 
void SetRestApiId (const char *value)
 
PutIntegrationResponseRequestWithRestApiId (const Aws::String &value)
 
PutIntegrationResponseRequestWithRestApiId (Aws::String &&value)
 
PutIntegrationResponseRequestWithRestApiId (const char *value)
 
const Aws::StringGetResourceId () const
 
bool ResourceIdHasBeenSet () const
 
void SetResourceId (const Aws::String &value)
 
void SetResourceId (Aws::String &&value)
 
void SetResourceId (const char *value)
 
PutIntegrationResponseRequestWithResourceId (const Aws::String &value)
 
PutIntegrationResponseRequestWithResourceId (Aws::String &&value)
 
PutIntegrationResponseRequestWithResourceId (const char *value)
 
const Aws::StringGetHttpMethod () const
 
bool HttpMethodHasBeenSet () const
 
void SetHttpMethod (const Aws::String &value)
 
void SetHttpMethod (Aws::String &&value)
 
void SetHttpMethod (const char *value)
 
PutIntegrationResponseRequestWithHttpMethod (const Aws::String &value)
 
PutIntegrationResponseRequestWithHttpMethod (Aws::String &&value)
 
PutIntegrationResponseRequestWithHttpMethod (const char *value)
 
const Aws::StringGetStatusCode () const
 
bool StatusCodeHasBeenSet () const
 
void SetStatusCode (const Aws::String &value)
 
void SetStatusCode (Aws::String &&value)
 
void SetStatusCode (const char *value)
 
PutIntegrationResponseRequestWithStatusCode (const Aws::String &value)
 
PutIntegrationResponseRequestWithStatusCode (Aws::String &&value)
 
PutIntegrationResponseRequestWithStatusCode (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)
 
PutIntegrationResponseRequestWithSelectionPattern (const Aws::String &value)
 
PutIntegrationResponseRequestWithSelectionPattern (Aws::String &&value)
 
PutIntegrationResponseRequestWithSelectionPattern (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)
 
PutIntegrationResponseRequestWithResponseParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
PutIntegrationResponseRequestWithResponseParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
PutIntegrationResponseRequestAddResponseParameters (const Aws::String &key, const Aws::String &value)
 
PutIntegrationResponseRequestAddResponseParameters (Aws::String &&key, const Aws::String &value)
 
PutIntegrationResponseRequestAddResponseParameters (const Aws::String &key, Aws::String &&value)
 
PutIntegrationResponseRequestAddResponseParameters (Aws::String &&key, Aws::String &&value)
 
PutIntegrationResponseRequestAddResponseParameters (const char *key, Aws::String &&value)
 
PutIntegrationResponseRequestAddResponseParameters (Aws::String &&key, const char *value)
 
PutIntegrationResponseRequestAddResponseParameters (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)
 
PutIntegrationResponseRequestWithResponseTemplates (const Aws::Map< Aws::String, Aws::String > &value)
 
PutIntegrationResponseRequestWithResponseTemplates (Aws::Map< Aws::String, Aws::String > &&value)
 
PutIntegrationResponseRequestAddResponseTemplates (const Aws::String &key, const Aws::String &value)
 
PutIntegrationResponseRequestAddResponseTemplates (Aws::String &&key, const Aws::String &value)
 
PutIntegrationResponseRequestAddResponseTemplates (const Aws::String &key, Aws::String &&value)
 
PutIntegrationResponseRequestAddResponseTemplates (Aws::String &&key, Aws::String &&value)
 
PutIntegrationResponseRequestAddResponseTemplates (const char *key, Aws::String &&value)
 
PutIntegrationResponseRequestAddResponseTemplates (Aws::String &&key, const char *value)
 
PutIntegrationResponseRequestAddResponseTemplates (const char *key, const char *value)
 
const ContentHandlingStrategyGetContentHandling () const
 
bool ContentHandlingHasBeenSet () const
 
void SetContentHandling (const ContentHandlingStrategy &value)
 
void SetContentHandling (ContentHandlingStrategy &&value)
 
PutIntegrationResponseRequestWithContentHandling (const ContentHandlingStrategy &value)
 
PutIntegrationResponseRequestWithContentHandling (ContentHandlingStrategy &&value)
 
- Public Member Functions inherited from Aws::APIGateway::APIGatewayRequest
virtual ~APIGatewayRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::APIGateway::APIGatewayRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Represents a put integration response request.

See Also:

AWS API Reference

Definition at line 26 of file PutIntegrationResponseRequest.h.

Constructor & Destructor Documentation

◆ PutIntegrationResponseRequest()

Aws::APIGateway::Model::PutIntegrationResponseRequest::PutIntegrationResponseRequest ( )

Member Function Documentation

◆ AddResponseParameters() [1/7]

PutIntegrationResponseRequest& Aws::APIGateway::Model::PutIntegrationResponseRequest::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 must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

Definition at line 419 of file PutIntegrationResponseRequest.h.

◆ AddResponseParameters() [2/7]

PutIntegrationResponseRequest& Aws::APIGateway::Model::PutIntegrationResponseRequest::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 must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

Definition at line 387 of file PutIntegrationResponseRequest.h.

◆ AddResponseParameters() [3/7]

PutIntegrationResponseRequest& Aws::APIGateway::Model::PutIntegrationResponseRequest::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 must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

Definition at line 451 of file PutIntegrationResponseRequest.h.

◆ AddResponseParameters() [4/7]

PutIntegrationResponseRequest& Aws::APIGateway::Model::PutIntegrationResponseRequest::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 must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

Definition at line 403 of file PutIntegrationResponseRequest.h.

◆ AddResponseParameters() [5/7]

PutIntegrationResponseRequest& Aws::APIGateway::Model::PutIntegrationResponseRequest::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 must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

Definition at line 371 of file PutIntegrationResponseRequest.h.

◆ AddResponseParameters() [6/7]

PutIntegrationResponseRequest& Aws::APIGateway::Model::PutIntegrationResponseRequest::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 must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

Definition at line 435 of file PutIntegrationResponseRequest.h.

◆ AddResponseParameters() [7/7]

PutIntegrationResponseRequest& Aws::APIGateway::Model::PutIntegrationResponseRequest::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 must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

Definition at line 467 of file PutIntegrationResponseRequest.h.

◆ AddResponseTemplates() [1/7]

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

Specifies a put integration response's templates.

Definition at line 518 of file PutIntegrationResponseRequest.h.

◆ AddResponseTemplates() [2/7]

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

Specifies a put integration response's templates.

Definition at line 508 of file PutIntegrationResponseRequest.h.

◆ AddResponseTemplates() [3/7]

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

Specifies a put integration response's templates.

Definition at line 528 of file PutIntegrationResponseRequest.h.

◆ AddResponseTemplates() [4/7]

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

Specifies a put integration response's templates.

Definition at line 513 of file PutIntegrationResponseRequest.h.

◆ AddResponseTemplates() [5/7]

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

Specifies a put integration response's templates.

Definition at line 503 of file PutIntegrationResponseRequest.h.

◆ AddResponseTemplates() [6/7]

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

Specifies a put integration response's templates.

Definition at line 523 of file PutIntegrationResponseRequest.h.

◆ AddResponseTemplates() [7/7]

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

Specifies a put integration response's templates.

Definition at line 533 of file PutIntegrationResponseRequest.h.

◆ ContentHandlingHasBeenSet()

bool Aws::APIGateway::Model::PutIntegrationResponseRequest::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 558 of file PutIntegrationResponseRequest.h.

◆ GetContentHandling()

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

◆ GetHttpMethod()

const Aws::String& Aws::APIGateway::Model::PutIntegrationResponseRequest::GetHttpMethod ( ) const
inline

[Required] Specifies a put integration response request's HTTP method.

Definition at line 133 of file PutIntegrationResponseRequest.h.

◆ GetResourceId()

const Aws::String& Aws::APIGateway::Model::PutIntegrationResponseRequest::GetResourceId ( ) const
inline

[Required] Specifies a put integration response request's resource identifier.

Definition at line 85 of file PutIntegrationResponseRequest.h.

◆ GetResponseParameters()

const Aws::Map<Aws::String, Aws::String>& Aws::APIGateway::Model::PutIntegrationResponseRequest::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 must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

Definition at line 275 of file PutIntegrationResponseRequest.h.

◆ GetResponseTemplates()

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

Specifies a put integration response's templates.

Definition at line 473 of file PutIntegrationResponseRequest.h.

◆ GetRestApiId()

const Aws::String& Aws::APIGateway::Model::PutIntegrationResponseRequest::GetRestApiId ( ) const
inline

[Required] The string identifier of the associated RestApi.

Definition at line 43 of file PutIntegrationResponseRequest.h.

◆ GetSelectionPattern()

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

Specifies the selection pattern of a put integration response.

Definition at line 223 of file PutIntegrationResponseRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::APIGateway::Model::PutIntegrationResponseRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file PutIntegrationResponseRequest.h.

◆ GetStatusCode()

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

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

Definition at line 175 of file PutIntegrationResponseRequest.h.

◆ HttpMethodHasBeenSet()

bool Aws::APIGateway::Model::PutIntegrationResponseRequest::HttpMethodHasBeenSet ( ) const
inline

[Required] Specifies a put integration response request's HTTP method.

Definition at line 138 of file PutIntegrationResponseRequest.h.

◆ ResourceIdHasBeenSet()

bool Aws::APIGateway::Model::PutIntegrationResponseRequest::ResourceIdHasBeenSet ( ) const
inline

[Required] Specifies a put integration response request's resource identifier.

Definition at line 91 of file PutIntegrationResponseRequest.h.

◆ ResponseParametersHasBeenSet()

bool Aws::APIGateway::Model::PutIntegrationResponseRequest::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 must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

Definition at line 291 of file PutIntegrationResponseRequest.h.

◆ ResponseTemplatesHasBeenSet()

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

Specifies a put integration response's templates.

Definition at line 478 of file PutIntegrationResponseRequest.h.

◆ RestApiIdHasBeenSet()

bool Aws::APIGateway::Model::PutIntegrationResponseRequest::RestApiIdHasBeenSet ( ) const
inline

[Required] The string identifier of the associated RestApi.

Definition at line 48 of file PutIntegrationResponseRequest.h.

◆ SelectionPatternHasBeenSet()

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

Specifies the selection pattern of a put integration response.

Definition at line 228 of file PutIntegrationResponseRequest.h.

◆ SerializePayload()

Aws::String Aws::APIGateway::Model::PutIntegrationResponseRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetContentHandling() [1/2]

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

◆ SetContentHandling() [2/2]

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

◆ SetHttpMethod() [1/3]

void Aws::APIGateway::Model::PutIntegrationResponseRequest::SetHttpMethod ( Aws::String &&  value)
inline

[Required] Specifies a put integration response request's HTTP method.

Definition at line 148 of file PutIntegrationResponseRequest.h.

◆ SetHttpMethod() [2/3]

void Aws::APIGateway::Model::PutIntegrationResponseRequest::SetHttpMethod ( const Aws::String value)
inline

[Required] Specifies a put integration response request's HTTP method.

Definition at line 143 of file PutIntegrationResponseRequest.h.

◆ SetHttpMethod() [3/3]

void Aws::APIGateway::Model::PutIntegrationResponseRequest::SetHttpMethod ( const char *  value)
inline

[Required] Specifies a put integration response request's HTTP method.

Definition at line 153 of file PutIntegrationResponseRequest.h.

◆ SetResourceId() [1/3]

void Aws::APIGateway::Model::PutIntegrationResponseRequest::SetResourceId ( Aws::String &&  value)
inline

[Required] Specifies a put integration response request's resource identifier.

Definition at line 103 of file PutIntegrationResponseRequest.h.

◆ SetResourceId() [2/3]

void Aws::APIGateway::Model::PutIntegrationResponseRequest::SetResourceId ( const Aws::String value)
inline

[Required] Specifies a put integration response request's resource identifier.

Definition at line 97 of file PutIntegrationResponseRequest.h.

◆ SetResourceId() [3/3]

void Aws::APIGateway::Model::PutIntegrationResponseRequest::SetResourceId ( const char *  value)
inline

[Required] Specifies a put integration response request's resource identifier.

Definition at line 109 of file PutIntegrationResponseRequest.h.

◆ SetResponseParameters() [1/2]

void Aws::APIGateway::Model::PutIntegrationResponseRequest::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 must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

Definition at line 323 of file PutIntegrationResponseRequest.h.

◆ SetResponseParameters() [2/2]

void Aws::APIGateway::Model::PutIntegrationResponseRequest::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 must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

Definition at line 307 of file PutIntegrationResponseRequest.h.

◆ SetResponseTemplates() [1/2]

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

Specifies a put integration response's templates.

Definition at line 488 of file PutIntegrationResponseRequest.h.

◆ SetResponseTemplates() [2/2]

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

Specifies a put integration response's templates.

Definition at line 483 of file PutIntegrationResponseRequest.h.

◆ SetRestApiId() [1/3]

void Aws::APIGateway::Model::PutIntegrationResponseRequest::SetRestApiId ( Aws::String &&  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 58 of file PutIntegrationResponseRequest.h.

◆ SetRestApiId() [2/3]

void Aws::APIGateway::Model::PutIntegrationResponseRequest::SetRestApiId ( const Aws::String value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 53 of file PutIntegrationResponseRequest.h.

◆ SetRestApiId() [3/3]

void Aws::APIGateway::Model::PutIntegrationResponseRequest::SetRestApiId ( const char *  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 63 of file PutIntegrationResponseRequest.h.

◆ SetSelectionPattern() [1/3]

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

Specifies the selection pattern of a put integration response.

Definition at line 238 of file PutIntegrationResponseRequest.h.

◆ SetSelectionPattern() [2/3]

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

Specifies the selection pattern of a put integration response.

Definition at line 233 of file PutIntegrationResponseRequest.h.

◆ SetSelectionPattern() [3/3]

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

Specifies the selection pattern of a put integration response.

Definition at line 243 of file PutIntegrationResponseRequest.h.

◆ SetStatusCode() [1/3]

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

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

Definition at line 193 of file PutIntegrationResponseRequest.h.

◆ SetStatusCode() [2/3]

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

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

Definition at line 187 of file PutIntegrationResponseRequest.h.

◆ SetStatusCode() [3/3]

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

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

Definition at line 199 of file PutIntegrationResponseRequest.h.

◆ StatusCodeHasBeenSet()

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

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

Definition at line 181 of file PutIntegrationResponseRequest.h.

◆ WithContentHandling() [1/2]

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

◆ WithContentHandling() [2/2]

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

◆ WithHttpMethod() [1/3]

PutIntegrationResponseRequest& Aws::APIGateway::Model::PutIntegrationResponseRequest::WithHttpMethod ( Aws::String &&  value)
inline

[Required] Specifies a put integration response request's HTTP method.

Definition at line 163 of file PutIntegrationResponseRequest.h.

◆ WithHttpMethod() [2/3]

PutIntegrationResponseRequest& Aws::APIGateway::Model::PutIntegrationResponseRequest::WithHttpMethod ( const Aws::String value)
inline

[Required] Specifies a put integration response request's HTTP method.

Definition at line 158 of file PutIntegrationResponseRequest.h.

◆ WithHttpMethod() [3/3]

PutIntegrationResponseRequest& Aws::APIGateway::Model::PutIntegrationResponseRequest::WithHttpMethod ( const char *  value)
inline

[Required] Specifies a put integration response request's HTTP method.

Definition at line 168 of file PutIntegrationResponseRequest.h.

◆ WithResourceId() [1/3]

PutIntegrationResponseRequest& Aws::APIGateway::Model::PutIntegrationResponseRequest::WithResourceId ( Aws::String &&  value)
inline

[Required] Specifies a put integration response request's resource identifier.

Definition at line 121 of file PutIntegrationResponseRequest.h.

◆ WithResourceId() [2/3]

PutIntegrationResponseRequest& Aws::APIGateway::Model::PutIntegrationResponseRequest::WithResourceId ( const Aws::String value)
inline

[Required] Specifies a put integration response request's resource identifier.

Definition at line 115 of file PutIntegrationResponseRequest.h.

◆ WithResourceId() [3/3]

PutIntegrationResponseRequest& Aws::APIGateway::Model::PutIntegrationResponseRequest::WithResourceId ( const char *  value)
inline

[Required] Specifies a put integration response request's resource identifier.

Definition at line 127 of file PutIntegrationResponseRequest.h.

◆ WithResponseParameters() [1/2]

PutIntegrationResponseRequest& Aws::APIGateway::Model::PutIntegrationResponseRequest::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 must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

Definition at line 355 of file PutIntegrationResponseRequest.h.

◆ WithResponseParameters() [2/2]

PutIntegrationResponseRequest& Aws::APIGateway::Model::PutIntegrationResponseRequest::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 must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

Definition at line 339 of file PutIntegrationResponseRequest.h.

◆ WithResponseTemplates() [1/2]

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

Specifies a put integration response's templates.

Definition at line 498 of file PutIntegrationResponseRequest.h.

◆ WithResponseTemplates() [2/2]

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

Specifies a put integration response's templates.

Definition at line 493 of file PutIntegrationResponseRequest.h.

◆ WithRestApiId() [1/3]

PutIntegrationResponseRequest& Aws::APIGateway::Model::PutIntegrationResponseRequest::WithRestApiId ( Aws::String &&  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 73 of file PutIntegrationResponseRequest.h.

◆ WithRestApiId() [2/3]

PutIntegrationResponseRequest& Aws::APIGateway::Model::PutIntegrationResponseRequest::WithRestApiId ( const Aws::String value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 68 of file PutIntegrationResponseRequest.h.

◆ WithRestApiId() [3/3]

PutIntegrationResponseRequest& Aws::APIGateway::Model::PutIntegrationResponseRequest::WithRestApiId ( const char *  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 78 of file PutIntegrationResponseRequest.h.

◆ WithSelectionPattern() [1/3]

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

Specifies the selection pattern of a put integration response.

Definition at line 253 of file PutIntegrationResponseRequest.h.

◆ WithSelectionPattern() [2/3]

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

Specifies the selection pattern of a put integration response.

Definition at line 248 of file PutIntegrationResponseRequest.h.

◆ WithSelectionPattern() [3/3]

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

Specifies the selection pattern of a put integration response.

Definition at line 258 of file PutIntegrationResponseRequest.h.

◆ WithStatusCode() [1/3]

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

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

Definition at line 211 of file PutIntegrationResponseRequest.h.

◆ WithStatusCode() [2/3]

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

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

Definition at line 205 of file PutIntegrationResponseRequest.h.

◆ WithStatusCode() [3/3]

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

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

Definition at line 217 of file PutIntegrationResponseRequest.h.


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