/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include The collection of the GatewayResponse instances of a RestApi as
* a This
* example request shows how to retrieve the GatewayResponses collection
* from an API. The successful operation returns the
* responseType-to-GatewayResponse object map of key-value
* pairs. As such, pagination is not supported for querying this collection.Example:
* Get the collection of gateway responses of an API
Request
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
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" } ] } }See Also:
AWS
* API Reference
Returns the entire collection, because of no pagination support.
*/ inline const Aws::VectorReturns the entire collection, because of no pagination support.
*/ inline void SetItems(const Aws::VectorReturns the entire collection, because of no pagination support.
*/ inline void SetItems(Aws::VectorReturns the entire collection, because of no pagination support.
*/ inline GetGatewayResponsesResult& WithItems(const Aws::VectorReturns the entire collection, because of no pagination support.
*/ inline GetGatewayResponsesResult& WithItems(Aws::VectorReturns the entire collection, because of no pagination support.
*/ inline GetGatewayResponsesResult& AddItems(const GatewayResponse& value) { m_items.push_back(value); return *this; } /** *Returns the entire collection, because of no pagination support.
*/ inline GetGatewayResponsesResult& AddItems(GatewayResponse&& value) { m_items.push_back(std::move(value)); return *this; } private: Aws::String m_position; Aws::Vector