Amazon API Gateway discovery with Patterns

  • Release version: Yokohama
  • Updated July 31, 2025
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Amazon API Gateway discovery with Patterns

    The ServiceNow Discovery and Service Mapping applications use the Amazon AWS API Gateway pattern to identify Amazon API Gateways and their connections within your environment. This capability helps populate and maintain accurate AWS API Gateway data in the ServiceNow CMDB, enabling better visibility and management of AWS resources.

    Show full answer Show less

    Starting with version 1.29.0 of the Discovery and Service Mapping Patterns application, the data model for Amazon AWS API Gateway has been updated, so upgrading to the latest version from the ServiceNow Store is recommended to ensure full and accurate discovery.

    Key Features

    • AWS API Gateway Data Model: Discovery collects key configuration items (CIs) such as AWS API Gateway instances, Managed APIs, and DNS Names, capturing essential fields like names, IDs, operational and install statuses, API types, versions, and fully qualified domain names.
    • Relationships: The pattern automatically creates relationships between CIs, including connections between AWS API Gateways and Managed APIs, Managed APIs and AWS Datacenters, as well as DNS Names and their hosting datacenters. This relationship mapping supports comprehensive service mapping and dependency views.
    • Tag Discovery: AWS tags associated with API Gateways are collected and stored in the Key Value table, linking tags directly to Managed API CIs for enhanced metadata management.
    • Service Mapping Connections: Service Mapping performs top-down discovery to find outgoing connections from AWS API Gateways, including AWS Lambda functions, VPC Links for Virtual Private Clouds, and configured HTTP endpoints.
    • Legacy Data Model Management: To prevent duplicates, a scheduled job can retire legacy AWS API Gateway CIs, ensuring data consistency and cleanliness in the CMDB.
    • Testing: Customers can validate their discovery setup by running horizontal and top-down discovery patterns for AWS API Gateway and AWS Lambda and verifying the results.

    Practical Benefits for ServiceNow Customers

    • Gain an up-to-date and accurate view of your AWS API Gateway infrastructure within ServiceNow’s CMDB.
    • Understand dependencies and relationships between API gateways, managed APIs, AWS datacenters, and DNS entries to support impact analysis and service mapping.
    • Leverage tag data for improved categorization, filtering, and reporting on AWS resources.
    • Ensure data integrity by retiring legacy CIs, avoiding duplication issues.
    • Integrate API Gateway discovery with Service Mapping to track real-time connections to AWS Lambda and other AWS services for comprehensive application service visibility.

    The ServiceNow Discovery and Service Mapping applications use the Amazon AWS API Gateway pattern to find Amazon API Gateways and connections to other entities. Discovering some of these resources may require updating to the latest version of the Discovery and Service Mapping Patterns application from the ServiceNow Store.

    Starting with Discovery and Service Mapping Patterns version 1.29.0, the Amazon AWS API Gateway pattern data model has changed.

    Figure 1. Amazon AWS API Gateway pattern data model (starting with Discovery and Service Mapping Patterns version 1.29.0)
    Amazon AWS API Gateway pattern new data model relationships

    Request apps on the Store

    Visit the ServiceNow Store website to view all the available apps and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.

    Prerequisites

    Verify the AWS prerequisites
    For more information, see the prerequisite section in Amazon AWS Cloud components discovery using patterns.
    Retire legacy data model CIs to avoid duplicates
    To avoid duplicate CIs, activate a schedule job to mark legacy data model CIs as retired. For more information, see Retire legacy AWS API Gateway data model CIs.

    Data collected by Discovery during horizontal discovery

    Discovery populates the data in the CMDB when running the Amazon AWS API Gateway pattern.

    Table 1. AWS API Gateway [cmdb_ci_aws_api_gateway]
    Field Description
    Name [name] Concatenate of "aws-gateway-" + account ID + region.

    For example: aws-gateway-000000000000-us-east-1.
    ID [id] Concatenate of "aws-gateway-" + account ID + region.

    For example: aws-gateway-000000000000-us-east-1.
    Install Status [install_status] Install status of the AWS gateway. Default value is Installed.
    Operational status [operational_status] Operational status of the AWS gateway. Default value is Operational.
    Table 2. Managed API [cmdb_ci_managed_api]
    Field Description
    ID [id] Concatenate of "https://" + API ID + ".execute-api." + region + ".amazonaws.com".

    For example: https://a1b2c3d4e5.execute-api.us-east-1.amazonaws.com.
    Name [name] Name of the API.
    Description [short_description] Description of API.
    Install Status [install_status] Install status of the API. Default value is Installed.
    Operational status [operational_status] Operational status of the API. Default value is Operational.
    Type [type] Type of API: REST.
    Version [version] Version of API.
    Fully qualified domain name [fqdn] Concatenate of API ID + ".execute-api." + region + ".amazonaws.com".

    For example: a1b2c3d4e5.execute-api.us-east-1.amazonaws.com.
    Table 3. DNS Name [cmdb_ci_dns_name]
    Field Description
    Name [name] Unique name or IP address of the DNS host.
    IP Address [ip_address] IP address of the DNS host.
    Figure 2. Amazon API gateway dependency view
    aWS API gateway CIs and connections on a Dependency Views map

    Relationships

    Discovery creates these relationships to support Amazon API Gateway discovery.

    CI Relationship CI
    AWS API Gateway [cmdb_ci_aws_api_gateway] Provides::Provided by Managed API [cmdb_ci_managed_api]
    Managed API [cmdb_ci_managed_api] Hosted on::Hosts AWS Datacenter [cmdb_ci_aws_datacenter]
    Managed API [cmdb_ci_managed_api] Uses::Used by DNS Name [cmdb_ci_dns_name]
    DNS Name [cmdb_ci_dns_name] Hosted on::Hosts AWS Datacenter [cmdb_ci_aws_datacenter]
    Key Value [cmdb_key_value] References Managed API [cmdb_ci_managed_api]

    Tag discovery

    The Amazon AWS API Gateway pattern collects tags and populates them in the Key Value [cmdb_key_value] table.

    Table 4. Key Value [cmdb_key_value]
    Field Description
    Key [key] Tag name.
    Value [value] Tag value.
    Configuration item [configuration_item] References the Managed API [cmdb_ci_managed_api] table.

    Connections discovered by Service Mapping during the top-down discovery

    Service Mapping performs the top-down discovery of the AWS API Gateways in the context of application services. It discovers outgoing connections of the AWS API Gateways:
    • AWS Lambda
    • VPC Link for Virtual Private Cloud
    • HTTP endpoint defined as the configured URL on the API Gateway