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

#include <GetResourceResult.h>

Public Member Functions

 GetResourceResult ()
 
 GetResourceResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
GetResourceResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetId () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
GetResourceResultWithId (const Aws::String &value)
 
GetResourceResultWithId (Aws::String &&value)
 
GetResourceResultWithId (const char *value)
 
const Aws::StringGetParentId () const
 
void SetParentId (const Aws::String &value)
 
void SetParentId (Aws::String &&value)
 
void SetParentId (const char *value)
 
GetResourceResultWithParentId (const Aws::String &value)
 
GetResourceResultWithParentId (Aws::String &&value)
 
GetResourceResultWithParentId (const char *value)
 
const Aws::StringGetPathPart () const
 
void SetPathPart (const Aws::String &value)
 
void SetPathPart (Aws::String &&value)
 
void SetPathPart (const char *value)
 
GetResourceResultWithPathPart (const Aws::String &value)
 
GetResourceResultWithPathPart (Aws::String &&value)
 
GetResourceResultWithPathPart (const char *value)
 
const Aws::StringGetPath () const
 
void SetPath (const Aws::String &value)
 
void SetPath (Aws::String &&value)
 
void SetPath (const char *value)
 
GetResourceResultWithPath (const Aws::String &value)
 
GetResourceResultWithPath (Aws::String &&value)
 
GetResourceResultWithPath (const char *value)
 
const Aws::Map< Aws::String, Method > & GetResourceMethods () const
 
void SetResourceMethods (const Aws::Map< Aws::String, Method > &value)
 
void SetResourceMethods (Aws::Map< Aws::String, Method > &&value)
 
GetResourceResultWithResourceMethods (const Aws::Map< Aws::String, Method > &value)
 
GetResourceResultWithResourceMethods (Aws::Map< Aws::String, Method > &&value)
 
GetResourceResultAddResourceMethods (const Aws::String &key, const Method &value)
 
GetResourceResultAddResourceMethods (Aws::String &&key, const Method &value)
 
GetResourceResultAddResourceMethods (const Aws::String &key, Method &&value)
 
GetResourceResultAddResourceMethods (Aws::String &&key, Method &&value)
 
GetResourceResultAddResourceMethods (const char *key, Method &&value)
 
GetResourceResultAddResourceMethods (const char *key, const Method &value)
 

Detailed Description

Represents an API resource.

See Also:

AWS API Reference

Definition at line 36 of file GetResourceResult.h.

Constructor & Destructor Documentation

◆ GetResourceResult() [1/2]

Aws::APIGateway::Model::GetResourceResult::GetResourceResult ( )

◆ GetResourceResult() [2/2]

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

Member Function Documentation

◆ AddResourceMethods() [1/6]

GetResourceResult& Aws::APIGateway::Model::GetResourceResult::AddResourceMethods ( Aws::String &&  key,
const Method value 
)
inline

Gets an API resource's method of a given HTTP verb.

The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request.

Example: Get the GET method of an API resource

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type:
application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date:
20170223T031827Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
{ "_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": false, "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::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%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" } } }
If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.

Definition at line 718 of file GetResourceResult.h.

◆ AddResourceMethods() [2/6]

GetResourceResult& Aws::APIGateway::Model::GetResourceResult::AddResourceMethods ( Aws::String &&  key,
Method &&  value 
)
inline

Gets an API resource's method of a given HTTP verb.

The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request.

Example: Get the GET method of an API resource

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type:
application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date:
20170223T031827Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
{ "_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": false, "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::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%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" } } }
If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.

Definition at line 870 of file GetResourceResult.h.

◆ AddResourceMethods() [3/6]

GetResourceResult& Aws::APIGateway::Model::GetResourceResult::AddResourceMethods ( const Aws::String key,
const Method value 
)
inline

Gets an API resource's method of a given HTTP verb.

The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request.

Example: Get the GET method of an API resource

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type:
application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date:
20170223T031827Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
{ "_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": false, "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::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%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" } } }
If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.

Definition at line 642 of file GetResourceResult.h.

◆ AddResourceMethods() [4/6]

GetResourceResult& Aws::APIGateway::Model::GetResourceResult::AddResourceMethods ( const Aws::String key,
Method &&  value 
)
inline

Gets an API resource's method of a given HTTP verb.

The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request.

Example: Get the GET method of an API resource

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type:
application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date:
20170223T031827Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
{ "_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": false, "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::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%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" } } }
If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.

Definition at line 794 of file GetResourceResult.h.

◆ AddResourceMethods() [5/6]

GetResourceResult& Aws::APIGateway::Model::GetResourceResult::AddResourceMethods ( const char *  key,
const Method value 
)
inline

Gets an API resource's method of a given HTTP verb.

The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request.

Example: Get the GET method of an API resource

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type:
application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date:
20170223T031827Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
{ "_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": false, "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::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%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" } } }
If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.

Definition at line 1022 of file GetResourceResult.h.

◆ AddResourceMethods() [6/6]

GetResourceResult& Aws::APIGateway::Model::GetResourceResult::AddResourceMethods ( const char *  key,
Method &&  value 
)
inline

Gets an API resource's method of a given HTTP verb.

The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request.

Example: Get the GET method of an API resource

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type:
application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date:
20170223T031827Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
{ "_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": false, "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::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%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" } } }
If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.

Definition at line 946 of file GetResourceResult.h.

◆ GetId()

const Aws::String& Aws::APIGateway::Model::GetResourceResult::GetId ( ) const
inline

The resource's identifier.

Definition at line 47 of file GetResourceResult.h.

◆ GetParentId()

const Aws::String& Aws::APIGateway::Model::GetResourceResult::GetParentId ( ) const
inline

The parent resource's identifier.

Definition at line 83 of file GetResourceResult.h.

◆ GetPath()

const Aws::String& Aws::APIGateway::Model::GetResourceResult::GetPath ( ) const
inline

The full path for this resource.

Definition at line 155 of file GetResourceResult.h.

◆ GetPathPart()

const Aws::String& Aws::APIGateway::Model::GetResourceResult::GetPathPart ( ) const
inline

The last path segment for this resource.

Definition at line 119 of file GetResourceResult.h.

◆ GetResourceMethods()

const Aws::Map<Aws::String, Method>& Aws::APIGateway::Model::GetResourceResult::GetResourceMethods ( ) const
inline

Gets an API resource's method of a given HTTP verb.

The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request.

Example: Get the GET method of an API resource

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type:
application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date:
20170223T031827Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
{ "_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": false, "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::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%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" } } }
If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.

Definition at line 262 of file GetResourceResult.h.

◆ operator=()

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

◆ SetId() [1/3]

void Aws::APIGateway::Model::GetResourceResult::SetId ( Aws::String &&  value)
inline

The resource's identifier.

Definition at line 57 of file GetResourceResult.h.

◆ SetId() [2/3]

void Aws::APIGateway::Model::GetResourceResult::SetId ( const Aws::String value)
inline

The resource's identifier.

Definition at line 52 of file GetResourceResult.h.

◆ SetId() [3/3]

void Aws::APIGateway::Model::GetResourceResult::SetId ( const char *  value)
inline

The resource's identifier.

Definition at line 62 of file GetResourceResult.h.

◆ SetParentId() [1/3]

void Aws::APIGateway::Model::GetResourceResult::SetParentId ( Aws::String &&  value)
inline

The parent resource's identifier.

Definition at line 93 of file GetResourceResult.h.

◆ SetParentId() [2/3]

void Aws::APIGateway::Model::GetResourceResult::SetParentId ( const Aws::String value)
inline

The parent resource's identifier.

Definition at line 88 of file GetResourceResult.h.

◆ SetParentId() [3/3]

void Aws::APIGateway::Model::GetResourceResult::SetParentId ( const char *  value)
inline

The parent resource's identifier.

Definition at line 98 of file GetResourceResult.h.

◆ SetPath() [1/3]

void Aws::APIGateway::Model::GetResourceResult::SetPath ( Aws::String &&  value)
inline

The full path for this resource.

Definition at line 165 of file GetResourceResult.h.

◆ SetPath() [2/3]

void Aws::APIGateway::Model::GetResourceResult::SetPath ( const Aws::String value)
inline

The full path for this resource.

Definition at line 160 of file GetResourceResult.h.

◆ SetPath() [3/3]

void Aws::APIGateway::Model::GetResourceResult::SetPath ( const char *  value)
inline

The full path for this resource.

Definition at line 170 of file GetResourceResult.h.

◆ SetPathPart() [1/3]

void Aws::APIGateway::Model::GetResourceResult::SetPathPart ( Aws::String &&  value)
inline

The last path segment for this resource.

Definition at line 129 of file GetResourceResult.h.

◆ SetPathPart() [2/3]

void Aws::APIGateway::Model::GetResourceResult::SetPathPart ( const Aws::String value)
inline

The last path segment for this resource.

Definition at line 124 of file GetResourceResult.h.

◆ SetPathPart() [3/3]

void Aws::APIGateway::Model::GetResourceResult::SetPathPart ( const char *  value)
inline

The last path segment for this resource.

Definition at line 134 of file GetResourceResult.h.

◆ SetResourceMethods() [1/2]

void Aws::APIGateway::Model::GetResourceResult::SetResourceMethods ( Aws::Map< Aws::String, Method > &&  value)
inline

Gets an API resource's method of a given HTTP verb.

The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request.

Example: Get the GET method of an API resource

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type:
application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date:
20170223T031827Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
{ "_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": false, "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::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%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" } } }
If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.

Definition at line 414 of file GetResourceResult.h.

◆ SetResourceMethods() [2/2]

void Aws::APIGateway::Model::GetResourceResult::SetResourceMethods ( const Aws::Map< Aws::String, Method > &  value)
inline

Gets an API resource's method of a given HTTP verb.

The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request.

Example: Get the GET method of an API resource

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type:
application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date:
20170223T031827Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
{ "_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": false, "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::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%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" } } }
If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.

Definition at line 338 of file GetResourceResult.h.

◆ WithId() [1/3]

GetResourceResult& Aws::APIGateway::Model::GetResourceResult::WithId ( Aws::String &&  value)
inline

The resource's identifier.

Definition at line 72 of file GetResourceResult.h.

◆ WithId() [2/3]

GetResourceResult& Aws::APIGateway::Model::GetResourceResult::WithId ( const Aws::String value)
inline

The resource's identifier.

Definition at line 67 of file GetResourceResult.h.

◆ WithId() [3/3]

GetResourceResult& Aws::APIGateway::Model::GetResourceResult::WithId ( const char *  value)
inline

The resource's identifier.

Definition at line 77 of file GetResourceResult.h.

◆ WithParentId() [1/3]

GetResourceResult& Aws::APIGateway::Model::GetResourceResult::WithParentId ( Aws::String &&  value)
inline

The parent resource's identifier.

Definition at line 108 of file GetResourceResult.h.

◆ WithParentId() [2/3]

GetResourceResult& Aws::APIGateway::Model::GetResourceResult::WithParentId ( const Aws::String value)
inline

The parent resource's identifier.

Definition at line 103 of file GetResourceResult.h.

◆ WithParentId() [3/3]

GetResourceResult& Aws::APIGateway::Model::GetResourceResult::WithParentId ( const char *  value)
inline

The parent resource's identifier.

Definition at line 113 of file GetResourceResult.h.

◆ WithPath() [1/3]

GetResourceResult& Aws::APIGateway::Model::GetResourceResult::WithPath ( Aws::String &&  value)
inline

The full path for this resource.

Definition at line 180 of file GetResourceResult.h.

◆ WithPath() [2/3]

GetResourceResult& Aws::APIGateway::Model::GetResourceResult::WithPath ( const Aws::String value)
inline

The full path for this resource.

Definition at line 175 of file GetResourceResult.h.

◆ WithPath() [3/3]

GetResourceResult& Aws::APIGateway::Model::GetResourceResult::WithPath ( const char *  value)
inline

The full path for this resource.

Definition at line 185 of file GetResourceResult.h.

◆ WithPathPart() [1/3]

GetResourceResult& Aws::APIGateway::Model::GetResourceResult::WithPathPart ( Aws::String &&  value)
inline

The last path segment for this resource.

Definition at line 144 of file GetResourceResult.h.

◆ WithPathPart() [2/3]

GetResourceResult& Aws::APIGateway::Model::GetResourceResult::WithPathPart ( const Aws::String value)
inline

The last path segment for this resource.

Definition at line 139 of file GetResourceResult.h.

◆ WithPathPart() [3/3]

GetResourceResult& Aws::APIGateway::Model::GetResourceResult::WithPathPart ( const char *  value)
inline

The last path segment for this resource.

Definition at line 149 of file GetResourceResult.h.

◆ WithResourceMethods() [1/2]

GetResourceResult& Aws::APIGateway::Model::GetResourceResult::WithResourceMethods ( Aws::Map< Aws::String, Method > &&  value)
inline

Gets an API resource's method of a given HTTP verb.

The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request.

Example: Get the GET method of an API resource

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type:
application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date:
20170223T031827Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
{ "_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": false, "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::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%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" } } }
If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.

Definition at line 566 of file GetResourceResult.h.

◆ WithResourceMethods() [2/2]

GetResourceResult& Aws::APIGateway::Model::GetResourceResult::WithResourceMethods ( const Aws::Map< Aws::String, Method > &  value)
inline

Gets an API resource's method of a given HTTP verb.

The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request.

Example: Get the GET method of an API resource

Request
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type:
application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date:
20170223T031827Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
{ "_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": false, "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::foreach($stream in
$input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E::end%3C/kinesisStreams%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" } } }
If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.

Definition at line 490 of file GetResourceResult.h.


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