--- sourceDocument: Yokohama IT Operations Management sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/yokohama/it-operations-management Release : - yokohama ft:locale : - en-US ft:publication_title : - Yokohama IT Operations Management ft:clusterId : - itom bundleId : - itom workflow : - Technology --- # Amazon API Gateways # Amazon API Gateway discovery with Patterns {#ariaid-title1} * Release version: Yokohama * * Updated July 31, 2025 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes to read Summarize ![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) 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) ## Request apps on the Store {#aws-api-gateway-discovery__section_b5k_lfm_rlb} Visit the [ServiceNow Store](https://store.servicenow.com/sn_appstore_store.do#!/store/home) 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](https://www.servicenow.com/docs/r/store-release-notes/sn-store-release-notes.html).{#aws-api-gateway-discovery__inline-send-to-store} ## Prerequisites {#aws-api-gateway-discovery__section_wf1_tn2_ycb} Verify the AWS prerequisites : For more information, see the prerequisite section in [Amazon AWS Cloud components discovery using patterns](https://servicenow-prod.fluidtopics.net/nnBwzYmMo_kpTZpG3y5~xQ "Discovery and Service Mapping Patterns uses patterns to discover components of the Amazon AWS Cloud deployment during horizontal discovery. Discovering some of these resources may require updating to the latest version of the Discovery and Service Mapping Patterns application from the ServiceNow Store."). 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](https://servicenow-prod.fluidtopics.net/dAJhpprY0KbtPeUkkgzusg "Avoid duplicate AWS API Gateway configuration items (CIs) by retiring legacy data model CIs through a scheduled job."). ## Data collected by Discovery during horizontal discovery {#aws-api-gateway-discovery__section_fg5_mgf_ycb} Discovery populates the data in the CMDB when running the Amazon AWS API Gateway pattern. {#aws-api-gateway-discovery__table_axv_trw_chc__entry__2} | 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 1. AWS API Gateway \[cmdb_ci_aws_api_gateway\]] {#aws-api-gateway-discovery__table_axv_trw_chc} {#aws-api-gateway-discovery__table_brf_rtw_chc__entry__2} | 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 2. Managed API \[cmdb_ci_managed_api\]] {#aws-api-gateway-discovery__table_brf_rtw_chc} {#aws-api-gateway-discovery__table_bxk_vrw_chc__entry__2} | Field | Description | |-|-| | Name \[name\] | Unique name or IP address of the DNS host. | | IP Address \[ip_address\] | IP address of the DNS host. | [Table 3. DNS Name \[cmdb_ci_dns_name\]] {#aws-api-gateway-discovery__table_bxk_vrw_chc} Figure 2. Amazon API gateway dependency view ## Relationships {#aws-api-gateway-discovery__section_zgx_wrj_cdb} Discovery creates these relationships to support Amazon API Gateway discovery. {#aws-api-gateway-discovery__table_slx_jsw_chc__entry__3} | 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\] | [ ] {#aws-api-gateway-discovery__table_slx_jsw_chc} ## Tag discovery {#aws-api-gateway-discovery__section_cfb_lsw_chc} The Amazon AWS API Gateway pattern collects tags and populates them in the Key Value \[cmdb_key_value\] table. {#aws-api-gateway-discovery__table_eth_jx2_5fc__entry__2} | Field | Description | |-|-| | Key \[key\] | Tag name. | | Value \[value\] | Tag value. | | Configuration item \[configuration_item\] | References the Managed API \[cmdb_ci_managed_api\] table. | [Table 4. Key Value \[cmdb_key_value\]] {#aws-api-gateway-discovery__table_eth_jx2_5fc} ## Connections discovered by Service Mapping during the top-down discovery {#aws-api-gateway-discovery__section_knp_fjd_908} 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 {#aws-api-gateway-discovery__ul_nm5_3by_fdb} * **[Test patterns for discovering AWS API Gateway and AWS Lambda](https://servicenow-prod.fluidtopics.net/6M9_oGGz10_8B5pM~dhdWw)** Run the horizontal and top-down discovery using Amazon AWS API Gateway \[cmdb_ci_cloud_gateway\] and Amazon AWS Lambda \[cmdb_ci_cloud_function\] patterns. Verify that the result is as expected. * **[Retire legacy AWS API Gateway data model CIs](https://servicenow-prod.fluidtopics.net/dAJhpprY0KbtPeUkkgzusg)** Avoid duplicate AWS API Gateway configuration items (CIs) by retiring legacy data model CIs through a scheduled job.