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

#include <GetMethodResult.h>

Public Member Functions

 GetMethodResult ()
 
 GetMethodResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
GetMethodResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetHttpMethod () const
 
void SetHttpMethod (const Aws::String &value)
 
void SetHttpMethod (Aws::String &&value)
 
void SetHttpMethod (const char *value)
 
GetMethodResultWithHttpMethod (const Aws::String &value)
 
GetMethodResultWithHttpMethod (Aws::String &&value)
 
GetMethodResultWithHttpMethod (const char *value)
 
const Aws::StringGetAuthorizationType () const
 
void SetAuthorizationType (const Aws::String &value)
 
void SetAuthorizationType (Aws::String &&value)
 
void SetAuthorizationType (const char *value)
 
GetMethodResultWithAuthorizationType (const Aws::String &value)
 
GetMethodResultWithAuthorizationType (Aws::String &&value)
 
GetMethodResultWithAuthorizationType (const char *value)
 
const Aws::StringGetAuthorizerId () const
 
void SetAuthorizerId (const Aws::String &value)
 
void SetAuthorizerId (Aws::String &&value)
 
void SetAuthorizerId (const char *value)
 
GetMethodResultWithAuthorizerId (const Aws::String &value)
 
GetMethodResultWithAuthorizerId (Aws::String &&value)
 
GetMethodResultWithAuthorizerId (const char *value)
 
bool GetApiKeyRequired () const
 
void SetApiKeyRequired (bool value)
 
GetMethodResultWithApiKeyRequired (bool value)
 
const Aws::StringGetRequestValidatorId () const
 
void SetRequestValidatorId (const Aws::String &value)
 
void SetRequestValidatorId (Aws::String &&value)
 
void SetRequestValidatorId (const char *value)
 
GetMethodResultWithRequestValidatorId (const Aws::String &value)
 
GetMethodResultWithRequestValidatorId (Aws::String &&value)
 
GetMethodResultWithRequestValidatorId (const char *value)
 
const Aws::StringGetOperationName () const
 
void SetOperationName (const Aws::String &value)
 
void SetOperationName (Aws::String &&value)
 
void SetOperationName (const char *value)
 
GetMethodResultWithOperationName (const Aws::String &value)
 
GetMethodResultWithOperationName (Aws::String &&value)
 
GetMethodResultWithOperationName (const char *value)
 
const Aws::Map< Aws::String, bool > & GetRequestParameters () const
 
void SetRequestParameters (const Aws::Map< Aws::String, bool > &value)
 
void SetRequestParameters (Aws::Map< Aws::String, bool > &&value)
 
GetMethodResultWithRequestParameters (const Aws::Map< Aws::String, bool > &value)
 
GetMethodResultWithRequestParameters (Aws::Map< Aws::String, bool > &&value)
 
GetMethodResultAddRequestParameters (const Aws::String &key, bool value)
 
GetMethodResultAddRequestParameters (Aws::String &&key, bool value)
 
GetMethodResultAddRequestParameters (const char *key, bool value)
 
const Aws::Map< Aws::String, Aws::String > & GetRequestModels () const
 
void SetRequestModels (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetRequestModels (Aws::Map< Aws::String, Aws::String > &&value)
 
GetMethodResultWithRequestModels (const Aws::Map< Aws::String, Aws::String > &value)
 
GetMethodResultWithRequestModels (Aws::Map< Aws::String, Aws::String > &&value)
 
GetMethodResultAddRequestModels (const Aws::String &key, const Aws::String &value)
 
GetMethodResultAddRequestModels (Aws::String &&key, const Aws::String &value)
 
GetMethodResultAddRequestModels (const Aws::String &key, Aws::String &&value)
 
GetMethodResultAddRequestModels (Aws::String &&key, Aws::String &&value)
 
GetMethodResultAddRequestModels (const char *key, Aws::String &&value)
 
GetMethodResultAddRequestModels (Aws::String &&key, const char *value)
 
GetMethodResultAddRequestModels (const char *key, const char *value)
 
const Aws::Map< Aws::String, MethodResponse > & GetMethodResponses () const
 
void SetMethodResponses (const Aws::Map< Aws::String, MethodResponse > &value)
 
void SetMethodResponses (Aws::Map< Aws::String, MethodResponse > &&value)
 
GetMethodResultWithMethodResponses (const Aws::Map< Aws::String, MethodResponse > &value)
 
GetMethodResultWithMethodResponses (Aws::Map< Aws::String, MethodResponse > &&value)
 
GetMethodResultAddMethodResponses (const Aws::String &key, const MethodResponse &value)
 
GetMethodResultAddMethodResponses (Aws::String &&key, const MethodResponse &value)
 
GetMethodResultAddMethodResponses (const Aws::String &key, MethodResponse &&value)
 
GetMethodResultAddMethodResponses (Aws::String &&key, MethodResponse &&value)
 
GetMethodResultAddMethodResponses (const char *key, MethodResponse &&value)
 
GetMethodResultAddMethodResponses (const char *key, const MethodResponse &value)
 
const IntegrationGetMethodIntegration () const
 
void SetMethodIntegration (const Integration &value)
 
void SetMethodIntegration (Integration &&value)
 
GetMethodResultWithMethodIntegration (const Integration &value)
 
GetMethodResultWithMethodIntegration (Integration &&value)
 
const Aws::Vector< Aws::String > & GetAuthorizationScopes () const
 
void SetAuthorizationScopes (const Aws::Vector< Aws::String > &value)
 
void SetAuthorizationScopes (Aws::Vector< Aws::String > &&value)
 
GetMethodResultWithAuthorizationScopes (const Aws::Vector< Aws::String > &value)
 
GetMethodResultWithAuthorizationScopes (Aws::Vector< Aws::String > &&value)
 
GetMethodResultAddAuthorizationScopes (const Aws::String &value)
 
GetMethodResultAddAuthorizationScopes (Aws::String &&value)
 
GetMethodResultAddAuthorizationScopes (const char *value)
 

Detailed Description

Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.

Example: Retrive the GET method on a specified resource

Request
The following example request retrieves the information about the GET method on an API resource (3kzxbg5sa2) of an API (fugvjdxtri).
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type:
application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date:
20160603T210259Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_links": {
"curies": [ { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html",
"name": "integration", "templated": true }, { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true }, { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html",
"name": "method", "templated": true }, { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html",
"name": "methodresponse", "templated": true } ], "self": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET", "name": "GET", "title":
"GET" }, "integration:put": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" },
"method:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "method:integration":
{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" },
"method:responses": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name":
"200", "title": "200" }, "method:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "methodresponse:put":
{ "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}",
"templated": true } }, "apiKeyRequired": true, "authorizationType": "NONE",
"httpMethod": "GET", "_embedded": { "method:integration": { "_links": { "self":
{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" },
"integration:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" },
"integration:responses": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"name": "200", "title": "200" }, "integration:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" },
"integrationresponse:put": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}",
"templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2",
"credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod":
"POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestParameters": {
"integration.request.header.Content-Type": "'application/x-amz-json-1.1'" },
"requestTemplates": { "application/json": "{\n}" }, "type": "AWS", "uri":
"arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "_embedded": {
"integration:responses": { "_links": { "self": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
"name": "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%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E")"
}, "statusCode": "200" } } }, "method:responses": { "_links": { "self": {
"href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200",
"name": "200", "title": "200" }, "methodresponse:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" },
"methodresponse:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } },
"responseModels": { "application/json": "Empty" }, "responseParameters": {
"method.response.header.Content-Type": false }, "statusCode": "200" } }
}
In the example above, the response template for the 200 OK response maps the JSON output from the ListStreams action in the back end to an XML output. The mapping template is URL-encoded as %3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E and the output is decoded using the $util.urlDecode() helper function.

See Also:

AWS API Reference

Definition at line 121 of file GetMethodResult.h.

Constructor & Destructor Documentation

◆ GetMethodResult() [1/2]

Aws::APIGateway::Model::GetMethodResult::GetMethodResult ( )

◆ GetMethodResult() [2/2]

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

Member Function Documentation

◆ AddAuthorizationScopes() [1/3]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::AddAuthorizationScopes ( Aws::String &&  value)
inline

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Definition at line 1245 of file GetMethodResult.h.

◆ AddAuthorizationScopes() [2/3]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::AddAuthorizationScopes ( const Aws::String value)
inline

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Definition at line 1233 of file GetMethodResult.h.

◆ AddAuthorizationScopes() [3/3]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::AddAuthorizationScopes ( const char *  value)
inline

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Definition at line 1257 of file GetMethodResult.h.

◆ AddMethodResponses() [1/6]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::AddMethodResponses ( Aws::String &&  key,
const MethodResponse value 
)
inline

Gets a method response associated with a given HTTP status code.

The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.

Example: Get a 200 OK response of a GET method

Request
GET
/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1
Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_links": {
"curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html",
"name": "methodresponse", "templated": true }, "self": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title":
"200" }, "methodresponse:delete": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" },
"methodresponse:update": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } },
"responseModels": { "application/json": "Empty" }, "responseParameters": {
"method.response.header.operator": false, "method.response.header.operand_2":
false, "method.response.header.operand_1": false }, "statusCode": "200"
}

Definition at line 775 of file GetMethodResult.h.

◆ AddMethodResponses() [2/6]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::AddMethodResponses ( Aws::String &&  key,
MethodResponse &&  value 
)
inline

Gets a method response associated with a given HTTP status code.

The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.

Example: Get a 200 OK response of a GET method

Request
GET
/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1
Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_links": {
"curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html",
"name": "methodresponse", "templated": true }, "self": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title":
"200" }, "methodresponse:delete": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" },
"methodresponse:update": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } },
"responseModels": { "application/json": "Empty" }, "responseParameters": {
"method.response.header.operator": false, "method.response.header.operand_2":
false, "method.response.header.operand_1": false }, "statusCode": "200"
}

Definition at line 837 of file GetMethodResult.h.

◆ AddMethodResponses() [3/6]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::AddMethodResponses ( const Aws::String key,
const MethodResponse value 
)
inline

Gets a method response associated with a given HTTP status code.

The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.

Example: Get a 200 OK response of a GET method

Request
GET
/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1
Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_links": {
"curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html",
"name": "methodresponse", "templated": true }, "self": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title":
"200" }, "methodresponse:delete": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" },
"methodresponse:update": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } },
"responseModels": { "application/json": "Empty" }, "responseParameters": {
"method.response.header.operator": false, "method.response.header.operand_2":
false, "method.response.header.operand_1": false }, "statusCode": "200"
}

Definition at line 744 of file GetMethodResult.h.

◆ AddMethodResponses() [4/6]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::AddMethodResponses ( const Aws::String key,
MethodResponse &&  value 
)
inline

Gets a method response associated with a given HTTP status code.

The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.

Example: Get a 200 OK response of a GET method

Request
GET
/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1
Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_links": {
"curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html",
"name": "methodresponse", "templated": true }, "self": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title":
"200" }, "methodresponse:delete": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" },
"methodresponse:update": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } },
"responseModels": { "application/json": "Empty" }, "responseParameters": {
"method.response.header.operator": false, "method.response.header.operand_2":
false, "method.response.header.operand_1": false }, "statusCode": "200"
}

Definition at line 806 of file GetMethodResult.h.

◆ AddMethodResponses() [5/6]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::AddMethodResponses ( const char *  key,
const MethodResponse value 
)
inline

Gets a method response associated with a given HTTP status code.

The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.

Example: Get a 200 OK response of a GET method

Request
GET
/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1
Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_links": {
"curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html",
"name": "methodresponse", "templated": true }, "self": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title":
"200" }, "methodresponse:delete": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" },
"methodresponse:update": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } },
"responseModels": { "application/json": "Empty" }, "responseParameters": {
"method.response.header.operator": false, "method.response.header.operand_2":
false, "method.response.header.operand_1": false }, "statusCode": "200"
}

Definition at line 899 of file GetMethodResult.h.

◆ AddMethodResponses() [6/6]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::AddMethodResponses ( const char *  key,
MethodResponse &&  value 
)
inline

Gets a method response associated with a given HTTP status code.

The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.

Example: Get a 200 OK response of a GET method

Request
GET
/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1
Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_links": {
"curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html",
"name": "methodresponse", "templated": true }, "self": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title":
"200" }, "methodresponse:delete": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" },
"methodresponse:update": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } },
"responseModels": { "application/json": "Empty" }, "responseParameters": {
"method.response.header.operator": false, "method.response.header.operand_2":
false, "method.response.header.operand_1": false }, "statusCode": "200"
}

Definition at line 868 of file GetMethodResult.h.

◆ AddRequestModels() [1/7]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::AddRequestModels ( Aws::String &&  key,
Aws::String &&  value 
)
inline

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

Definition at line 536 of file GetMethodResult.h.

◆ AddRequestModels() [2/7]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::AddRequestModels ( Aws::String &&  key,
const Aws::String value 
)
inline

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

Definition at line 522 of file GetMethodResult.h.

◆ AddRequestModels() [3/7]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::AddRequestModels ( Aws::String &&  key,
const char *  value 
)
inline

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

Definition at line 550 of file GetMethodResult.h.

◆ AddRequestModels() [4/7]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::AddRequestModels ( const Aws::String key,
Aws::String &&  value 
)
inline

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

Definition at line 529 of file GetMethodResult.h.

◆ AddRequestModels() [5/7]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::AddRequestModels ( const Aws::String key,
const Aws::String value 
)
inline

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

Definition at line 515 of file GetMethodResult.h.

◆ AddRequestModels() [6/7]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::AddRequestModels ( const char *  key,
Aws::String &&  value 
)
inline

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

Definition at line 543 of file GetMethodResult.h.

◆ AddRequestModels() [7/7]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::AddRequestModels ( const char *  key,
const char *  value 
)
inline

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

Definition at line 557 of file GetMethodResult.h.

◆ AddRequestParameters() [1/3]

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

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

Definition at line 459 of file GetMethodResult.h.

◆ AddRequestParameters() [2/3]

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

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

Definition at line 446 of file GetMethodResult.h.

◆ AddRequestParameters() [3/3]

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

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

Definition at line 472 of file GetMethodResult.h.

◆ GetApiKeyRequired()

bool Aws::APIGateway::Model::GetMethodResult::GetApiKeyRequired ( ) const
inline

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

Definition at line 269 of file GetMethodResult.h.

◆ GetAuthorizationScopes()

const Aws::Vector<Aws::String>& Aws::APIGateway::Model::GetMethodResult::GetAuthorizationScopes ( ) const
inline

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Definition at line 1173 of file GetMethodResult.h.

◆ GetAuthorizationType()

const Aws::String& Aws::APIGateway::Model::GetMethodResult::GetAuthorizationType ( ) const
inline

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

Definition at line 171 of file GetMethodResult.h.

◆ GetAuthorizerId()

const Aws::String& Aws::APIGateway::Model::GetMethodResult::GetAuthorizerId ( ) const
inline

The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

Definition at line 226 of file GetMethodResult.h.

◆ GetHttpMethod()

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

The method's HTTP verb.

Definition at line 132 of file GetMethodResult.h.

◆ GetMethodIntegration()

const Integration& Aws::APIGateway::Model::GetMethodResult::GetMethodIntegration ( ) const
inline

Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.

Example:

Request
GET
/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1
Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_links": {
"curies": [ { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html",
"name": "integration", "templated": true }, { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true } ], "self": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" },
"integration:delete": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" },
"integration:responses": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200",
"name": "200", "title": "200" }, "integration:update": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" },
"integrationresponse:put": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}",
"templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch",
"credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod":
"POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": {
"application/json": "{\n \"a": "$input.params('operand1')",
"b": "$input.params('operand2')",
"op": "$input.params('operator')"
}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": "integration.response.body.a" }, "responseTemplates": { "application/json": "#set($res = $input.path('$'))
{
"result": "$res.a, $res.b, $res.op => $res.c",
"a" : "$res.a",
"b" : "$res.b",
"op" : "$res.op",
"c" : "$res.c"
}" }, "selectionPattern": "", "statusCode": "200" } } }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-integration.html">AWS CLI

Definition at line 952 of file GetMethodResult.h.

◆ GetMethodResponses()

const Aws::Map<Aws::String, MethodResponse>& Aws::APIGateway::Model::GetMethodResult::GetMethodResponses ( ) const
inline

Gets a method response associated with a given HTTP status code.

The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.

Example: Get a 200 OK response of a GET method

Request
GET
/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1
Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_links": {
"curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html",
"name": "methodresponse", "templated": true }, "self": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title":
"200" }, "methodresponse:delete": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" },
"methodresponse:update": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } },
"responseModels": { "application/json": "Empty" }, "responseParameters": {
"method.response.header.operator": false, "method.response.header.operand_2":
false, "method.response.header.operand_1": false }, "statusCode": "200"
}

Definition at line 589 of file GetMethodResult.h.

◆ GetOperationName()

const Aws::String& Aws::APIGateway::Model::GetMethodResult::GetOperationName ( ) const
inline

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

Definition at line 325 of file GetMethodResult.h.

◆ GetRequestModels()

const Aws::Map<Aws::String, Aws::String>& Aws::APIGateway::Model::GetMethodResult::GetRequestModels ( ) const
inline

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

Definition at line 480 of file GetMethodResult.h.

◆ GetRequestParameters()

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

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

Definition at line 381 of file GetMethodResult.h.

◆ GetRequestValidatorId()

const Aws::String& Aws::APIGateway::Model::GetMethodResult::GetRequestValidatorId ( ) const
inline

The identifier of a RequestValidator for request validation.

Definition at line 287 of file GetMethodResult.h.

◆ operator=()

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

◆ SetApiKeyRequired()

void Aws::APIGateway::Model::GetMethodResult::SetApiKeyRequired ( bool  value)
inline

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

Definition at line 275 of file GetMethodResult.h.

◆ SetAuthorizationScopes() [1/2]

void Aws::APIGateway::Model::GetMethodResult::SetAuthorizationScopes ( Aws::Vector< Aws::String > &&  value)
inline

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Definition at line 1197 of file GetMethodResult.h.

◆ SetAuthorizationScopes() [2/2]

void Aws::APIGateway::Model::GetMethodResult::SetAuthorizationScopes ( const Aws::Vector< Aws::String > &  value)
inline

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Definition at line 1185 of file GetMethodResult.h.

◆ SetAuthorizationType() [1/3]

void Aws::APIGateway::Model::GetMethodResult::SetAuthorizationType ( Aws::String &&  value)
inline

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

Definition at line 187 of file GetMethodResult.h.

◆ SetAuthorizationType() [2/3]

void Aws::APIGateway::Model::GetMethodResult::SetAuthorizationType ( const Aws::String value)
inline

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

Definition at line 179 of file GetMethodResult.h.

◆ SetAuthorizationType() [3/3]

void Aws::APIGateway::Model::GetMethodResult::SetAuthorizationType ( const char *  value)
inline

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

Definition at line 195 of file GetMethodResult.h.

◆ SetAuthorizerId() [1/3]

void Aws::APIGateway::Model::GetMethodResult::SetAuthorizerId ( Aws::String &&  value)
inline

The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

Definition at line 238 of file GetMethodResult.h.

◆ SetAuthorizerId() [2/3]

void Aws::APIGateway::Model::GetMethodResult::SetAuthorizerId ( const Aws::String value)
inline

The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

Definition at line 232 of file GetMethodResult.h.

◆ SetAuthorizerId() [3/3]

void Aws::APIGateway::Model::GetMethodResult::SetAuthorizerId ( const char *  value)
inline

The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

Definition at line 244 of file GetMethodResult.h.

◆ SetHttpMethod() [1/3]

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

The method's HTTP verb.

Definition at line 142 of file GetMethodResult.h.

◆ SetHttpMethod() [2/3]

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

The method's HTTP verb.

Definition at line 137 of file GetMethodResult.h.

◆ SetHttpMethod() [3/3]

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

The method's HTTP verb.

Definition at line 147 of file GetMethodResult.h.

◆ SetMethodIntegration() [1/2]

void Aws::APIGateway::Model::GetMethodResult::SetMethodIntegration ( const Integration value)
inline

Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.

Example:

Request
GET
/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1
Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_links": {
"curies": [ { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html",
"name": "integration", "templated": true }, { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true } ], "self": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" },
"integration:delete": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" },
"integration:responses": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200",
"name": "200", "title": "200" }, "integration:update": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" },
"integrationresponse:put": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}",
"templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch",
"credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod":
"POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": {
"application/json": "{\n \"a": "$input.params('operand1')",
"b": "$input.params('operand2')",
"op": "$input.params('operator')"
}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": "integration.response.body.a" }, "responseTemplates": { "application/json": "#set($res = $input.path('$'))
{
"result": "$res.a, $res.b, $res.op => $res.c",
"a" : "$res.a",
"b" : "$res.b",
"op" : "$res.op",
"c" : "$res.c"
}" }, "selectionPattern": "", "statusCode": "200" } } }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-integration.html">AWS CLI

Definition at line 1004 of file GetMethodResult.h.

◆ SetMethodIntegration() [2/2]

void Aws::APIGateway::Model::GetMethodResult::SetMethodIntegration ( Integration &&  value)
inline

Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.

Example:

Request
GET
/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1
Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_links": {
"curies": [ { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html",
"name": "integration", "templated": true }, { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true } ], "self": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" },
"integration:delete": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" },
"integration:responses": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200",
"name": "200", "title": "200" }, "integration:update": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" },
"integrationresponse:put": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}",
"templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch",
"credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod":
"POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": {
"application/json": "{\n \"a": "$input.params('operand1')",
"b": "$input.params('operand2')",
"op": "$input.params('operator')"
}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": "integration.response.body.a" }, "responseTemplates": { "application/json": "#set($res = $input.path('$'))
{
"result": "$res.a, $res.b, $res.op => $res.c",
"a" : "$res.a",
"b" : "$res.b",
"op" : "$res.op",
"c" : "$res.c"
}" }, "selectionPattern": "", "statusCode": "200" } } }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-integration.html">AWS CLI

Definition at line 1056 of file GetMethodResult.h.

◆ SetMethodResponses() [1/2]

void Aws::APIGateway::Model::GetMethodResult::SetMethodResponses ( Aws::Map< Aws::String, MethodResponse > &&  value)
inline

Gets a method response associated with a given HTTP status code.

The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.

Example: Get a 200 OK response of a GET method

Request
GET
/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1
Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_links": {
"curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html",
"name": "methodresponse", "templated": true }, "self": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title":
"200" }, "methodresponse:delete": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" },
"methodresponse:update": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } },
"responseModels": { "application/json": "Empty" }, "responseParameters": {
"method.response.header.operator": false, "method.response.header.operand_2":
false, "method.response.header.operand_1": false }, "statusCode": "200"
}

Definition at line 651 of file GetMethodResult.h.

◆ SetMethodResponses() [2/2]

void Aws::APIGateway::Model::GetMethodResult::SetMethodResponses ( const Aws::Map< Aws::String, MethodResponse > &  value)
inline

Gets a method response associated with a given HTTP status code.

The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.

Example: Get a 200 OK response of a GET method

Request
GET
/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1
Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_links": {
"curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html",
"name": "methodresponse", "templated": true }, "self": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title":
"200" }, "methodresponse:delete": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" },
"methodresponse:update": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } },
"responseModels": { "application/json": "Empty" }, "responseParameters": {
"method.response.header.operator": false, "method.response.header.operand_2":
false, "method.response.header.operand_1": false }, "statusCode": "200"
}

Definition at line 620 of file GetMethodResult.h.

◆ SetOperationName() [1/3]

void Aws::APIGateway::Model::GetMethodResult::SetOperationName ( Aws::String &&  value)
inline

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

Definition at line 339 of file GetMethodResult.h.

◆ SetOperationName() [2/3]

void Aws::APIGateway::Model::GetMethodResult::SetOperationName ( const Aws::String value)
inline

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

Definition at line 332 of file GetMethodResult.h.

◆ SetOperationName() [3/3]

void Aws::APIGateway::Model::GetMethodResult::SetOperationName ( const char *  value)
inline

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

Definition at line 346 of file GetMethodResult.h.

◆ SetRequestModels() [1/2]

void Aws::APIGateway::Model::GetMethodResult::SetRequestModels ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

Definition at line 494 of file GetMethodResult.h.

◆ SetRequestModels() [2/2]

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

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

Definition at line 487 of file GetMethodResult.h.

◆ SetRequestParameters() [1/2]

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

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

Definition at line 407 of file GetMethodResult.h.

◆ SetRequestParameters() [2/2]

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

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

Definition at line 394 of file GetMethodResult.h.

◆ SetRequestValidatorId() [1/3]

void Aws::APIGateway::Model::GetMethodResult::SetRequestValidatorId ( Aws::String &&  value)
inline

The identifier of a RequestValidator for request validation.

Definition at line 297 of file GetMethodResult.h.

◆ SetRequestValidatorId() [2/3]

void Aws::APIGateway::Model::GetMethodResult::SetRequestValidatorId ( const Aws::String value)
inline

The identifier of a RequestValidator for request validation.

Definition at line 292 of file GetMethodResult.h.

◆ SetRequestValidatorId() [3/3]

void Aws::APIGateway::Model::GetMethodResult::SetRequestValidatorId ( const char *  value)
inline

The identifier of a RequestValidator for request validation.

Definition at line 302 of file GetMethodResult.h.

◆ WithApiKeyRequired()

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::WithApiKeyRequired ( bool  value)
inline

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

Definition at line 281 of file GetMethodResult.h.

◆ WithAuthorizationScopes() [1/2]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::WithAuthorizationScopes ( Aws::Vector< Aws::String > &&  value)
inline

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Definition at line 1221 of file GetMethodResult.h.

◆ WithAuthorizationScopes() [2/2]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::WithAuthorizationScopes ( const Aws::Vector< Aws::String > &  value)
inline

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Definition at line 1209 of file GetMethodResult.h.

◆ WithAuthorizationType() [1/3]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::WithAuthorizationType ( Aws::String &&  value)
inline

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

Definition at line 211 of file GetMethodResult.h.

◆ WithAuthorizationType() [2/3]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::WithAuthorizationType ( const Aws::String value)
inline

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

Definition at line 203 of file GetMethodResult.h.

◆ WithAuthorizationType() [3/3]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::WithAuthorizationType ( const char *  value)
inline

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

Definition at line 219 of file GetMethodResult.h.

◆ WithAuthorizerId() [1/3]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::WithAuthorizerId ( Aws::String &&  value)
inline

The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

Definition at line 256 of file GetMethodResult.h.

◆ WithAuthorizerId() [2/3]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::WithAuthorizerId ( const Aws::String value)
inline

The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

Definition at line 250 of file GetMethodResult.h.

◆ WithAuthorizerId() [3/3]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::WithAuthorizerId ( const char *  value)
inline

The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

Definition at line 262 of file GetMethodResult.h.

◆ WithHttpMethod() [1/3]

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

The method's HTTP verb.

Definition at line 157 of file GetMethodResult.h.

◆ WithHttpMethod() [2/3]

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

The method's HTTP verb.

Definition at line 152 of file GetMethodResult.h.

◆ WithHttpMethod() [3/3]

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

The method's HTTP verb.

Definition at line 162 of file GetMethodResult.h.

◆ WithMethodIntegration() [1/2]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::WithMethodIntegration ( const Integration value)
inline

Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.

Example:

Request
GET
/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1
Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_links": {
"curies": [ { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html",
"name": "integration", "templated": true }, { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true } ], "self": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" },
"integration:delete": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" },
"integration:responses": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200",
"name": "200", "title": "200" }, "integration:update": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" },
"integrationresponse:put": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}",
"templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch",
"credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod":
"POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": {
"application/json": "{\n \"a": "$input.params('operand1')",
"b": "$input.params('operand2')",
"op": "$input.params('operator')"
}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": "integration.response.body.a" }, "responseTemplates": { "application/json": "#set($res = $input.path('$'))
{
"result": "$res.a, $res.b, $res.op => $res.c",
"a" : "$res.a",
"b" : "$res.b",
"op" : "$res.op",
"c" : "$res.c"
}" }, "selectionPattern": "", "statusCode": "200" } } }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-integration.html">AWS CLI

Definition at line 1108 of file GetMethodResult.h.

◆ WithMethodIntegration() [2/2]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::WithMethodIntegration ( Integration &&  value)
inline

Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.

Example:

Request
GET
/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1
Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_links": {
"curies": [ { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html",
"name": "integration", "templated": true }, { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
"name": "integrationresponse", "templated": true } ], "self": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" },
"integration:delete": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" },
"integration:responses": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200",
"name": "200", "title": "200" }, "integration:update": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" },
"integrationresponse:put": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}",
"templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch",
"credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod":
"POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": {
"application/json": "{\n \"a": "$input.params('operand1')",
"b": "$input.params('operand2')",
"op": "$input.params('operator')"
}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": "integration.response.body.a" }, "responseTemplates": { "application/json": "#set($res = $input.path('$'))
{
"result": "$res.a, $res.b, $res.op => $res.c",
"a" : "$res.a",
"b" : "$res.b",
"op" : "$res.op",
"c" : "$res.c"
}" }, "selectionPattern": "", "statusCode": "200" } } }</code></pre> <p/> </div> <div class="seeAlso"> <a href="https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-integration.html">AWS CLI

Definition at line 1160 of file GetMethodResult.h.

◆ WithMethodResponses() [1/2]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::WithMethodResponses ( Aws::Map< Aws::String, MethodResponse > &&  value)
inline

Gets a method response associated with a given HTTP status code.

The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.

Example: Get a 200 OK response of a GET method

Request
GET
/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1
Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_links": {
"curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html",
"name": "methodresponse", "templated": true }, "self": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title":
"200" }, "methodresponse:delete": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" },
"methodresponse:update": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } },
"responseModels": { "application/json": "Empty" }, "responseParameters": {
"method.response.header.operator": false, "method.response.header.operand_2":
false, "method.response.header.operand_1": false }, "statusCode": "200"
}

Definition at line 713 of file GetMethodResult.h.

◆ WithMethodResponses() [2/2]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::WithMethodResponses ( const Aws::Map< Aws::String, MethodResponse > &  value)
inline

Gets a method response associated with a given HTTP status code.

The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.

Example: Get a 200 OK response of a GET method

Request
GET
/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1
Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_links": {
"curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html",
"name": "methodresponse", "templated": true }, "self": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title":
"200" }, "methodresponse:delete": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" },
"methodresponse:update": { "href":
"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } },
"responseModels": { "application/json": "Empty" }, "responseParameters": {
"method.response.header.operator": false, "method.response.header.operand_2":
false, "method.response.header.operand_1": false }, "statusCode": "200"
}

Definition at line 682 of file GetMethodResult.h.

◆ WithOperationName() [1/3]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::WithOperationName ( Aws::String &&  value)
inline

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

Definition at line 360 of file GetMethodResult.h.

◆ WithOperationName() [2/3]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::WithOperationName ( const Aws::String value)
inline

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

Definition at line 353 of file GetMethodResult.h.

◆ WithOperationName() [3/3]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::WithOperationName ( const char *  value)
inline

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

Definition at line 367 of file GetMethodResult.h.

◆ WithRequestModels() [1/2]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::WithRequestModels ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

Definition at line 508 of file GetMethodResult.h.

◆ WithRequestModels() [2/2]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::WithRequestModels ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

Definition at line 501 of file GetMethodResult.h.

◆ WithRequestParameters() [1/2]

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

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

Definition at line 433 of file GetMethodResult.h.

◆ WithRequestParameters() [2/2]

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

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

Definition at line 420 of file GetMethodResult.h.

◆ WithRequestValidatorId() [1/3]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::WithRequestValidatorId ( Aws::String &&  value)
inline

The identifier of a RequestValidator for request validation.

Definition at line 312 of file GetMethodResult.h.

◆ WithRequestValidatorId() [2/3]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::WithRequestValidatorId ( const Aws::String value)
inline

The identifier of a RequestValidator for request validation.

Definition at line 307 of file GetMethodResult.h.

◆ WithRequestValidatorId() [3/3]

GetMethodResult& Aws::APIGateway::Model::GetMethodResult::WithRequestValidatorId ( const char *  value)
inline

The identifier of a RequestValidator for request validation.

Definition at line 317 of file GetMethodResult.h.


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