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

#include <PutIntegrationResult.h>

Public Member Functions

 PutIntegrationResult ()
 
 PutIntegrationResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
PutIntegrationResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const IntegrationTypeGetType () const
 
void SetType (const IntegrationType &value)
 
void SetType (IntegrationType &&value)
 
PutIntegrationResultWithType (const IntegrationType &value)
 
PutIntegrationResultWithType (IntegrationType &&value)
 
const Aws::StringGetHttpMethod () const
 
void SetHttpMethod (const Aws::String &value)
 
void SetHttpMethod (Aws::String &&value)
 
void SetHttpMethod (const char *value)
 
PutIntegrationResultWithHttpMethod (const Aws::String &value)
 
PutIntegrationResultWithHttpMethod (Aws::String &&value)
 
PutIntegrationResultWithHttpMethod (const char *value)
 
const Aws::StringGetUri () const
 
void SetUri (const Aws::String &value)
 
void SetUri (Aws::String &&value)
 
void SetUri (const char *value)
 
PutIntegrationResultWithUri (const Aws::String &value)
 
PutIntegrationResultWithUri (Aws::String &&value)
 
PutIntegrationResultWithUri (const char *value)
 
const ConnectionTypeGetConnectionType () const
 
void SetConnectionType (const ConnectionType &value)
 
void SetConnectionType (ConnectionType &&value)
 
PutIntegrationResultWithConnectionType (const ConnectionType &value)
 
PutIntegrationResultWithConnectionType (ConnectionType &&value)
 
const Aws::StringGetConnectionId () const
 
void SetConnectionId (const Aws::String &value)
 
void SetConnectionId (Aws::String &&value)
 
void SetConnectionId (const char *value)
 
PutIntegrationResultWithConnectionId (const Aws::String &value)
 
PutIntegrationResultWithConnectionId (Aws::String &&value)
 
PutIntegrationResultWithConnectionId (const char *value)
 
const Aws::StringGetCredentials () const
 
void SetCredentials (const Aws::String &value)
 
void SetCredentials (Aws::String &&value)
 
void SetCredentials (const char *value)
 
PutIntegrationResultWithCredentials (const Aws::String &value)
 
PutIntegrationResultWithCredentials (Aws::String &&value)
 
PutIntegrationResultWithCredentials (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetRequestParameters () const
 
void SetRequestParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetRequestParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
PutIntegrationResultWithRequestParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
PutIntegrationResultWithRequestParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
PutIntegrationResultAddRequestParameters (const Aws::String &key, const Aws::String &value)
 
PutIntegrationResultAddRequestParameters (Aws::String &&key, const Aws::String &value)
 
PutIntegrationResultAddRequestParameters (const Aws::String &key, Aws::String &&value)
 
PutIntegrationResultAddRequestParameters (Aws::String &&key, Aws::String &&value)
 
PutIntegrationResultAddRequestParameters (const char *key, Aws::String &&value)
 
PutIntegrationResultAddRequestParameters (Aws::String &&key, const char *value)
 
PutIntegrationResultAddRequestParameters (const char *key, const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetRequestTemplates () const
 
void SetRequestTemplates (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetRequestTemplates (Aws::Map< Aws::String, Aws::String > &&value)
 
PutIntegrationResultWithRequestTemplates (const Aws::Map< Aws::String, Aws::String > &value)
 
PutIntegrationResultWithRequestTemplates (Aws::Map< Aws::String, Aws::String > &&value)
 
PutIntegrationResultAddRequestTemplates (const Aws::String &key, const Aws::String &value)
 
PutIntegrationResultAddRequestTemplates (Aws::String &&key, const Aws::String &value)
 
PutIntegrationResultAddRequestTemplates (const Aws::String &key, Aws::String &&value)
 
PutIntegrationResultAddRequestTemplates (Aws::String &&key, Aws::String &&value)
 
PutIntegrationResultAddRequestTemplates (const char *key, Aws::String &&value)
 
PutIntegrationResultAddRequestTemplates (Aws::String &&key, const char *value)
 
PutIntegrationResultAddRequestTemplates (const char *key, const char *value)
 
const Aws::StringGetPassthroughBehavior () const
 
void SetPassthroughBehavior (const Aws::String &value)
 
void SetPassthroughBehavior (Aws::String &&value)
 
void SetPassthroughBehavior (const char *value)
 
PutIntegrationResultWithPassthroughBehavior (const Aws::String &value)
 
PutIntegrationResultWithPassthroughBehavior (Aws::String &&value)
 
PutIntegrationResultWithPassthroughBehavior (const char *value)
 
const ContentHandlingStrategyGetContentHandling () const
 
void SetContentHandling (const ContentHandlingStrategy &value)
 
void SetContentHandling (ContentHandlingStrategy &&value)
 
PutIntegrationResultWithContentHandling (const ContentHandlingStrategy &value)
 
PutIntegrationResultWithContentHandling (ContentHandlingStrategy &&value)
 
int GetTimeoutInMillis () const
 
void SetTimeoutInMillis (int value)
 
PutIntegrationResultWithTimeoutInMillis (int value)
 
const Aws::StringGetCacheNamespace () const
 
void SetCacheNamespace (const Aws::String &value)
 
void SetCacheNamespace (Aws::String &&value)
 
void SetCacheNamespace (const char *value)
 
PutIntegrationResultWithCacheNamespace (const Aws::String &value)
 
PutIntegrationResultWithCacheNamespace (Aws::String &&value)
 
PutIntegrationResultWithCacheNamespace (const char *value)
 
const Aws::Vector< Aws::String > & GetCacheKeyParameters () const
 
void SetCacheKeyParameters (const Aws::Vector< Aws::String > &value)
 
void SetCacheKeyParameters (Aws::Vector< Aws::String > &&value)
 
PutIntegrationResultWithCacheKeyParameters (const Aws::Vector< Aws::String > &value)
 
PutIntegrationResultWithCacheKeyParameters (Aws::Vector< Aws::String > &&value)
 
PutIntegrationResultAddCacheKeyParameters (const Aws::String &value)
 
PutIntegrationResultAddCacheKeyParameters (Aws::String &&value)
 
PutIntegrationResultAddCacheKeyParameters (const char *value)
 
const Aws::Map< Aws::String, IntegrationResponse > & GetIntegrationResponses () const
 
void SetIntegrationResponses (const Aws::Map< Aws::String, IntegrationResponse > &value)
 
void SetIntegrationResponses (Aws::Map< Aws::String, IntegrationResponse > &&value)
 
PutIntegrationResultWithIntegrationResponses (const Aws::Map< Aws::String, IntegrationResponse > &value)
 
PutIntegrationResultWithIntegrationResponses (Aws::Map< Aws::String, IntegrationResponse > &&value)
 
PutIntegrationResultAddIntegrationResponses (const Aws::String &key, const IntegrationResponse &value)
 
PutIntegrationResultAddIntegrationResponses (Aws::String &&key, const IntegrationResponse &value)
 
PutIntegrationResultAddIntegrationResponses (const Aws::String &key, IntegrationResponse &&value)
 
PutIntegrationResultAddIntegrationResponses (Aws::String &&key, IntegrationResponse &&value)
 
PutIntegrationResultAddIntegrationResponses (const char *key, IntegrationResponse &&value)
 
PutIntegrationResultAddIntegrationResponses (const char *key, const IntegrationResponse &value)
 
const TlsConfigGetTlsConfig () const
 
void SetTlsConfig (const TlsConfig &value)
 
void SetTlsConfig (TlsConfig &&value)
 
PutIntegrationResultWithTlsConfig (const TlsConfig &value)
 
PutIntegrationResultWithTlsConfig (TlsConfig &&value)
 

Detailed Description

Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.

In the API Gateway console, the built-in Lambda integration is an AWS integration.

See Also:

AWS API Reference

Definition at line 43 of file PutIntegrationResult.h.

Constructor & Destructor Documentation

◆ PutIntegrationResult() [1/2]

Aws::APIGateway::Model::PutIntegrationResult::PutIntegrationResult ( )

◆ PutIntegrationResult() [2/2]

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

Member Function Documentation

◆ AddCacheKeyParameters() [1/3]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::AddCacheKeyParameters ( Aws::String &&  value)
inline

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

Definition at line 1215 of file PutIntegrationResult.h.

◆ AddCacheKeyParameters() [2/3]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::AddCacheKeyParameters ( const Aws::String value)
inline

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

Definition at line 1208 of file PutIntegrationResult.h.

◆ AddCacheKeyParameters() [3/3]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::AddCacheKeyParameters ( const char *  value)
inline

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

Definition at line 1222 of file PutIntegrationResult.h.

◆ AddIntegrationResponses() [1/6]

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

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200
HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response
The successful response returns 200 OK status and a payload as follows:
{ "_links": { "curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true }, "self": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"title": "200" }, "integrationresponse:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
}, "integrationresponse:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
} }, "responseParameters": { "method.response.header.Content-Type":
"'application/xml'" }, "responseTemplates": { "application/json":
"$util.urlDecode(\"%3CkinesisStreams%3E::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%3E")
" }, "statusCode": "200" }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html">Creating an API

Definition at line 1419 of file PutIntegrationResult.h.

◆ AddIntegrationResponses() [2/6]

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

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200
HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response
The successful response returns 200 OK status and a payload as follows:
{ "_links": { "curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true }, "self": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"title": "200" }, "integrationresponse:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
}, "integrationresponse:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
} }, "responseParameters": { "method.response.header.Content-Type":
"'application/xml'" }, "responseTemplates": { "application/json":
"$util.urlDecode(\"%3CkinesisStreams%3E::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%3E")
" }, "statusCode": "200" }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html">Creating an API

Definition at line 1475 of file PutIntegrationResult.h.

◆ AddIntegrationResponses() [3/6]

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

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200
HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response
The successful response returns 200 OK status and a payload as follows:
{ "_links": { "curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true }, "self": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"title": "200" }, "integrationresponse:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
}, "integrationresponse:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
} }, "responseParameters": { "method.response.header.Content-Type":
"'application/xml'" }, "responseTemplates": { "application/json":
"$util.urlDecode(\"%3CkinesisStreams%3E::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%3E")
" }, "statusCode": "200" }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html">Creating an API

Definition at line 1391 of file PutIntegrationResult.h.

◆ AddIntegrationResponses() [4/6]

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

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200
HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response
The successful response returns 200 OK status and a payload as follows:
{ "_links": { "curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true }, "self": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"title": "200" }, "integrationresponse:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
}, "integrationresponse:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
} }, "responseParameters": { "method.response.header.Content-Type":
"'application/xml'" }, "responseTemplates": { "application/json":
"$util.urlDecode(\"%3CkinesisStreams%3E::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%3E")
" }, "statusCode": "200" }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html">Creating an API

Definition at line 1447 of file PutIntegrationResult.h.

◆ AddIntegrationResponses() [5/6]

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

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200
HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response
The successful response returns 200 OK status and a payload as follows:
{ "_links": { "curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true }, "self": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"title": "200" }, "integrationresponse:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
}, "integrationresponse:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
} }, "responseParameters": { "method.response.header.Content-Type":
"'application/xml'" }, "responseTemplates": { "application/json":
"$util.urlDecode(\"%3CkinesisStreams%3E::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%3E")
" }, "statusCode": "200" }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html">Creating an API

Definition at line 1531 of file PutIntegrationResult.h.

◆ AddIntegrationResponses() [6/6]

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

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200
HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response
The successful response returns 200 OK status and a payload as follows:
{ "_links": { "curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true }, "self": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"title": "200" }, "integrationresponse:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
}, "integrationresponse:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
} }, "responseParameters": { "method.response.header.Content-Type":
"'application/xml'" }, "responseTemplates": { "application/json":
"$util.urlDecode(\"%3CkinesisStreams%3E::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%3E")
" }, "statusCode": "200" }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html">Creating an API

Definition at line 1503 of file PutIntegrationResult.h.

◆ AddRequestParameters() [1/7]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::AddRequestParameters ( Aws::String &&  key,
Aws::String &&  value 
)
inline

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

Definition at line 723 of file PutIntegrationResult.h.

◆ AddRequestParameters() [2/7]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::AddRequestParameters ( Aws::String &&  key,
const Aws::String value 
)
inline

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

Definition at line 699 of file PutIntegrationResult.h.

◆ AddRequestParameters() [3/7]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::AddRequestParameters ( Aws::String &&  key,
const char *  value 
)
inline

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

Definition at line 747 of file PutIntegrationResult.h.

◆ AddRequestParameters() [4/7]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::AddRequestParameters ( const Aws::String key,
Aws::String &&  value 
)
inline

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

Definition at line 711 of file PutIntegrationResult.h.

◆ AddRequestParameters() [5/7]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::AddRequestParameters ( const Aws::String key,
const Aws::String value 
)
inline

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

Definition at line 687 of file PutIntegrationResult.h.

◆ AddRequestParameters() [6/7]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::AddRequestParameters ( const char *  key,
Aws::String &&  value 
)
inline

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

Definition at line 735 of file PutIntegrationResult.h.

◆ AddRequestParameters() [7/7]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::AddRequestParameters ( const char *  key,
const char *  value 
)
inline

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

Definition at line 759 of file PutIntegrationResult.h.

◆ AddRequestTemplates() [1/7]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::AddRequestTemplates ( Aws::String &&  key,
Aws::String &&  value 
)
inline

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

Definition at line 832 of file PutIntegrationResult.h.

◆ AddRequestTemplates() [2/7]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::AddRequestTemplates ( Aws::String &&  key,
const Aws::String value 
)
inline

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

Definition at line 816 of file PutIntegrationResult.h.

◆ AddRequestTemplates() [3/7]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::AddRequestTemplates ( Aws::String &&  key,
const char *  value 
)
inline

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

Definition at line 848 of file PutIntegrationResult.h.

◆ AddRequestTemplates() [4/7]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::AddRequestTemplates ( const Aws::String key,
Aws::String &&  value 
)
inline

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

Definition at line 824 of file PutIntegrationResult.h.

◆ AddRequestTemplates() [5/7]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::AddRequestTemplates ( const Aws::String key,
const Aws::String value 
)
inline

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

Definition at line 808 of file PutIntegrationResult.h.

◆ AddRequestTemplates() [6/7]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::AddRequestTemplates ( const char *  key,
Aws::String &&  value 
)
inline

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

Definition at line 840 of file PutIntegrationResult.h.

◆ AddRequestTemplates() [7/7]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::AddRequestTemplates ( const char *  key,
const char *  value 
)
inline

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

Definition at line 856 of file PutIntegrationResult.h.

◆ GetCacheKeyParameters()

const Aws::Vector<Aws::String>& Aws::APIGateway::Model::PutIntegrationResult::GetCacheKeyParameters ( ) const
inline

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

Definition at line 1173 of file PutIntegrationResult.h.

◆ GetCacheNamespace()

const Aws::String& Aws::APIGateway::Model::PutIntegrationResult::GetCacheNamespace ( ) const
inline

Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

Definition at line 1117 of file PutIntegrationResult.h.

◆ GetConnectionId()

const Aws::String& Aws::APIGateway::Model::PutIntegrationResult::GetConnectionId ( ) const
inline

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

Definition at line 495 of file PutIntegrationResult.h.

◆ GetConnectionType()

const ConnectionType& Aws::APIGateway::Model::PutIntegrationResult::GetConnectionType ( ) const
inline

The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

Definition at line 450 of file PutIntegrationResult.h.

◆ GetContentHandling()

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

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

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

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

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

Definition at line 1033 of file PutIntegrationResult.h.

◆ GetCredentials()

const Aws::String& Aws::APIGateway::Model::PutIntegrationResult::GetCredentials ( ) const
inline

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.

Definition at line 554 of file PutIntegrationResult.h.

◆ GetHttpMethod()

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

Specifies the integration's HTTP method type.

Definition at line 185 of file PutIntegrationResult.h.

◆ GetIntegrationResponses()

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

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200
HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response
The successful response returns 200 OK status and a payload as follows:
{ "_links": { "curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true }, "self": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"title": "200" }, "integrationresponse:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
}, "integrationresponse:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
} }, "responseParameters": { "method.response.header.Content-Type":
"'application/xml'" }, "responseTemplates": { "application/json":
"$util.urlDecode(\"%3CkinesisStreams%3E::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%3E")
" }, "statusCode": "200" }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html">Creating an API

Definition at line 1251 of file PutIntegrationResult.h.

◆ GetPassthroughBehavior()

const Aws::String& Aws::APIGateway::Model::PutIntegrationResult::GetPassthroughBehavior ( ) const
inline
Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:
  • WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
  • WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
  • NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

Definition at line 880 of file PutIntegrationResult.h.

◆ GetRequestParameters()

const Aws::Map<Aws::String, Aws::String>& Aws::APIGateway::Model::PutIntegrationResult::GetRequestParameters ( ) const
inline

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

Definition at line 627 of file PutIntegrationResult.h.

◆ GetRequestTemplates()

const Aws::Map<Aws::String, Aws::String>& Aws::APIGateway::Model::PutIntegrationResult::GetRequestTemplates ( ) const
inline

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

Definition at line 768 of file PutIntegrationResult.h.

◆ GetTimeoutInMillis()

int Aws::APIGateway::Model::PutIntegrationResult::GetTimeoutInMillis ( ) const
inline

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

Definition at line 1096 of file PutIntegrationResult.h.

◆ GetTlsConfig()

const TlsConfig& Aws::APIGateway::Model::PutIntegrationResult::GetTlsConfig ( ) const
inline

Specifies the TLS configuration for an integration.

Definition at line 1537 of file PutIntegrationResult.h.

◆ GetType()

const IntegrationType& Aws::APIGateway::Model::PutIntegrationResult::GetType ( ) const
inline

Specifies an API method integration type. The valid value is one of the following:

  • AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
  • AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
  • HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
  • HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
  • MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

Definition at line 75 of file PutIntegrationResult.h.

◆ GetUri()

const Aws::String& Aws::APIGateway::Model::PutIntegrationResult::GetUri ( ) const
inline

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

  • For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

  • For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

Definition at line 248 of file PutIntegrationResult.h.

◆ operator=()

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

◆ SetCacheKeyParameters() [1/2]

void Aws::APIGateway::Model::PutIntegrationResult::SetCacheKeyParameters ( Aws::Vector< Aws::String > &&  value)
inline

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

Definition at line 1187 of file PutIntegrationResult.h.

◆ SetCacheKeyParameters() [2/2]

void Aws::APIGateway::Model::PutIntegrationResult::SetCacheKeyParameters ( const Aws::Vector< Aws::String > &  value)
inline

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

Definition at line 1180 of file PutIntegrationResult.h.

◆ SetCacheNamespace() [1/3]

void Aws::APIGateway::Model::PutIntegrationResult::SetCacheNamespace ( Aws::String &&  value)
inline

Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

Definition at line 1133 of file PutIntegrationResult.h.

◆ SetCacheNamespace() [2/3]

void Aws::APIGateway::Model::PutIntegrationResult::SetCacheNamespace ( const Aws::String value)
inline

Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

Definition at line 1125 of file PutIntegrationResult.h.

◆ SetCacheNamespace() [3/3]

void Aws::APIGateway::Model::PutIntegrationResult::SetCacheNamespace ( const char *  value)
inline

Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

Definition at line 1141 of file PutIntegrationResult.h.

◆ SetConnectionId() [1/3]

void Aws::APIGateway::Model::PutIntegrationResult::SetConnectionId ( Aws::String &&  value)
inline

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

Definition at line 511 of file PutIntegrationResult.h.

◆ SetConnectionId() [2/3]

void Aws::APIGateway::Model::PutIntegrationResult::SetConnectionId ( const Aws::String value)
inline

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

Definition at line 503 of file PutIntegrationResult.h.

◆ SetConnectionId() [3/3]

void Aws::APIGateway::Model::PutIntegrationResult::SetConnectionId ( const char *  value)
inline

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

Definition at line 519 of file PutIntegrationResult.h.

◆ SetConnectionType() [1/2]

void Aws::APIGateway::Model::PutIntegrationResult::SetConnectionType ( ConnectionType &&  value)
inline

The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

Definition at line 468 of file PutIntegrationResult.h.

◆ SetConnectionType() [2/2]

void Aws::APIGateway::Model::PutIntegrationResult::SetConnectionType ( const ConnectionType value)
inline

The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

Definition at line 459 of file PutIntegrationResult.h.

◆ SetContentHandling() [1/2]

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

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

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

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

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

Definition at line 1047 of file PutIntegrationResult.h.

◆ SetContentHandling() [2/2]

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

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

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

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

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

Definition at line 1061 of file PutIntegrationResult.h.

◆ SetCredentials() [1/3]

void Aws::APIGateway::Model::PutIntegrationResult::SetCredentials ( Aws::String &&  value)
inline

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.

Definition at line 574 of file PutIntegrationResult.h.

◆ SetCredentials() [2/3]

void Aws::APIGateway::Model::PutIntegrationResult::SetCredentials ( const Aws::String value)
inline

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.

Definition at line 564 of file PutIntegrationResult.h.

◆ SetCredentials() [3/3]

void Aws::APIGateway::Model::PutIntegrationResult::SetCredentials ( const char *  value)
inline

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.

Definition at line 584 of file PutIntegrationResult.h.

◆ SetHttpMethod() [1/3]

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

Specifies the integration's HTTP method type.

Definition at line 195 of file PutIntegrationResult.h.

◆ SetHttpMethod() [2/3]

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

Specifies the integration's HTTP method type.

Definition at line 190 of file PutIntegrationResult.h.

◆ SetHttpMethod() [3/3]

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

Specifies the integration's HTTP method type.

Definition at line 200 of file PutIntegrationResult.h.

◆ SetIntegrationResponses() [1/2]

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

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200
HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response
The successful response returns 200 OK status and a payload as follows:
{ "_links": { "curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true }, "self": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"title": "200" }, "integrationresponse:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
}, "integrationresponse:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
} }, "responseParameters": { "method.response.header.Content-Type":
"'application/xml'" }, "responseTemplates": { "application/json":
"$util.urlDecode(\"%3CkinesisStreams%3E::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%3E")
" }, "statusCode": "200" }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html">Creating an API

Definition at line 1307 of file PutIntegrationResult.h.

◆ SetIntegrationResponses() [2/2]

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

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200
HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response
The successful response returns 200 OK status and a payload as follows:
{ "_links": { "curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true }, "self": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"title": "200" }, "integrationresponse:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
}, "integrationresponse:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
} }, "responseParameters": { "method.response.header.Content-Type":
"'application/xml'" }, "responseTemplates": { "application/json":
"$util.urlDecode(\"%3CkinesisStreams%3E::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%3E")
" }, "statusCode": "200" }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html">Creating an API

Definition at line 1279 of file PutIntegrationResult.h.

◆ SetPassthroughBehavior() [1/3]

void Aws::APIGateway::Model::PutIntegrationResult::SetPassthroughBehavior ( Aws::String &&  value)
inline
Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:
  • WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
  • WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
  • NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

Definition at line 926 of file PutIntegrationResult.h.

◆ SetPassthroughBehavior() [2/3]

void Aws::APIGateway::Model::PutIntegrationResult::SetPassthroughBehavior ( const Aws::String value)
inline
Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:
  • WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
  • WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
  • NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

Definition at line 903 of file PutIntegrationResult.h.

◆ SetPassthroughBehavior() [3/3]

void Aws::APIGateway::Model::PutIntegrationResult::SetPassthroughBehavior ( const char *  value)
inline
Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:
  • WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
  • WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
  • NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

Definition at line 949 of file PutIntegrationResult.h.

◆ SetRequestParameters() [1/2]

void Aws::APIGateway::Model::PutIntegrationResult::SetRequestParameters ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

Definition at line 651 of file PutIntegrationResult.h.

◆ SetRequestParameters() [2/2]

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

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

Definition at line 639 of file PutIntegrationResult.h.

◆ SetRequestTemplates() [1/2]

void Aws::APIGateway::Model::PutIntegrationResult::SetRequestTemplates ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

Definition at line 784 of file PutIntegrationResult.h.

◆ SetRequestTemplates() [2/2]

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

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

Definition at line 776 of file PutIntegrationResult.h.

◆ SetTimeoutInMillis()

void Aws::APIGateway::Model::PutIntegrationResult::SetTimeoutInMillis ( int  value)
inline

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

Definition at line 1102 of file PutIntegrationResult.h.

◆ SetTlsConfig() [1/2]

void Aws::APIGateway::Model::PutIntegrationResult::SetTlsConfig ( const TlsConfig value)
inline

Specifies the TLS configuration for an integration.

Definition at line 1542 of file PutIntegrationResult.h.

◆ SetTlsConfig() [2/2]

void Aws::APIGateway::Model::PutIntegrationResult::SetTlsConfig ( TlsConfig &&  value)
inline

Specifies the TLS configuration for an integration.

Definition at line 1547 of file PutIntegrationResult.h.

◆ SetType() [1/2]

void Aws::APIGateway::Model::PutIntegrationResult::SetType ( const IntegrationType value)
inline

Specifies an API method integration type. The valid value is one of the following:

  • AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
  • AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
  • HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
  • HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
  • MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

Definition at line 101 of file PutIntegrationResult.h.

◆ SetType() [2/2]

void Aws::APIGateway::Model::PutIntegrationResult::SetType ( IntegrationType &&  value)
inline

Specifies an API method integration type. The valid value is one of the following:

  • AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
  • AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
  • HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
  • HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
  • MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

Definition at line 127 of file PutIntegrationResult.h.

◆ SetUri() [1/3]

void Aws::APIGateway::Model::PutIntegrationResult::SetUri ( Aws::String &&  value)
inline

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

  • For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

  • For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

Definition at line 312 of file PutIntegrationResult.h.

◆ SetUri() [2/3]

void Aws::APIGateway::Model::PutIntegrationResult::SetUri ( const Aws::String value)
inline

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

  • For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

  • For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

Definition at line 280 of file PutIntegrationResult.h.

◆ SetUri() [3/3]

void Aws::APIGateway::Model::PutIntegrationResult::SetUri ( const char *  value)
inline

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

  • For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

  • For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

Definition at line 344 of file PutIntegrationResult.h.

◆ WithCacheKeyParameters() [1/2]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithCacheKeyParameters ( Aws::Vector< Aws::String > &&  value)
inline

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

Definition at line 1201 of file PutIntegrationResult.h.

◆ WithCacheKeyParameters() [2/2]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithCacheKeyParameters ( const Aws::Vector< Aws::String > &  value)
inline

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

Definition at line 1194 of file PutIntegrationResult.h.

◆ WithCacheNamespace() [1/3]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithCacheNamespace ( Aws::String &&  value)
inline

Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

Definition at line 1157 of file PutIntegrationResult.h.

◆ WithCacheNamespace() [2/3]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithCacheNamespace ( const Aws::String value)
inline

Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

Definition at line 1149 of file PutIntegrationResult.h.

◆ WithCacheNamespace() [3/3]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithCacheNamespace ( const char *  value)
inline

Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

Definition at line 1165 of file PutIntegrationResult.h.

◆ WithConnectionId() [1/3]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithConnectionId ( Aws::String &&  value)
inline

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

Definition at line 535 of file PutIntegrationResult.h.

◆ WithConnectionId() [2/3]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithConnectionId ( const Aws::String value)
inline

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

Definition at line 527 of file PutIntegrationResult.h.

◆ WithConnectionId() [3/3]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithConnectionId ( const char *  value)
inline

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

Definition at line 543 of file PutIntegrationResult.h.

◆ WithConnectionType() [1/2]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithConnectionType ( ConnectionType &&  value)
inline

The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

Definition at line 486 of file PutIntegrationResult.h.

◆ WithConnectionType() [2/2]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithConnectionType ( const ConnectionType value)
inline

The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

Definition at line 477 of file PutIntegrationResult.h.

◆ WithContentHandling() [1/2]

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

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

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

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

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

Definition at line 1075 of file PutIntegrationResult.h.

◆ WithContentHandling() [2/2]

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

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

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

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

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

Definition at line 1089 of file PutIntegrationResult.h.

◆ WithCredentials() [1/3]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithCredentials ( Aws::String &&  value)
inline

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.

Definition at line 604 of file PutIntegrationResult.h.

◆ WithCredentials() [2/3]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithCredentials ( const Aws::String value)
inline

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.

Definition at line 594 of file PutIntegrationResult.h.

◆ WithCredentials() [3/3]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithCredentials ( const char *  value)
inline

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.

Definition at line 614 of file PutIntegrationResult.h.

◆ WithHttpMethod() [1/3]

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

Specifies the integration's HTTP method type.

Definition at line 210 of file PutIntegrationResult.h.

◆ WithHttpMethod() [2/3]

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

Specifies the integration's HTTP method type.

Definition at line 205 of file PutIntegrationResult.h.

◆ WithHttpMethod() [3/3]

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

Specifies the integration's HTTP method type.

Definition at line 215 of file PutIntegrationResult.h.

◆ WithIntegrationResponses() [1/2]

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

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200
HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response
The successful response returns 200 OK status and a payload as follows:
{ "_links": { "curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true }, "self": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"title": "200" }, "integrationresponse:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
}, "integrationresponse:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
} }, "responseParameters": { "method.response.header.Content-Type":
"'application/xml'" }, "responseTemplates": { "application/json":
"$util.urlDecode(\"%3CkinesisStreams%3E::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%3E")
" }, "statusCode": "200" }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html">Creating an API

Definition at line 1363 of file PutIntegrationResult.h.

◆ WithIntegrationResponses() [2/2]

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

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200
HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response
The successful response returns 200 OK status and a payload as follows:
{ "_links": { "curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true }, "self": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"title": "200" }, "integrationresponse:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
}, "integrationresponse:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
} }, "responseParameters": { "method.response.header.Content-Type":
"'application/xml'" }, "responseTemplates": { "application/json":
"$util.urlDecode(\"%3CkinesisStreams%3E::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%3E")
" }, "statusCode": "200" }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html">Creating an API

Definition at line 1335 of file PutIntegrationResult.h.

◆ WithPassthroughBehavior() [1/3]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithPassthroughBehavior ( Aws::String &&  value)
inline
Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:
  • WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
  • WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
  • NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

Definition at line 995 of file PutIntegrationResult.h.

◆ WithPassthroughBehavior() [2/3]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithPassthroughBehavior ( const Aws::String value)
inline
Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:
  • WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
  • WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
  • NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

Definition at line 972 of file PutIntegrationResult.h.

◆ WithPassthroughBehavior() [3/3]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithPassthroughBehavior ( const char *  value)
inline
Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:
  • WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
  • WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
  • NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

Definition at line 1018 of file PutIntegrationResult.h.

◆ WithRequestParameters() [1/2]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithRequestParameters ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

Definition at line 675 of file PutIntegrationResult.h.

◆ WithRequestParameters() [2/2]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithRequestParameters ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

Definition at line 663 of file PutIntegrationResult.h.

◆ WithRequestTemplates() [1/2]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithRequestTemplates ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

Definition at line 800 of file PutIntegrationResult.h.

◆ WithRequestTemplates() [2/2]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithRequestTemplates ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

Definition at line 792 of file PutIntegrationResult.h.

◆ WithTimeoutInMillis()

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithTimeoutInMillis ( int  value)
inline

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

Definition at line 1108 of file PutIntegrationResult.h.

◆ WithTlsConfig() [1/2]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithTlsConfig ( const TlsConfig value)
inline

Specifies the TLS configuration for an integration.

Definition at line 1552 of file PutIntegrationResult.h.

◆ WithTlsConfig() [2/2]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithTlsConfig ( TlsConfig &&  value)
inline

Specifies the TLS configuration for an integration.

Definition at line 1557 of file PutIntegrationResult.h.

◆ WithType() [1/2]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithType ( const IntegrationType value)
inline

Specifies an API method integration type. The valid value is one of the following:

  • AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
  • AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
  • HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
  • HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
  • MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

Definition at line 153 of file PutIntegrationResult.h.

◆ WithType() [2/2]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithType ( IntegrationType &&  value)
inline

Specifies an API method integration type. The valid value is one of the following:

  • AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
  • AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
  • HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
  • HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
  • MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

Definition at line 179 of file PutIntegrationResult.h.

◆ WithUri() [1/3]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithUri ( Aws::String &&  value)
inline

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

  • For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

  • For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

Definition at line 408 of file PutIntegrationResult.h.

◆ WithUri() [2/3]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithUri ( const Aws::String value)
inline

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

  • For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

  • For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

Definition at line 376 of file PutIntegrationResult.h.

◆ WithUri() [3/3]

PutIntegrationResult& Aws::APIGateway::Model::PutIntegrationResult::WithUri ( const char *  value)
inline

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

  • For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

  • For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

Definition at line 440 of file PutIntegrationResult.h.


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