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

#include <Method.h>

Public Member Functions

 Method ()
 
 Method (Aws::Utils::Json::JsonView jsonValue)
 
Methodoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetHttpMethod () const
 
bool HttpMethodHasBeenSet () const
 
void SetHttpMethod (const Aws::String &value)
 
void SetHttpMethod (Aws::String &&value)
 
void SetHttpMethod (const char *value)
 
MethodWithHttpMethod (const Aws::String &value)
 
MethodWithHttpMethod (Aws::String &&value)
 
MethodWithHttpMethod (const char *value)
 
const Aws::StringGetAuthorizationType () const
 
bool AuthorizationTypeHasBeenSet () const
 
void SetAuthorizationType (const Aws::String &value)
 
void SetAuthorizationType (Aws::String &&value)
 
void SetAuthorizationType (const char *value)
 
MethodWithAuthorizationType (const Aws::String &value)
 
MethodWithAuthorizationType (Aws::String &&value)
 
MethodWithAuthorizationType (const char *value)
 
const Aws::StringGetAuthorizerId () const
 
bool AuthorizerIdHasBeenSet () const
 
void SetAuthorizerId (const Aws::String &value)
 
void SetAuthorizerId (Aws::String &&value)
 
void SetAuthorizerId (const char *value)
 
MethodWithAuthorizerId (const Aws::String &value)
 
MethodWithAuthorizerId (Aws::String &&value)
 
MethodWithAuthorizerId (const char *value)
 
bool GetApiKeyRequired () const
 
bool ApiKeyRequiredHasBeenSet () const
 
void SetApiKeyRequired (bool value)
 
MethodWithApiKeyRequired (bool value)
 
const Aws::StringGetRequestValidatorId () const
 
bool RequestValidatorIdHasBeenSet () const
 
void SetRequestValidatorId (const Aws::String &value)
 
void SetRequestValidatorId (Aws::String &&value)
 
void SetRequestValidatorId (const char *value)
 
MethodWithRequestValidatorId (const Aws::String &value)
 
MethodWithRequestValidatorId (Aws::String &&value)
 
MethodWithRequestValidatorId (const char *value)
 
const Aws::StringGetOperationName () const
 
bool OperationNameHasBeenSet () const
 
void SetOperationName (const Aws::String &value)
 
void SetOperationName (Aws::String &&value)
 
void SetOperationName (const char *value)
 
MethodWithOperationName (const Aws::String &value)
 
MethodWithOperationName (Aws::String &&value)
 
MethodWithOperationName (const char *value)
 
const Aws::Map< Aws::String, bool > & GetRequestParameters () const
 
bool RequestParametersHasBeenSet () const
 
void SetRequestParameters (const Aws::Map< Aws::String, bool > &value)
 
void SetRequestParameters (Aws::Map< Aws::String, bool > &&value)
 
MethodWithRequestParameters (const Aws::Map< Aws::String, bool > &value)
 
MethodWithRequestParameters (Aws::Map< Aws::String, bool > &&value)
 
MethodAddRequestParameters (const Aws::String &key, bool value)
 
MethodAddRequestParameters (Aws::String &&key, bool value)
 
MethodAddRequestParameters (const char *key, bool value)
 
const Aws::Map< Aws::String, Aws::String > & GetRequestModels () const
 
bool RequestModelsHasBeenSet () const
 
void SetRequestModels (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetRequestModels (Aws::Map< Aws::String, Aws::String > &&value)
 
MethodWithRequestModels (const Aws::Map< Aws::String, Aws::String > &value)
 
MethodWithRequestModels (Aws::Map< Aws::String, Aws::String > &&value)
 
MethodAddRequestModels (const Aws::String &key, const Aws::String &value)
 
MethodAddRequestModels (Aws::String &&key, const Aws::String &value)
 
MethodAddRequestModels (const Aws::String &key, Aws::String &&value)
 
MethodAddRequestModels (Aws::String &&key, Aws::String &&value)
 
MethodAddRequestModels (const char *key, Aws::String &&value)
 
MethodAddRequestModels (Aws::String &&key, const char *value)
 
MethodAddRequestModels (const char *key, const char *value)
 
const Aws::Map< Aws::String, MethodResponse > & GetMethodResponses () const
 
bool MethodResponsesHasBeenSet () const
 
void SetMethodResponses (const Aws::Map< Aws::String, MethodResponse > &value)
 
void SetMethodResponses (Aws::Map< Aws::String, MethodResponse > &&value)
 
MethodWithMethodResponses (const Aws::Map< Aws::String, MethodResponse > &value)
 
MethodWithMethodResponses (Aws::Map< Aws::String, MethodResponse > &&value)
 
MethodAddMethodResponses (const Aws::String &key, const MethodResponse &value)
 
MethodAddMethodResponses (Aws::String &&key, const MethodResponse &value)
 
MethodAddMethodResponses (const Aws::String &key, MethodResponse &&value)
 
MethodAddMethodResponses (Aws::String &&key, MethodResponse &&value)
 
MethodAddMethodResponses (const char *key, MethodResponse &&value)
 
MethodAddMethodResponses (const char *key, const MethodResponse &value)
 
const IntegrationGetMethodIntegration () const
 
bool MethodIntegrationHasBeenSet () const
 
void SetMethodIntegration (const Integration &value)
 
void SetMethodIntegration (Integration &&value)
 
MethodWithMethodIntegration (const Integration &value)
 
MethodWithMethodIntegration (Integration &&value)
 
const Aws::Vector< Aws::String > & GetAuthorizationScopes () const
 
bool AuthorizationScopesHasBeenSet () const
 
void SetAuthorizationScopes (const Aws::Vector< Aws::String > &value)
 
void SetAuthorizationScopes (Aws::Vector< Aws::String > &&value)
 
MethodWithAuthorizationScopes (const Aws::Vector< Aws::String > &value)
 
MethodWithAuthorizationScopes (Aws::Vector< Aws::String > &&value)
 
MethodAddAuthorizationScopes (const Aws::String &value)
 
MethodAddAuthorizationScopes (Aws::String &&value)
 
MethodAddAuthorizationScopes (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 120 of file Method.h.

Constructor & Destructor Documentation

◆ Method() [1/2]

Aws::APIGateway::Model::Method::Method ( )

◆ Method() [2/2]

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

Member Function Documentation

◆ AddAuthorizationScopes() [1/3]

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

◆ AddAuthorizationScopes() [2/3]

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

◆ AddAuthorizationScopes() [3/3]

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

◆ AddMethodResponses() [1/6]

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

◆ AddMethodResponses() [2/6]

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

◆ AddMethodResponses() [3/6]

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

◆ AddMethodResponses() [4/6]

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

◆ AddMethodResponses() [5/6]

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

◆ AddMethodResponses() [6/6]

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

◆ AddRequestModels() [1/7]

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

◆ AddRequestModels() [2/7]

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

◆ AddRequestModels() [3/7]

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

◆ AddRequestModels() [4/7]

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

◆ AddRequestModels() [5/7]

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

◆ AddRequestModels() [6/7]

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

◆ AddRequestModels() [7/7]

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

◆ AddRequestParameters() [1/3]

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

◆ AddRequestParameters() [2/3]

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

◆ AddRequestParameters() [3/3]

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

◆ ApiKeyRequiredHasBeenSet()

bool Aws::APIGateway::Model::Method::ApiKeyRequiredHasBeenSet ( ) const
inline

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

Definition at line 294 of file Method.h.

◆ AuthorizationScopesHasBeenSet()

bool Aws::APIGateway::Model::Method::AuthorizationScopesHasBeenSet ( ) 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 1325 of file Method.h.

◆ AuthorizationTypeHasBeenSet()

bool Aws::APIGateway::Model::Method::AuthorizationTypeHasBeenSet ( ) 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 184 of file Method.h.

◆ AuthorizerIdHasBeenSet()

bool Aws::APIGateway::Model::Method::AuthorizerIdHasBeenSet ( ) const
inline

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

Definition at line 245 of file Method.h.

◆ GetApiKeyRequired()

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

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

Definition at line 288 of file Method.h.

◆ GetAuthorizationScopes()

const Aws::Vector<Aws::String>& Aws::APIGateway::Model::Method::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 1313 of file Method.h.

◆ GetAuthorizationType()

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

◆ GetAuthorizerId()

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

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

Definition at line 239 of file Method.h.

◆ GetHttpMethod()

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

The method's HTTP verb.

Definition at line 132 of file Method.h.

◆ GetMethodIntegration()

const Integration& Aws::APIGateway::Model::Method::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 1040 of file Method.h.

◆ GetMethodResponses()

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

◆ GetOperationName()

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

◆ GetRequestModels()

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

◆ GetRequestParameters()

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

◆ GetRequestValidatorId()

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

The identifier of a RequestValidator for request validation.

Definition at line 312 of file Method.h.

◆ HttpMethodHasBeenSet()

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

The method's HTTP verb.

Definition at line 137 of file Method.h.

◆ Jsonize()

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

◆ MethodIntegrationHasBeenSet()

bool Aws::APIGateway::Model::Method::MethodIntegrationHasBeenSet ( ) 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 1092 of file Method.h.

◆ MethodResponsesHasBeenSet()

bool Aws::APIGateway::Model::Method::MethodResponsesHasBeenSet ( ) 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 677 of file Method.h.

◆ OperationNameHasBeenSet()

bool Aws::APIGateway::Model::Method::OperationNameHasBeenSet ( ) 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 362 of file Method.h.

◆ operator=()

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

◆ RequestModelsHasBeenSet()

bool Aws::APIGateway::Model::Method::RequestModelsHasBeenSet ( ) 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 537 of file Method.h.

◆ RequestParametersHasBeenSet()

bool Aws::APIGateway::Model::Method::RequestParametersHasBeenSet ( ) 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 431 of file Method.h.

◆ RequestValidatorIdHasBeenSet()

bool Aws::APIGateway::Model::Method::RequestValidatorIdHasBeenSet ( ) const
inline

The identifier of a RequestValidator for request validation.

Definition at line 317 of file Method.h.

◆ SetApiKeyRequired()

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

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

Definition at line 300 of file Method.h.

◆ SetAuthorizationScopes() [1/2]

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

◆ SetAuthorizationScopes() [2/2]

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

◆ SetAuthorizationType() [1/3]

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

◆ SetAuthorizationType() [2/3]

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

◆ SetAuthorizationType() [3/3]

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

◆ SetAuthorizerId() [1/3]

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

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

Definition at line 251 of file Method.h.

◆ SetAuthorizerId() [2/3]

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

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

Definition at line 257 of file Method.h.

◆ SetAuthorizerId() [3/3]

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

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

Definition at line 263 of file Method.h.

◆ SetHttpMethod() [1/3]

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

The method's HTTP verb.

Definition at line 142 of file Method.h.

◆ SetHttpMethod() [2/3]

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

The method's HTTP verb.

Definition at line 147 of file Method.h.

◆ SetHttpMethod() [3/3]

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

The method's HTTP verb.

Definition at line 152 of file Method.h.

◆ SetMethodIntegration() [1/2]

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

◆ SetMethodIntegration() [2/2]

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

◆ SetMethodResponses() [1/2]

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

◆ SetMethodResponses() [2/2]

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

◆ SetOperationName() [1/3]

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

◆ SetOperationName() [2/3]

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

◆ SetOperationName() [3/3]

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

◆ SetRequestModels() [1/2]

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

◆ SetRequestModels() [2/2]

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

◆ SetRequestParameters() [1/2]

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

◆ SetRequestParameters() [2/2]

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

◆ SetRequestValidatorId() [1/3]

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

The identifier of a RequestValidator for request validation.

Definition at line 322 of file Method.h.

◆ SetRequestValidatorId() [2/3]

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

The identifier of a RequestValidator for request validation.

Definition at line 327 of file Method.h.

◆ SetRequestValidatorId() [3/3]

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

The identifier of a RequestValidator for request validation.

Definition at line 332 of file Method.h.

◆ WithApiKeyRequired()

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

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

Definition at line 306 of file Method.h.

◆ WithAuthorizationScopes() [1/2]

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

◆ WithAuthorizationScopes() [2/2]

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

◆ WithAuthorizationType() [1/3]

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

◆ WithAuthorizationType() [2/3]

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

◆ WithAuthorizationType() [3/3]

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

◆ WithAuthorizerId() [1/3]

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

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

Definition at line 269 of file Method.h.

◆ WithAuthorizerId() [2/3]

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

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

Definition at line 275 of file Method.h.

◆ WithAuthorizerId() [3/3]

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

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

Definition at line 281 of file Method.h.

◆ WithHttpMethod() [1/3]

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

The method's HTTP verb.

Definition at line 157 of file Method.h.

◆ WithHttpMethod() [2/3]

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

The method's HTTP verb.

Definition at line 162 of file Method.h.

◆ WithHttpMethod() [3/3]

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

The method's HTTP verb.

Definition at line 167 of file Method.h.

◆ WithMethodIntegration() [1/2]

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

◆ WithMethodIntegration() [2/2]

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

◆ WithMethodResponses() [1/2]

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

◆ WithMethodResponses() [2/2]

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

◆ WithOperationName() [1/3]

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

◆ WithOperationName() [2/3]

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

◆ WithOperationName() [3/3]

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

◆ WithRequestModels() [1/2]

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

◆ WithRequestModels() [2/2]

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

◆ WithRequestParameters() [1/2]

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

◆ WithRequestParameters() [2/2]

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

◆ WithRequestValidatorId() [1/3]

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

The identifier of a RequestValidator for request validation.

Definition at line 337 of file Method.h.

◆ WithRequestValidatorId() [2/3]

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

The identifier of a RequestValidator for request validation.

Definition at line 342 of file Method.h.

◆ WithRequestValidatorId() [3/3]

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

The identifier of a RequestValidator for request validation.

Definition at line 347 of file Method.h.


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