Amazon API Gateway discovery with Patterns

  • Release version: Zurich
  • 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 utilize the Amazon AWS API Gateway pattern to identify Amazon API Gateways and their connections to other entities within your environment. This capability helps populate and maintain accurate data in the Configuration Management Database (CMDB) related to AWS API Gateways. To ensure comprehensive discovery, customers may need to update to the latest Discovery and Service Mapping Patterns application (version 1.29.0 or later) from the ServiceNow Store, as the data model has been updated starting from this version.

    Show full answer Show less

    Key Features

    • Updated Data Model: The discovery pattern now uses an improved data model for AWS API Gateway and Managed API CIs, enhancing data accuracy and integration.
    • CMDB Population: Discovery populates key tables with AWS API Gateway and Managed API information, including unique identifiers, names, statuses, types, versions, and domain details.
    • Relationship Mapping: The pattern automatically creates relationships between AWS API Gateway, Managed APIs, AWS Datacenters, DNS Names, and Tag data, providing a clear dependency map within the CMDB.
    • Tag Discovery: Tags associated with AWS API Gateways are collected and stored in the Key Value table, enabling better categorization and filtering of CIs.
    • Service Mapping Integration: Top-down discovery identifies outgoing connections from AWS API Gateways, such as AWS Lambda, VPC Links, and HTTP endpoints, linking them to application services.
    • Legacy CI Management: A scheduled job is available to retire legacy AWS API Gateway data model CIs to prevent duplication in the CMDB.

    Practical Guidance for ServiceNow Customers

    • Verify AWS Prerequisites: Ensure your AWS environment meets the necessary prerequisites for Discovery, as detailed in the AWS discovery using patterns documentation.
    • Update Discovery Patterns: Upgrade to Discovery and Service Mapping Patterns version 1.29.0 or higher to leverage the latest data model improvements and avoid conflicts with legacy data.
    • Retire Legacy CIs: Activate the scheduled job to retire legacy AWS API Gateway CIs to maintain a clean and accurate CMDB.
    • Run Discovery and Service Mapping: Execute horizontal discovery using the Amazon AWS API Gateway and AWS Lambda patterns, followed by top-down discovery for application service context and connection mapping.
    • Validate Results: Confirm that discovered data and relationships appear as expected in the CMDB and Service Mapping dependency views.

    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 AWS 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