Skip to main content

gateway_responses_list_only

Lists gateway_responses in a region or regions, for all properties use gateway_responses

Overview

Namegateway_responses_list_only
TypeResource
DescriptionThe AWS::ApiGateway::GatewayResponse resource creates a gateway response for your API. For more information, see [API Gateway Responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html#api-gateway-gatewayResponse-definition) in the *API Gateway Developer Guide*.
Idaws.apigateway.gateway_responses_list_only

Fields

NameDatatypeDescription
idstring
rest_api_idstringThe string identifier of the associated RestApi.
response_typestringThe response type of the associated GatewayResponse.
status_codestringThe HTTP status code for this GatewayResponse.
response_parametersobjectResponse parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
response_templatesobjectResponse templates of the GatewayResponse as a string-to-string map of key-value pairs.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all gateway_responses in a region.

SELECT
region,
id
FROM aws.apigateway.gateway_responses_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the gateway_responses_list_only resource, see gateway_responses