Skip to main content


No description

type AWSAPIGatewayRestAPI {
metadata: ResourceMetadata!
apiKeySource: AWSAPIGatewayRestAPIKeySourceType!
binaryMediaTypes: [String!]!
createdAt: DateTime!
description: String!
disableExecuteApiEndpoint: Boolean!
endpointConfiguration: AWSAPIGatewayRestAPIEndpointConfiguration
id: String!
minimumCompressionSize: Int
name: String!
policy: String!
tags: [AWSTag!]!
version: String!
warnings: [String!]!
stages: [AWSAPIGatewayRestAPIStage!]!
resources: [AWSAPIGatewayRestAPIResource!]!
authorizers: [AWSAPIGatewayRestAPIAuthorizer!]!


AWSAPIGatewayRestAPI.metadata ● ResourceMetadata! non-null object

The metadata to identify this API in Shisho Cloud

AWSAPIGatewayRestAPI.apiKeySource ● AWSAPIGatewayRestAPIKeySourceType! non-null enum

The source of the API key for metering requests according to a usage plan

AWSAPIGatewayRestAPI.binaryMediaTypes ● [String!]! non-null scalar

The list of binary media types supported by the Rest API

AWSAPIGatewayRestAPI.createdAt ● DateTime! non-null scalar

The timestamp when the API was created

AWSAPIGatewayRestAPI.description ● String! non-null scalar

The API's description

AWSAPIGatewayRestAPI.disableExecuteApiEndpoint ● Boolean! non-null scalar

Indicates whether clients can invoke your API by using the default execute-api endpoint

AWSAPIGatewayRestAPI.endpointConfiguration ● AWSAPIGatewayRestAPIEndpointConfiguration object

The endpoint configuration of this RestApi showing the endpoint types of the API ● String! non-null scalar

The API's identifier. This identifier is unique across all of your APIs in API Gateway

AWSAPIGatewayRestAPI.minimumCompressionSize ● Int scalar

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API ● String! non-null scalar

The API's name

AWSAPIGatewayRestAPI.policy ● String! non-null scalar

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration

AWSAPIGatewayRestAPI.tags ● [AWSTag!]! non-null object

The collection of tags

AWSAPIGatewayRestAPI.version ● String! non-null scalar

A version identifier for the API

AWSAPIGatewayRestAPI.warnings ● [String!]! non-null scalar

The warning messages reported when failonwarnings is turned on during API import

AWSAPIGatewayRestAPI.stages ● [AWSAPIGatewayRestAPIStage!]! non-null object

The stages of this Rest API

AWSAPIGatewayRestAPI.resources ● [AWSAPIGatewayRestAPIResource!]! non-null object

The resources of this Rest API

AWSAPIGatewayRestAPI.authorizers ● [AWSAPIGatewayRestAPIAuthorizer!]! non-null union

The authorizers of this Rest API

Implemented by

AWSAPIGatewayAPI union