{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":29863,"path":"it-operations-management/discovery-and-service-mapping-patterns/aws-api-gateway-discovery.md","title":"Amazon API Gateway discovery with Patterns","bundle":null,"doc_type":null,"release":"australia","body":"\n# Amazon API Gateway discovery with Patterns\n\nThe 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 might require updating to the latest version of the Discovery and Service Mapping Patterns application from the ServiceNow Store.\n\nStarting with Discovery and Service Mapping Patterns version 1.29.0, the Amazon AWS API Gateway pattern data model has changed.\n\n\\[Omitted image \"aws-api-gateway-new-model.png\"\\] Alt text: Amazon AWS API Gateway pattern new data model relationships\n\n## Request apps on the Store\n\nVisit the [ServiceNow Store](https://store.servicenow.com/sn_appstore_store.do#!/store/home) 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).\n\n## Prerequisites\n\n-   **Verify the AWS prerequisites**\n\n    For more information, see the prerequisite section in [AWS discovery using patterns](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/discovery-and-service-mapping-patterns/data-discovered-aws-patterns.md).\n\n-   **Retire legacy data model CIs to avoid duplicates**\n\n    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://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/discovery-and-service-mapping-patterns/retire-legacy-aws-api-gateway-cis.md).\n\n\n## Data collected by Discovery during horizontal discovery\n\nDiscovery populates the data in the CMDB when running the Amazon AWS API Gateway pattern.\n\n<table id=\"table_axv_trw_chc\"><thead><tr><th>\n\nField\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nName \\[name\\]\n\n</td><td>\n\nConcatenate of \"aws-gateway-\" + account ID + region.For example: **aws-gateway-000000000000-us-east-1**.\n\n</td></tr><tr><td>\n\nID \\[id\\]\n\n</td><td>\n\nConcatenate of \"aws-gateway-\" + account ID + region.For example: **aws-gateway-000000000000-us-east-1**.\n\n</td></tr><tr><td>\n\nInstall Status \\[install\\_status\\]\n\n</td><td>\n\nInstall status of the AWS gateway. Default value is Installed.\n\n</td></tr><tr><td>\n\nOperational status \\[operational\\_status\\]\n\n</td><td>\n\nOperational status of the AWS gateway. Default value is Operational.\n\n</td></tr></tbody>\n</table><table id=\"table_brf_rtw_chc\"><thead><tr><th>\n\nField\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nID \\[id\\]\n\n</td><td>\n\nConcatenate of \"https://\" + API ID + \".execute-api.\" + region + \".amazonaws.com\". For example: **https://a1b2c3d4e5.execute-api.us-east-1.amazonaws.com**.\n\n</td></tr><tr><td>\n\nName \\[name\\]\n\n</td><td>\n\nName of the API.\n\n</td></tr><tr><td>\n\nDescription \\[short\\_description\\]\n\n</td><td>\n\nDescription of API.\n\n</td></tr><tr><td>\n\nInstall Status \\[install\\_status\\]\n\n</td><td>\n\nInstall status of the API. Default value is Installed.\n\n</td></tr><tr><td>\n\nOperational status \\[operational\\_status\\]\n\n</td><td>\n\nOperational status of the API. Default value is Operational.\n\n</td></tr><tr><td>\n\nType \\[type\\]\n\n</td><td>\n\nType of API: REST.\n\n</td></tr><tr><td>\n\nVersion \\[version\\]\n\n</td><td>\n\nVersion of API.\n\n</td></tr><tr><td>\n\nFully qualified domain name \\[fqdn\\]\n\n</td><td>\n\nConcatenate of API ID + \".execute-api.\" + region + \".amazonaws.com\".For example: **a1b2c3d4e5.execute-api.us-east-1.amazonaws.com**.\n\n</td></tr></tbody>\n</table>|Field|Description|\n|-----|-----------|\n|Name \\[name\\]|Unique name or IP address of the DNS host.|\n|IP Address \\[ip\\_address\\]|IP address of the DNS host.|\n\n\\[Omitted image \"aws-api-gateway-dependency-view.png\"\\] Alt text: aWS API gateway CIs and connections on a Dependency Views map\n\n## Relationships\n\nDiscovery creates these relationships to support Amazon API Gateway discovery.\n\n|CI|Relationship|CI|\n|---|------------|---|\n|AWS API Gateway \\[cmdb\\_ci\\_aws\\_api\\_gateway\\]|Provides::Provided by|Managed API \\[cmdb\\_ci\\_managed\\_api\\]|\n|Managed API \\[cmdb\\_ci\\_managed\\_api\\]|Hosted on::Hosts|AWS Datacenter \\[cmdb\\_ci\\_aws\\_datacenter\\]|\n|Managed API \\[cmdb\\_ci\\_managed\\_api\\]|Uses::Used by|DNS Name \\[cmdb\\_ci\\_dns\\_name\\]|\n|DNS Name \\[cmdb\\_ci\\_dns\\_name\\]|Hosted on::Hosts|AWS Datacenter \\[cmdb\\_ci\\_aws\\_datacenter\\]|\n|Key Value \\[cmdb\\_key\\_value\\]|References|Managed API \\[cmdb\\_ci\\_managed\\_api\\]|\n\n## Tag discovery\n\nThe Amazon AWS API Gateway pattern collects tags and populates them in the Key Value \\[cmdb\\_key\\_value\\] table.\n\n|Field|Description|\n|-----|-----------|\n|Key \\[key\\]|Tag name.|\n|Value \\[value\\]|Tag value.|\n|Configuration item \\[configuration\\_item\\]|References the Managed API \\[cmdb\\_ci\\_managed\\_api\\] table.|\n\n## Connections discovered by Service Mapping during the top-down discovery\n\nService 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:\n\n-   AWS Lambda\n-   VPC Link for Virtual Private Cloud\n-   HTTP endpoint defined as the configured URL on the API Gateway\n\n-   **[Test patterns for discovering AWS API Gateway and AWS Lambda](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/discovery-and-service-mapping-patterns/test-patterns-for-discovering-aws-api-and-aws-lambda.md)**  \nRun 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.\n-   **[Retire legacy AWS API Gateway data model CIs](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/discovery-and-service-mapping-patterns/retire-legacy-aws-api-gateway-cis.md)**  \nAvoid duplicate AWS API Gateway configuration items \\(CIs\\) by retiring legacy data model CIs through a scheduled job.\n\n**Parent Topic:**[AWS discovery using patterns](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/discovery-and-service-mapping-patterns/data-discovered-aws-patterns.md)\n\n"}}