AWS cli documentation change
Summary
Updated documentation for create-gateway-target command: Added new configuration options for connectors, passthrough targets, and inference targets; Expanded tagged union structures; Added document type handling note; Made --name parameter optional; Added new JSON syntax examples.
Security assessment
The changes add security documentation for cross-account access controls (bucketOwnerAccountId), session stickiness configuration (stickinessConfiguration with identifier/timeout), and parameter visibility controls (parameterOverrides.visible). These features help implement security best practices for access control and session management.
Diff
diff --git a/cli/latest/reference/bedrock-agentcore-control/create-gateway-target.md b/cli/latest/reference/bedrock-agentcore-control/create-gateway-target.md index d1118119a..9ea1320f9 100644 --- a//cli/latest/reference/bedrock-agentcore-control/create-gateway-target.md +++ b//cli/latest/reference/bedrock-agentcore-control/create-gateway-target.md @@ -15 +15 @@ - * [AWS CLI 2.35.5 Command Reference](../../index.html) » + * [AWS CLI 2.35.8 Command Reference](../../index.html) » @@ -62,0 +63,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc +`create-gateway-target` uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type `document` must be provided as JSON. Shorthand syntax does not support document types. + @@ -68 +70 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc - --name <value> + [--name <value>] @@ -110 +112 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc -`--name` (string) [required] +`--name` (string) @@ -149 +151 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc -> This is a Tagged Union structure. Only one of the following top level keys can be set: `mcp`, `http`. +> This is a Tagged Union structure. Only one of the following top level keys can be set: `mcp`, `http`, `inference`. @@ -157 +159 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->> This is a Tagged Union structure. Only one of the following top level keys can be set: `openApiSchema`, `smithyModel`, `lambda`, `mcpServer`, `apiGateway`. +>> This is a Tagged Union structure. Only one of the following top level keys can be set: `openApiSchema`, `smithyModel`, `lambda`, `mcpServer`, `apiGateway`, `connector`. @@ -243 +245 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>> * pattern: `arn:(aws[a-zA-Z-]*)?:lambda:([a-z]{2}(-gov)?-[a-z]+-\d{1}):(\d{12}):function:([a-zA-Z0-9-_.]+)(:(\$LATEST|[a-zA-Z0-9-]+))?` +>>>> * pattern: `arn:(aws[a-zA-Z-]*)?:lambda:([a-z]{2}(-gov)?-[a-z]+-\d{1}):(\d{12}):function:([a-zA-Z0-9-_.]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?` @@ -665,0 +668,87 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc +>> +>> connector -> (structure) +>> +>>> The connector integration configuration for the Model Context Protocol target. This configuration defines how the gateway uses a pre-built connector to communicate with the target. +>>> +>>> source -> (structure) [required] +>>> +>>>> The source configuration identifying which connector to use. +>>>> +>>>> connectorId -> (string) [required] +>>>> +>>>>> The identifier for the connector integration (for example, `bedrock-knowledge-bases` ). +>>>>> +>>>>> Constraints: +>>>>> +>>>>> * min: `1` +>>>>> * max: `256` +>>>>> + +>>> +>>> enabled -> (list) +>>> +>>>> A list of tool names to enable from this connector. If absent, all tools provided by the connector are enabled. +>>>> +>>>> Constraints: +>>>> +>>>> * min: `1` +>>>> * max: `50` +>>>> + +>>>> +>>>> (string) +>>> +>>> configurations -> (list) +>>> +>>>> A list of per-tool configurations for the connector. +>>>> +>>>> (structure) +>>>> +>>>>> Configuration for a single tool within a connector. +>>>>> +>>>>> name -> (string) [required] +>>>>> +>>>>>> The tool or operation name (for example, `retrieve` or `webSearch` ). +>>>>>> +>>>>>> Constraints: +>>>>>> +>>>>>> * min: `0` +>>>>>> * max: `64` +>>>>>> * pattern: `[a-zA-Z][a-zA-Z0-9_-]*` +>>>>>> + +>>>>> +>>>>> description -> (string) +>>>>> +>>>>>> An agent-facing description override for this tool. +>>>>>> +>>>>>> Constraints: +>>>>>> +>>>>>> * min: `0` +>>>>>> * max: `2000` +>>>>>> + +>>>>> +>>>>> parameterValues -> (document) +>>>>> +>>>>>> Parameters to set as fixed or default values when provisioning this tool. +>>>>> +>>>>> parameterOverrides -> (list) +>>>>> +>>>>>> Parameters to expose to the agent at runtime, with optional description overrides. +>>>>>> +>>>>>> (structure) +>>>>>> +>>>>>>> Specifies a parameter override for a connector tool, allowing you to control parameter visibility and descriptions. +>>>>>>> +>>>>>>> path -> (string) [required] +>>>>>>> +>>>>>>>> A JSON Pointer path identifying the parameter (for example, `/numberOfResults` or `/filter` ). +>>>>>>> +>>>>>>> description -> (string) +>>>>>>> +>>>>>>>> An agent-facing description override for this parameter. +>>>>>>> +>>>>>>> visible -> (boolean) +>>>>>>> +>>>>>>>> Whether this parameter is visible to the agent. If not specified, uses the service default. @@ -673 +762 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->> This is a Tagged Union structure. Only one of the following top level keys can be set: `agentcoreRuntime`. +>> This is a Tagged Union structure. Only one of the following top level keys can be set: `agentcoreRuntime`, `passthrough`. @@ -697,0 +787,267 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc +>>> +>>> schema -> (structure) +>>> +>>>> The API schema configuration that defines the structure of the runtime target’s API. +>>>> +>>>> source -> (tagged union structure) [required] +>>>> +>>>>> Configuration for API schema. +>>>>> +>>>>> ### Note +>>>>> +>>>>> This is a Tagged Union structure. Only one of the following top level keys can be set: `s3`, `inlinePayload`. +>>>>> +>>>>> s3 -> (structure) +>>>>> +>>>>>> The Amazon S3 configuration for a gateway. This structure defines how the gateway accesses files in Amazon S3. +>>>>>> +>>>>>> uri -> (string) +>>>>>> +>>>>>>> The URI of the Amazon S3 object. This URI specifies the location of the object in Amazon S3. +>>>>>>> +>>>>>>> Constraints: +>>>>>>> +>>>>>>> * pattern: `s3://.{1,2043}` +>>>>>>> + +>>>>>> +>>>>>> bucketOwnerAccountId -> (string) +>>>>>> +>>>>>>> The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket. +>>>>>>> +>>>>>>> Constraints: +>>>>>>> +>>>>>>> * pattern: `[0-9]{12}` +>>>>>>> + +>>>>> +>>>>> inlinePayload -> (string) +>>>>> +>>>>>> The inline payload containing the API schema definition. +>> +>> passthrough -> (structure) +>> +>>> The passthrough configuration for the HTTP target. A passthrough target forwards requests directly to an external HTTP endpoint. +>>> +>>> endpoint -> (string) [required] +>>> +>>>> The HTTPS endpoint that the gateway forwards requests to for this passthrough target. +>>>> +>>>> Constraints: +>>>> +>>>> * min: `1` +>>>> * max: `2048` +>>>> * pattern: `https://[a-zA-Z0-9\-\.]+(:[0-9]{1,5})?(/.*)?` +>>>> + +>>> +>>> protocolType -> (string) [required] +>>> +>>>> The application protocol the passthrough target implements. Required for passthrough targets. +>>>> +>>>> Possible values: +>>>> +>>>> * `MCP` +>>>> * `A2A` +>>>> * `INFERENCE` +>>>> * `CUSTOM` +>>>> + +>>> +>>> schema -> (structure) +>>> +>>>> The API schema configuration that defines the structure of the passthrough target’s API. +>>>> +>>>> source -> (tagged union structure) [required] +>>>> +>>>>> Configuration for API schema. +>>>>> +>>>>> ### Note +>>>>> +>>>>> This is a Tagged Union structure. Only one of the following top level keys can be set: `s3`, `inlinePayload`. +>>>>> +>>>>> s3 -> (structure)