AWS API Gateway Tables

Tables

AWSAPIGatewayV2ApiMappings

Represents mappings that connect custom domain names to specific API Gateway v2 APIs and stages, enabling request routing through defined path keys.

Name	Type	Description
ApiMappingID	string	Unique identifier for the API mapping.
AWSAPIGatewayV2ApiID	string	Identifier of the API associated with the mapping.
AWSAPIGatewayV2DomainName	string	Custom domain name to which the API mapping applies.
ApiMappingKey	string	Path key used to route requests from the custom domain to the API stage.
Stage	string	Deployment stage of the API that receives requests for this mapping.
BatchDate	datetime	Timestamp indicating when this API mapping record was last ingested or updated.

AWSAPIGatewayV2Apis

Represents API Gateway v2 APIs, including their configuration, protocol type, routing behavior, endpoints, and metadata used to manage and invoke APIs in AWS.

Name	Type	Description
ConfigID	integer	Identifier linking this API record to its configuration or ingestion context.
ApiID	string	Unique identifier assigned to the API by API Gateway v2.
ApiEndpoint	string	Default endpoint URL used to invoke the API.
ApiGatewayManaged	boolean	Indicates whether the API is fully managed by API Gateway.
ApiKeySelectionExpression	string	Expression that determines how API keys are selected for requests.
RouteSelectionExpression	string	Expression used to select routes based on incoming request attributes.
Name	string	Name of the API.
ProtocolType	string	Protocol used by the API, such as `HTTP` or `WEBSOCKET`.
Version	string	Version identifier associated with the API configuration.
Description	string	Descriptive text providing details about the API’s purpose.
DisableExecuteApiEndpoint	boolean	Indicates whether the default execute-api endpoint is disabled.
DisableSchemaValidation	boolean	Indicates whether request and response schema validation is disabled.
CreatedDate	datetime	Timestamp when the API was created.
CorsConfigurationJson	string	JSON representation of the CORS configuration applied to the API.
TagsJson	string	JSON object containing tags assigned to the API.
WarningsJson	string	JSON array of warnings generated during API creation or import.
ImportInfoJson	string	JSON metadata related to API import operations.
BatchDate	datetime	Timestamp indicating when this API record was last ingested or updated.

AWSAPIGatewayV2Authorizers

Represents authorization configurations for API Gateway v2 APIs, defining how incoming requests are authenticated and authorized before reaching backend integrations.

Name	Type	Description
ConfigID	integer	Identifier linking this authorizer record to its configuration or ingestion context.
AuthorizerID	string	Unique identifier assigned to the authorizer.
AWSAPIGatewayV2ApiID	string	Identifier of the API to which the authorizer is attached.
Name	string	Name of the authorizer.
AuthorizerType	string	Type of authorizer, such as `JWT` or `REQUEST`.
AuthorizerURI	string	URI of the Lambda function or service that performs authorization.
AuthorizerCredentialsARN	string	ARN of the IAM role used by API Gateway to invoke the authorizer.
IdentityValidationExpression	string	Regular expression used to validate identity information in requests.
AuthorizerResultTtlInSeconds	integer	Time-to-live, in seconds, for cached authorizer results.
EnableSimpleResponses	boolean	Indicates whether simple response format is enabled for the authorizer.
IdentitySourcesJson	string	JSON array defining request sources used to extract identity information.
JwtConfigurationJson	string	JSON configuration defining JWT issuer, audience, and validation settings.
AuthorizerPayloadFormatVersion	string	Payload format version used when invoking the authorizer.
BatchDate	datetime	Timestamp indicating when this authorizer record was last ingested or updated.

AWSAPIGatewayV2Deployments

Represents deployment instances for API Gateway v2 APIs, capturing deployment status, creation details, and whether deployments were created automatically or manually.

Name	Type	Description
ConfigID	integer	Identifier linking this deployment record to its configuration or ingestion context.
DeploymentID	string	Unique identifier assigned to the deployment.
AWSAPIGatewayV2ApiID	string	Identifier of the API associated with the deployment.
AutoDeployed	boolean	Indicates whether the deployment was created automatically by API Gateway.
CreatedDate	datetime	Timestamp when the deployment was created.
DeploymentStatus	string	Current status of the deployment process.
DeploymentStatusMessage	string	Additional details describing the deployment status.
Description	string	Descriptive text providing context about the deployment.
BatchDate	datetime	Timestamp indicating when this deployment record was last ingested or updated.

AWSAPIGatewayV2DomainNames

Represents custom domain names for API Gateway v2, including certificate configuration, security settings, and metadata used to route API traffic through custom endpoints.

Name	Type	Description
ConfigID	integer	Identifier linking this domain name record to its configuration or ingestion context.
ID	integer	Unique identifier assigned to the domain name resource.
DomainName	string	Custom domain name configured for API Gateway v2.
ApiMappingSelectionExpression	string	Expression used to select API mappings for incoming requests to the domain.
OwnershipVerificationCertificateARN	string	ARN of the certificate used to verify ownership of the domain name.
DomainNameConfigurationsJson	string	JSON configuration defining endpoint type, security policy, and certificate settings for the domain.
MutualTlsAuthenticationJson	string	JSON configuration for mutual TLS authentication applied to the domain.
TagsJson	string	JSON object containing tags associated with the domain name.
BatchDate	datetime	Timestamp indicating when this domain name record was last ingested or updated.

AWSAPIGatewayV2IntegrationResponses

Defines how API Gateway v2 processes and transforms responses returned from backend integrations before sending them to clients.

Name	Type	Description
ConfigID	integer	Identifier linking this integration response record to its configuration or ingestion context.
IntegrationResponseID	string	Unique identifier for the integration response.
AWSAPIGatewayV2IntegrationID	string	Identifier of the integration associated with this response.
AWSAPIGatewayV2ApiID	string	Identifier of the API that owns the integration response.
IntegrationResponseKey	string	Selection key used to determine which integration response is returned.
ContentHandlingStrategy	string	Strategy used to handle payload content transformations.
ResponseParametersJson	string	JSON configuration defining how response parameters are mapped.
ResponseTemplatesJson	string	JSON mapping templates used to transform integration responses.
TemplateSelectionExpression	string	Expression used to select the appropriate response template.
BatchDate	datetime	Timestamp indicating when this integration response record was last ingested or updated.

AWSAPIGatewayV2Integrations

Represents backend integrations that connect API Gateway v2 routes to AWS services or HTTP endpoints.

Name	Type	Description
ConfigID	integer	Identifier linking the integration record to its configuration or ingestion context.
IntegrationID	string	Unique identifier for the API integration.
AWSAPIGatewayV2ApiID	string	Identifier of the API associated with the integration.
IntegrationType	string	Type of integration, such as `HTTP`, `AWS_PROXY`, or `MOCK`.
IntegrationURI	string	URI of the backend endpoint or AWS service invoked by the integration.
CredentialsARN	string	ARN of the IAM role used to invoke the backend integration.
ConnectionType	string	Network connection type used by the integration, such as `INTERNET` or `VPC_LINK`.
ConnectionID	string	Identifier of the VPC link used by the integration, if applicable.
Description	string	Descriptive text explaining the purpose of the integration.
IntegrationMethod	string	HTTP method used to invoke the backend.
PassthroughBehavior	string	Behavior for requests that do not match a mapping template.
ApiGatewayManaged	boolean	Indicates whether the integration is managed by API Gateway.
IntegrationResponseSelectionExpression	string	Expression used to select integration responses.
IntegrationSubtype	string	Subtype of the integration, when applicable.
ContentHandlingStrategy	string	Strategy for handling payload content transformations.
PayloadFormatVersion	string	Payload format version passed to the backend.
TimeoutInMillis	integer	Timeout value, in milliseconds, for integration requests.
TemplateSelectionExpression	string	Expression used to choose which mapping template is applied for a request.
RequestParametersJson	string	JSON mapping of request parameters sent to the backend.
RequestTemplatesJson	string	JSON templates used to transform request payloads.
ResponseParametersJson	string	JSON configuration for response parameter mappings.
TlsConfigJson	string	JSON configuration for TLS settings.
BatchDate	datetime	Timestamp when the record was last ingested or updated.

AWSAPIGatewayV2ModelTemplates

Represents mapping templates associated with API Gateway v2 models, used to transform payloads during request or response processing.

Name	Type	Description
ConfigID	integer	Identifier linking this model template record to its configuration or ingestion context.
ID	integer	Unique identifier for the model template.
AWSAPIGatewayV2ApiID	string	Identifier of the API associated with the model template.
ModelID	string	Identifier of the API model that the template is applied to.
TemplateValue	string	Mapping template content used to transform request or response payloads.
BatchDate	datetime	Timestamp indicating when this model template record was last ingested or updated.

AWSAPIGatewayV2Models

Stores data models used by API Gateway v2 to validate request and response payloads.

Name	Type	Description
ConfigID	integer	Identifier linking the model record to its configuration context.
ModelID	string	Unique identifier for the API model.
AWSAPIGatewayV2ApiID	string	Identifier of the API that owns the model.
Name	string	Name of the model.
ContentType	string	Content type associated with the model.
Description	string	Description of the model’s purpose.
Schema	string	JSON schema definition for request or response validation.
BatchDate	datetime	Timestamp when the record was last ingested or updated.

AWSAPIGatewayV2PortalProductSharingPolicies

Defines access control policies that govern how API portal products are shared with principals such as accounts or organizations.

Name	Type	Description
ConfigID	integer	Identifier linking this portal product sharing policy record to its configuration or ingestion context.
ID	integer	Unique identifier for the portal product sharing policy.
PortalProductID	string	Identifier of the portal product to which the sharing policy applies.
PolicyDocument	string	Policy document defining how the portal product is shared and who is granted access.
BatchDate	datetime	Timestamp indicating when this sharing policy record was last ingested or updated.

AWSAPIGatewayV2PortalProducts

Represents products published in API Gateway portals, grouping APIs and stages for discovery and consumption by portal users.

Name	Type	Description
ConfigID	integer	Identifier linking this portal product record to its configuration or ingestion context.
PortalProductID	string	Unique identifier assigned to the API portal product.
PortalProductARN	string	Amazon Resource Name (ARN) of the portal product.
DisplayName	string	Human-readable name shown for the portal product.
Description	string	Descriptive text explaining the purpose or contents of the portal product.
LastModified	datetime	Timestamp indicating when the portal product was last updated.
DisplayOrderJson	string	JSON configuration defining the display order of APIs or stages within the product.
TagsJson	string	JSON object containing tags associated with the portal product.
BatchDate	datetime	Timestamp indicating when this portal product record was last ingested or updated.

AWSAPIGatewayV2Portals

Represents API Gateway portals used to publish and manage APIs for consumers, including configuration, authorization, content, and publication status.

Name	Type	Description
ConfigID	integer	Identifier linking this portal record to its configuration or ingestion context.
PortalID	string	Unique identifier assigned to the API Gateway portal.
PortalARN	string	Amazon Resource Name (ARN) of the portal.
AuthorizationJson	string	JSON configuration defining authorization settings for accessing the portal.
EndpointConfigurationJson	string	JSON configuration describing the portal’s endpoint settings.
IncludedPortalProductARNsJson	string	JSON list of portal product ARNs included in the portal.
LastModified	datetime	Timestamp indicating when the portal configuration was last updated.
LastPublished	datetime	Timestamp of the most recent portal publication.
LastPublishedDescription	string	Description associated with the most recent portal publication.
PortalContentJson	string	JSON content defining the structure and pages of the portal.
PreviewJson	string	JSON configuration used for previewing portal changes before publishing.
PublishStatus	string	Current publication status of the portal.
RumAppMonitorName	string	Name of the RUM application monitor associated with the portal, if enabled.
StatusExceptionJson	string	JSON details describing any status exceptions or errors for the portal.
TagsJson	string	JSON object containing tags assigned to the portal.
BatchDate	datetime	Timestamp indicating when this portal record was last ingested or updated.

AWSAPIGatewayV2ProductPages

Stores metadata for pages attached to API portal products, capturing page identifiers, titles, and modification timestamps used to present documentation and content within API Gateway portals.

Name	Type	Description
ConfigID	integer	Identifier linking this product page record to its configuration or ingestion context.
ProductPageID	string	Unique identifier assigned to the product page.
PortalProductID	string	Identifier of the portal product that the page belongs to.
ProductPageARN	string	Amazon Resource Name (ARN) of the product page.
PageTitle	string	Title displayed for the product page within the API portal.
LastModified	datetime	Timestamp indicating when the product page was last updated.
BatchDate	datetime	Timestamp indicating when this product page record was last ingested or updated.

AWSAPIGatewayV2ProductRestEndpointPages

Captures REST endpoint documentation pages associated with API portal products, including endpoint metadata, publication status, and interactive configuration used for consumer-facing API documentation.

Name	Type	Description
ConfigID	integer	Identifier linking this REST endpoint page record to its configuration or ingestion context.
ProductRestEndpointPageID	string	Unique identifier assigned to the REST endpoint page.
PortalProductID	string	Identifier of the portal product that this endpoint page belongs to.
ProductRestEndpointPageARN	string	Amazon Resource Name (ARN) of the REST endpoint page.
Endpoint	string	REST endpoint path represented by the page.
LastModified	datetime	Timestamp indicating when the endpoint page was last updated.
OperationName	string	Logical operation name associated with the REST endpoint.
RestEndpointIdentifierJson	string	JSON configuration uniquely identifying the REST endpoint within the product.
Status	string	Current publication or availability status of the endpoint page.
StatusExceptionJson	string	JSON details describing any status exceptions or errors for the page.
TryItState	string	Indicates whether interactive "try it" functionality is enabled for the endpoint.
BatchDate	datetime	Timestamp indicating when this endpoint page record was last ingested or updated.

AWSAPIGatewayV2RouteResponses

Defines how API Gateway v2 formats and returns responses for routes, including model selection and parameter mapping.

Name	Type	Description
ConfigID	integer	Identifier linking this route response record to its configuration or ingestion context.
RouteResponseID	string	Unique identifier assigned to the route response.
AWSAPIGatewayV2RouteID	string	Identifier of the route associated with this response.
AWSAPIGatewayV2ApiID	string	Identifier of the API that owns the route response.
RouteResponseKey	string	Selection key that determines which response is returned for a route.
ModelSelectionExpression	string	Expression used to select the appropriate response model.
ResponseModelsJson	string	JSON mapping of response models by content type.
ResponseParametersJson	string	JSON configuration defining how response parameters are mapped.
BatchDate	datetime	Timestamp indicating when this route response record was last ingested or updated.

AWSAPIGatewayV2Routes

Represents routing rules that determine how API Gateway v2 matches incoming requests and forwards them to backend integrations with the appropriate authorization and request handling behavior.

Name	Type	Description
ConfigID	integer	Identifier linking this route record to its configuration or ingestion context.
RouteID	string	Unique identifier assigned to the route.
AWSAPIGatewayV2ApiID	string	Identifier of the API that owns the route.
RouteKey	string	Route selection key, typically combining an HTTP method and resource path.
Target	string	Backend integration target invoked when the route matches.
AuthorizationType	string	Authorization method applied to the route, such as `NONE`, `JWT`, or `CUSTOM`.
AuthorizerID	string	Identifier of the authorizer associated with the route, if applicable.
ApiKeyRequired	boolean	Indicates whether an API key is required to invoke the route.
AuthorizationScopesJson	string	JSON list of authorization scopes required for accessing the route.
ModelSelectionExpression	string	Expression used to select the request or response model for the route.
RequestParametersJson	string	JSON configuration defining request parameter mappings for the route.
OperationName	string	Logical name assigned to the route operation.
RouteResponseSelectionExpression	string	Expression used to select the appropriate route response.
BatchDate	datetime	Timestamp indicating when this route record was last ingested or updated.

AWSAPIGatewayV2RoutingRules

Captures routing rules associated with API Gateway v2 custom domains, defining how requests are evaluated and directed based on priority, conditions, and configured actions.

Name	Type	Description
ConfigID	integer	Identifier linking this routing rule record to its configuration or ingestion context.
RoutingRuleID	string	Unique identifier assigned to the routing rule.
AWSAPIGatewayV2DomainName	string	Custom domain name to which the routing rule applies.
RoutingRuleARN	string	Amazon Resource Name (ARN) of the routing rule.
Priority	integer	Priority value that determines the order in which routing rules are evaluated.
ActionsJson	string	JSON configuration defining the actions taken when the rule conditions are met.
ConditionsJson	string	JSON configuration specifying the conditions used to match incoming requests.
BatchDate	datetime	Timestamp indicating when this routing rule record was last ingested or updated.

AWSAPIGatewayV2Stages

Represents deployment stages that expose specific versions of API Gateway v2 APIs, controlling deployment behavior, logging, routing settings, and environment-specific configuration.

Name	Type	Description
ConfigID	integer	Identifier linking this stage record to its configuration or ingestion context.
ID	integer	Unique identifier assigned to the stage resource.
AWSAPIGatewayV2ApiID	string	Identifier of the API deployed to this stage.
StageName	string	Name of the deployment stage.
ApiGatewayManaged	boolean	Indicates whether the stage is managed automatically by API Gateway.
AutoDeploy	boolean	Indicates whether changes to the API are automatically deployed to the stage.
CreatedDate	datetime	Timestamp when the stage was created.
LastUpdatedDate	datetime	Timestamp when the stage configuration was last updated.
DeploymentID	string	Identifier of the deployment currently associated with the stage.
Description	string	Descriptive text explaining the purpose of the stage.
ClientCertificateID	string	Identifier of the client certificate associated with the stage, if configured.
AccessLogSettingsJson	string	JSON configuration defining access logging settings for the stage.
DefaultRouteSettingsJson	string	JSON configuration specifying default settings applied to all routes in the stage.
RouteSettingsJson	string	JSON configuration defining per-route settings for the stage.
StageVariablesJson	string	JSON key-value pairs available as stage variables.
TagsJson	string	JSON object containing tags assigned to the stage.
BatchDate	datetime	Timestamp indicating when this stage record was last ingested or updated.

AWSAPIGatewayV2VpcLinks

Describes VPC links that enable API Gateway v2 to privately connect to resources inside an Amazon VPC, including network configuration, status, and associated metadata.

Name	Type	Description
ConfigID	integer	Identifier linking this VPC link record to its configuration or ingestion context.
VpcLinkID	string	Unique identifier assigned to the VPC link.
Name	string	Human-readable name of the VPC link.
VpcLinkStatusMessage	string	Descriptive message providing details about the current VPC link status.
VpcLinkStatus	string	Current lifecycle status of the VPC link (e.g., available, pending, failed).
VpcLinkVersion	string	Version of the VPC link resource.
CreatedDate	datetime	Timestamp indicating when the VPC link was created.
SecurityGroupIdsJson	string	JSON list of security group IDs associated with the VPC link.
SubnetIdsJson	string	JSON list of subnet IDs used by the VPC link.
TagsJson	string	JSON object containing tags assigned to the VPC link.
BatchDate	datetime	Timestamp indicating when this VPC link record was last ingested or updated.