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

#include <GetGatewayResponsesResult.h>

Public Member Functions

 GetGatewayResponsesResult ()
 
 GetGatewayResponsesResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
GetGatewayResponsesResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetPosition () const
 
void SetPosition (const Aws::String &value)
 
void SetPosition (Aws::String &&value)
 
void SetPosition (const char *value)
 
GetGatewayResponsesResultWithPosition (const Aws::String &value)
 
GetGatewayResponsesResultWithPosition (Aws::String &&value)
 
GetGatewayResponsesResultWithPosition (const char *value)
 
const Aws::Vector< GatewayResponse > & GetItems () const
 
void SetItems (const Aws::Vector< GatewayResponse > &value)
 
void SetItems (Aws::Vector< GatewayResponse > &&value)
 
GetGatewayResponsesResultWithItems (const Aws::Vector< GatewayResponse > &value)
 
GetGatewayResponsesResultWithItems (Aws::Vector< GatewayResponse > &&value)
 
GetGatewayResponsesResultAddItems (const GatewayResponse &value)
 
GetGatewayResponsesResultAddItems (GatewayResponse &&value)
 

Detailed Description

The collection of the GatewayResponse instances of a RestApi as a responseType-to-GatewayResponse object map of key-value pairs. As such, pagination is not supported for querying this collection.

For more information about valid gateway response types, see Gateway Response Types Supported by API Gateway

Example: Get the collection of gateway responses of an API

Request
This example request shows how to retrieve the GatewayResponses collection from an API.
GET /restapis/o81lxisefl/gatewayresponses HTTP/1.1
Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json
X-Amz-Date: 20170503T220604Z Authorization: AWS4-HMAC-SHA256
Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date,
Signature=59b42fe54a76a5de8adf2c67baa6d39206f8e9ad49a1d77ccc6a5da3103a398a
Cache-Control: no-cache Postman-Token: 5637af27-dc29-fc5c-9dfe-0645d52cb515
Response
The successful operation returns the 200 OK status code and a payload similar to the following:
{ "_links": { "curies": { "href":
"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html",
"name": "gatewayresponse", "templated": true }, "self": { "href":
"/restapis/o81lxisefl/gatewayresponses" }, "first": { "href":
"/restapis/o81lxisefl/gatewayresponses" }, "gatewayresponse:by-type": { "href":
"/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true },
"item": [ { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE"
}, { "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND" }, {
"href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE" }, { "href":
"/restapis/o81lxisefl/gatewayresponses/THROTTLED" }, { "href":
"/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE" }, { "href":
"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR" }, {
"href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX" }, { "href":
"/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX" }, { "href":
"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS" }, { "href":
"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY" }, { "href":
"/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN" }, { "href":
"/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED" }, { "href":
"/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY" }, { "href":
"/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" }, { "href":
"/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR" }, { "href":
"/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED" }, { "href":
"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT" }, { "href":
"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, {
"href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE" }, { "href":
"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE" } ] }, "_embedded": {
"item": [ { "_links": { "self": { "href":
"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE" },
"gatewayresponse:put": { "href":
"/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true },
"gatewayresponse:update": { "href":
"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE" } },
"defaultResponse": true, "responseParameters": {}, "responseTemplates": {
"application/json": "{\"message":$context.error.messageString}" },
"responseType": "INTEGRATION_FAILURE", "statusCode": "504" }, { "_links": {
"self": { "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND" },
"gatewayresponse:put": { "href":
"/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true },
"gatewayresponse:update": { "href":
"/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND" } },
"defaultResponse": true, "responseParameters": {}, "responseTemplates": {
"application/json": "{"message":$context.error.messageString}" },
"responseType": "RESOURCE_NOT_FOUND", "statusCode": "404" }, { "_links": {
"self": { "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE" },
"gatewayresponse:put": { "href":
"/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true },
"gatewayresponse:update": { "href":
"/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE" } },
"defaultResponse": true, "responseParameters": {}, "responseTemplates": {
"application/json": "{"message":$context.error.messageString}" },
"responseType": "REQUEST_TOO_LARGE", "statusCode": "413" }, { "_links": {
"self": { "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED" },
"gatewayresponse:put": { "href":
"/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true },
"gatewayresponse:update": { "href":
"/restapis/o81lxisefl/gatewayresponses/THROTTLED" } }, "defaultResponse": true,
"responseParameters": {}, "responseTemplates": { "application/json":
"{"message":$context.error.messageString}" }, "responseType": "THROTTLED",
"statusCode": "429" }, { "_links": { "self": { "href":
"/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE" },
"gatewayresponse:put": { "href":
"/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true },
"gatewayresponse:update": { "href":
"/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE" } },
"defaultResponse": true, "responseParameters": {}, "responseTemplates": {
"application/json": "{"message":$context.error.messageString}" },
"responseType": "UNSUPPORTED_MEDIA_TYPE", "statusCode": "415" }, { "_links": {
"self": { "href":
"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR" },
"gatewayresponse:put": { "href":
"/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true },
"gatewayresponse:update": { "href":
"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR" } },
"defaultResponse": true, "responseParameters": {}, "responseTemplates": {
"application/json": "{"message":$context.error.messageString}" },
"responseType": "AUTHORIZER_CONFIGURATION_ERROR", "statusCode": "500" }, {
"_links": { "self": { "href":
"/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX" }, "gatewayresponse:put": {
"href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated":
true }, "gatewayresponse:update": { "href":
"/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX" } }, "defaultResponse":
true, "responseParameters": {}, "responseTemplates": { "application/json":
"{"message":$context.error.messageString}" }, "responseType": "DEFAULT_5XX" },
{ "_links": { "self": { "href":
"/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX" }, "gatewayresponse:put": {
"href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated":
true }, "gatewayresponse:update": { "href":
"/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX" } }, "defaultResponse":
true, "responseParameters": {}, "responseTemplates": { "application/json":
"{"message":$context.error.messageString}" }, "responseType": "DEFAULT_4XX" },
{ "_links": { "self": { "href":
"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS" },
"gatewayresponse:put": { "href":
"/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true },
"gatewayresponse:update": { "href":
"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS" } },
"defaultResponse": true, "responseParameters": {}, "responseTemplates": {
"application/json": "{"message":$context.error.messageString}" },
"responseType": "BAD_REQUEST_PARAMETERS", "statusCode": "400" }, { "_links": {
"self": { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY" },
"gatewayresponse:put": { "href":
"/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true },
"gatewayresponse:update": { "href":
"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY" } }, "defaultResponse":
true, "responseParameters": {}, "responseTemplates": { "application/json":
"{"message":$context.error.messageString}" }, "responseType":
"BAD_REQUEST_BODY", "statusCode": "400" }, { "_links": { "self": { "href":
"/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN" }, "gatewayresponse:put":
{ "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated":
true }, "gatewayresponse:update": { "href":
"/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN" } }, "defaultResponse":
true, "responseParameters": {}, "responseTemplates": { "application/json":
"{"message":$context.error.messageString}" }, "responseType": "EXPIRED_TOKEN",
"statusCode": "403" }, { "_links": { "self": { "href":
"/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED" }, "gatewayresponse:put":
{ "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated":
true }, "gatewayresponse:update": { "href":
"/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED" } }, "defaultResponse":
true, "responseParameters": {}, "responseTemplates": { "application/json":
"{"message":$context.error.messageString}" }, "responseType": "ACCESS_DENIED",
"statusCode": "403" }, { "_links": { "self": { "href":
"/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY" },
"gatewayresponse:put": { "href":
"/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true },
"gatewayresponse:update": { "href":
"/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY" } }, "defaultResponse":
true, "responseParameters": {}, "responseTemplates": { "application/json":
"{"message":$context.error.messageString}" }, "responseType":
"INVALID_API_KEY", "statusCode": "403" }, { "_links": { "self": { "href":
"/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" }, "gatewayresponse:put": {
"href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated":
true }, "gatewayresponse:update": { "href":
"/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" } }, "defaultResponse":
true, "responseParameters": {}, "responseTemplates": { "application/json":
"{"message":$context.error.messageString}" }, "responseType": "UNAUTHORIZED",
"statusCode": "401" }, { "_links": { "self": { "href":
"/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR" },
"gatewayresponse:put": { "href":
"/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true },
"gatewayresponse:update": { "href":
"/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR" } },
"defaultResponse": true, "responseParameters": {}, "responseTemplates": {
"application/json": "{"message":$context.error.messageString}" },
"responseType": "API_CONFIGURATION_ERROR", "statusCode": "500" }, { "_links": {
"self": { "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED" },
"gatewayresponse:put": { "href":
"/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true },
"gatewayresponse:update": { "href":
"/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED" } }, "defaultResponse":
true, "responseParameters": {}, "responseTemplates": { "application/json":
"{"message":$context.error.messageString}" }, "responseType":
"QUOTA_EXCEEDED", "statusCode": "429" }, { "_links": { "self": { "href":
"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT" },
"gatewayresponse:put": { "href":
"/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true },
"gatewayresponse:update": { "href":
"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT" } },
"defaultResponse": true, "responseParameters": {}, "responseTemplates": {
"application/json": "{"message":$context.error.messageString}" },
"responseType": "INTEGRATION_TIMEOUT", "statusCode": "504" }, { "_links": {
"self": { "href":
"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" },
"gatewayresponse:put": { "href":
"/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true },
"gatewayresponse:update": { "href":
"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" } },
"defaultResponse": true, "responseParameters": {}, "responseTemplates": {
"application/json": "{"message":$context.error.messageString}" },
"responseType": "MISSING_AUTHENTICATION_TOKEN", "statusCode": "403" }, {
"_links": { "self": { "href":
"/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE" },
"gatewayresponse:put": { "href":
"/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true },
"gatewayresponse:update": { "href":
"/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE" } },
"defaultResponse": true, "responseParameters": {}, "responseTemplates": {
"application/json": "{"message":$context.error.messageString}" },
"responseType": "INVALID_SIGNATURE", "statusCode": "403" }, { "_links": {
"self": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE" },
"gatewayresponse:put": { "href":
"/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true },
"gatewayresponse:update": { "href":
"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE" } },
"defaultResponse": true, "responseParameters": {}, "responseTemplates": {
"application/json": "{"message":$context.error.messageString}" },
"responseType": "AUTHORIZER_FAILURE", "statusCode": "500" } ] } }</code></pre>
<p/> </div> </div> <div class="seeAlso"> <a
href="https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html">Customize
Gateway Responses 

See Also:


Definition at line 240 of file GetGatewayResponsesResult.h.

Constructor & Destructor Documentation

◆ GetGatewayResponsesResult() [1/2]

Aws::APIGateway::Model::GetGatewayResponsesResult::GetGatewayResponsesResult ( )

◆ GetGatewayResponsesResult() [2/2]

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

Member Function Documentation

◆ AddItems() [1/2]

GetGatewayResponsesResult& Aws::APIGateway::Model::GetGatewayResponsesResult::AddItems ( const GatewayResponse value)
inline

Returns the entire collection, because of no pagination support.

Definition at line 298 of file GetGatewayResponsesResult.h.

◆ AddItems() [2/2]

GetGatewayResponsesResult& Aws::APIGateway::Model::GetGatewayResponsesResult::AddItems ( GatewayResponse &&  value)
inline

Returns the entire collection, because of no pagination support.

Definition at line 303 of file GetGatewayResponsesResult.h.

◆ GetItems()

const Aws::Vector<GatewayResponse>& Aws::APIGateway::Model::GetGatewayResponsesResult::GetItems ( ) const
inline

Returns the entire collection, because of no pagination support.

Definition at line 273 of file GetGatewayResponsesResult.h.

◆ GetPosition()

const Aws::String& Aws::APIGateway::Model::GetGatewayResponsesResult::GetPosition ( ) const
inline

Definition at line 249 of file GetGatewayResponsesResult.h.

◆ operator=()

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

◆ SetItems() [1/2]

void Aws::APIGateway::Model::GetGatewayResponsesResult::SetItems ( Aws::Vector< GatewayResponse > &&  value)
inline

Returns the entire collection, because of no pagination support.

Definition at line 283 of file GetGatewayResponsesResult.h.

◆ SetItems() [2/2]

void Aws::APIGateway::Model::GetGatewayResponsesResult::SetItems ( const Aws::Vector< GatewayResponse > &  value)
inline

Returns the entire collection, because of no pagination support.

Definition at line 278 of file GetGatewayResponsesResult.h.

◆ SetPosition() [1/3]

void Aws::APIGateway::Model::GetGatewayResponsesResult::SetPosition ( Aws::String &&  value)
inline

Definition at line 255 of file GetGatewayResponsesResult.h.

◆ SetPosition() [2/3]

void Aws::APIGateway::Model::GetGatewayResponsesResult::SetPosition ( const Aws::String value)
inline

Definition at line 252 of file GetGatewayResponsesResult.h.

◆ SetPosition() [3/3]

void Aws::APIGateway::Model::GetGatewayResponsesResult::SetPosition ( const char *  value)
inline

Definition at line 258 of file GetGatewayResponsesResult.h.

◆ WithItems() [1/2]

GetGatewayResponsesResult& Aws::APIGateway::Model::GetGatewayResponsesResult::WithItems ( Aws::Vector< GatewayResponse > &&  value)
inline

Returns the entire collection, because of no pagination support.

Definition at line 293 of file GetGatewayResponsesResult.h.

◆ WithItems() [2/2]

GetGatewayResponsesResult& Aws::APIGateway::Model::GetGatewayResponsesResult::WithItems ( const Aws::Vector< GatewayResponse > &  value)
inline

Returns the entire collection, because of no pagination support.

Definition at line 288 of file GetGatewayResponsesResult.h.

◆ WithPosition() [1/3]

GetGatewayResponsesResult& Aws::APIGateway::Model::GetGatewayResponsesResult::WithPosition ( Aws::String &&  value)
inline

Definition at line 264 of file GetGatewayResponsesResult.h.

◆ WithPosition() [2/3]

GetGatewayResponsesResult& Aws::APIGateway::Model::GetGatewayResponsesResult::WithPosition ( const Aws::String value)
inline

Definition at line 261 of file GetGatewayResponsesResult.h.

◆ WithPosition() [3/3]

GetGatewayResponsesResult& Aws::APIGateway::Model::GetGatewayResponsesResult::WithPosition ( const char *  value)
inline

Definition at line 267 of file GetGatewayResponsesResult.h.


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