AWS bedrock-agentcore documentation change
Summary
Updated documentation with typographical fixes, formatting changes (including apostrophe usage and markdown heading style), and minor grammatical adjustments. No functional changes to the API Gateway target configuration.
Security assessment
The changes are purely cosmetic and editorial, involving typographical corrections (straight quotes to curly quotes), formatting adjustments (changing '###### Result' to '**Result**'), and minor grammatical fixes. There are no changes to security configurations, no mention of vulnerabilities, and no new security guidance added. The existing security-related content about IAM authorization and API keys remains unchanged in substance.
Diff
diff --git a/bedrock-agentcore/latest/devguide/gateway-target-api-gateway.md b/bedrock-agentcore/latest/devguide/gateway-target-api-gateway.md index 92acbb08a..f7c5d8eba 100644 --- a//bedrock-agentcore/latest/devguide/gateway-target-api-gateway.md +++ b//bedrock-agentcore/latest/devguide/gateway-target-api-gateway.md @@ -9 +9 @@ Key considerations and limitationsAPI Gateway Tool ConfigurationAPI Gateway expo -An API Gateway REST API target connects your gateway to a [stage](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-stages.html) of your REST API. The gateway translates incoming MCP requests into HTTP requests to your REST API and handles response formatting. When you add or update an API Gateway target, AgentCore Gateway calls API Gateway's [GetExport](https://docs.aws.amazon.com/apigateway/latest/api/API_GetExport.html) API on your behalf. +An API Gateway REST API target connects your gateway to a [stage](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-stages.html) of your REST API. The gateway translates incoming MCP requests into HTTP requests to your REST API and handles response formatting. When you add or update an API Gateway target, AgentCore Gateway calls API Gateway’s [GetExport](https://docs.aws.amazon.com/apigateway/latest/api/API_GetExport.html) API on your behalf. @@ -40 +40 @@ When using an API Gateway REST API stage as a target, keep in mind the following - * If your REST API has a method that uses `AWS_IAM` authorization and requires an [API key](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html), AgentCore Gateway won't support this method. It will be excluded from processing. + * If your REST API has a method that uses `AWS_IAM` authorization and requires an [API key](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) , AgentCore Gateway won’t support this method. It will be excluded from processing. @@ -42 +42 @@ When using an API Gateway REST API stage as a target, keep in mind the following - * If your API uses a proxy resources, such as `/pets/{proxy+}`, AgentCore Gateway won't support this method. + * If your API uses a proxy resources, such as `/pets/{proxy+}` , AgentCore Gateway won’t support this method. @@ -44 +44 @@ When using an API Gateway REST API stage as a target, keep in mind the following - * To set up your API Gateway Target, AgentCore Gateway calls API Gateway's [GetExport](https://docs.aws.amazon.com/apigateway/latest/api/API_GetExport.html) API on your behalf to get an OpenAPI 3.0 formatted export of your REST API Definition. For more details on this and how it might affect your Target configuration, see API Gateway Export. + * To set up your API Gateway Target, AgentCore Gateway calls API Gateway’s [GetExport](https://docs.aws.amazon.com/apigateway/latest/api/API_GetExport.html) API on your behalf to get an OpenAPI 3.0 formatted export of your REST API Definition. For more details on this and how it might affect your Target configuration, see API Gateway Export. @@ -59 +59 @@ Tool filters allow you to select REST API operations using path and method combi - * **Wildcard paths** – Matches all paths starting with the specified prefix, such as `/pets/*` + * **Wildcard paths** – Matches all paths starting with the specified prefix, such as /pets/* @@ -68 +68 @@ Each filter specifies both a path and a list of HTTP methods. The filter resolve -By default, the MCP tool name is taken from the `operationId` for each path and method combination that matches your filters. If there isn't an `operationId` for a filter match, you'll need a corresponding tool override that provides a name. If both the `operationId` and the override name are missing, target creation and updates will fail validation. For more information on tool names in AgentCore Gateway, see [Understand how AgentCore Gateway tools are named](./gateway-tool-naming.html). +By default, the MCP tool name is taken from the `operationId` for each path and method combination that matches your filters. If there isn’t an `operationId` for a filter match, you’ll need a corresponding tool override that provides a name. If both the `operationId` and the override name are missing, target creation and updates will fail validation. For more information on tool names in AgentCore Gateway, see [Understand how AgentCore Gateway tools are named](./gateway-tool-naming.html). @@ -70 +70 @@ By default, the MCP tool name is taken from the `operationId` for each path and -Tool overrides are optional. They allow you to customize the tool name or description for specific operations after filtering. Each override must specify an explicit path and a single HTTP method. Wildcards are not supported. The override must match an operation that exists in your API and must correspond to one of the operations resolved by your filters. You cannot override operations that weren't selected. If you are experiencing errors with imports from operations with out an `operationId` you can use a tool override instead. +Tool overrides are optional. They allow you to customize the tool name or description for specific operations after filtering. Each override must specify an explicit path and a single HTTP method. Wildcards are not supported. The override must match an operation that exists in your API and must correspond to one of the operations resolved by your filters. You cannot override operations that weren’t selected. If you are experiencing errors with imports from operations with out an `operationId` you can use a tool override instead. @@ -94 +94 @@ Tool Configuration: -###### Result +**Result** @@ -113,2 +113 @@ Tool Configuration: - -###### Result +**Result** @@ -141 +140 @@ Tool Configuration: -###### Result +**Result** @@ -168 +167 @@ Tool Configuration: -###### Result +**Result** @@ -205 +204 @@ Tool Configuration -###### Result +**Result** @@ -220 +219 @@ To set up your API Gateway target, AgentCore Gateway calls the [GetExport](https - * The GetExport request is made with using a [Forward Access Session](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_forward_access_sessions.html) and uses the caller's credentials. + * The GetExport request is made with using a [Forward Access Session](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_forward_access_sessions.html) and uses the caller’s credentials. @@ -273,2 +272 @@ Export the OpenAPI definition from your deployed API stage by calling [GetExport - -#### Set the `operationId` by updating your REST API's method +#### Set the `operationId` by updating your REST API’s method @@ -323 +321 @@ API Gateway allows you to secure your REST API with IAM. When IAM authorization -###### To set up IAM outbound authorization +**To set up IAM outbound authorization** @@ -382 +380 @@ To set up outbound authorization with an API key, you use the AgentCore Identity -###### To set up API key outbound authorization +**To set up API key outbound authorization**