AWS cli documentation change
Summary
Updated AWS CLI command reference for Bedrock Agent's create-agent operation, adding new parameters (instruction, foundation-model, idle-session-ttl-in-seconds), reorganizing parameters, and updating descriptions for orchestration types and security-related fields.
Security assessment
The change introduces --idle-session-ttl-in-seconds parameter documentation, which allows configuring session expiration to automatically delete stale data, improving security posture. However, there's no evidence this addresses a specific vulnerability. Security features like encryption (customer-encryption-key-arn) and IAM roles (agent-resource-role-arn) were moved/reordered but not newly added.
Diff
diff --git a/cli/latest/reference/bedrock-agent/create-agent.md b/cli/latest/reference/bedrock-agent/create-agent.md index 77bbf5bfc..01209fb6a 100644 --- a//cli/latest/reference/bedrock-agent/create-agent.md +++ b//cli/latest/reference/bedrock-agent/create-agent.md @@ -15 +15 @@ - * [AWS CLI 2.28.8 Command Reference](../../index.html) » + * [AWS CLI 2.28.11 Command Reference](../../index.html) » @@ -80 +79,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc - [--agent-collaboration <value>] @@ -82 +80,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc - [--agent-resource-role-arn <value>] @@ -83,0 +82,4 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc + [--instruction <value>] + [--foundation-model <value>] + [--description <value>] + [--orchestration-type <value>] @@ -84,0 +87,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc + [--idle-session-ttl-in-seconds <value>] + [--agent-resource-role-arn <value>] @@ -86,2 +90,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc - [--description <value>] - [--foundation-model <value>] + [--tags <value>] + [--prompt-override-configuration <value>] @@ -89,2 +92,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc - [--idle-session-ttl-in-seconds <value>] - [--instruction <value>] @@ -92,3 +94 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc - [--orchestration-type <value>] - [--prompt-override-configuration <value>] - [--tags <value>] + [--agent-collaboration <value>] @@ -119 +119 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc -`--agent-collaboration` (string) +`--agent-name` (string) @@ -121 +121,13 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc -> The agent’s collaboration role. +> A name for the agent that you create. + +`--client-token` (string) + +> A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) . + +`--instruction` (string) + +> Instructions that tell the agent what it should do and how it should interact with users. + +`--foundation-model` (string) + +> The identifier for the model that you want to be used for orchestration by the agent you create. @@ -123 +135 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc -> Possible values: +> The `modelId` to provide depends on the type of model or throughput that you use: @@ -125,3 +137,5 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc -> * `SUPERVISOR` -> * `SUPERVISOR_ROUTER` -> * `DISABLED` +> * If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see [Amazon Bedrock base model IDs (on-demand throughput)](https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns) in the Amazon Bedrock User Guide. +> * If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see [Supported Regions and models for cross-region inference](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html) in the Amazon Bedrock User Guide. +> * If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see [Run inference using a Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html) in the Amazon Bedrock User Guide. +> * If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see [Use a custom model in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html) in the Amazon Bedrock User Guide. +> * If you use an [imported model](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html) , specify the ARN of the imported model. You can get the model ARN from a successful call to [CreateModelImportJob](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateModelImportJob.html) or from the Imported models page in the Amazon Bedrock console. @@ -131,3 +145 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc -`--agent-name` (string) - -> A name for the agent that you create. +`--description` (string) @@ -135 +147 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc -`--agent-resource-role-arn` (string) +> A description of the agent. @@ -137 +149 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc -> The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent. +`--orchestration-type` (string) @@ -139 +151,7 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc -`--client-token` (string) +> Specifies the type of orchestration strategy for the agent. This is set to `DEFAULT` orchestration type, by default. +> +> Possible values: +> +> * `DEFAULT` +> * `CUSTOM_ORCHESTRATION` +> @@ -141 +158,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc -> A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) . @@ -175,49 +191,0 @@ JSON Syntax: -`--customer-encryption-key-arn` (string) - -> The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent. - -`--description` (string) - -> A description of the agent. - -`--foundation-model` (string) - -> The identifier for the model that you want to be used for orchestration by the agent you create. -> -> The `modelId` to provide depends on the type of model or throughput that you use: -> -> * If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see [Amazon Bedrock base model IDs (on-demand throughput)](https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns) in the Amazon Bedrock User Guide. -> * If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see [Supported Regions and models for cross-region inference](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html) in the Amazon Bedrock User Guide. -> * If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see [Run inference using a Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html) in the Amazon Bedrock User Guide. -> * If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see [Use a custom model in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html) in the Amazon Bedrock User Guide. -> * If you use an [imported model](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html) , specify the ARN of the imported model. You can get the model ARN from a successful call to [CreateModelImportJob](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateModelImportJob.html) or from the Imported models page in the Amazon Bedrock console. -> - - -`--guardrail-configuration` (structure) - -> The unique Guardrail configuration assigned to the agent when it is created. -> -> guardrailIdentifier -> (string) -> ->> The unique identifier of the guardrail. -> -> guardrailVersion -> (string) -> ->> The version of the guardrail. - -Shorthand Syntax: - - - guardrailIdentifier=string,guardrailVersion=string - - -JSON Syntax: - - - { - "guardrailIdentifier": "string", - "guardrailVersion": "string" - } - - @@ -230 +198 @@ JSON Syntax: -`--instruction` (string) +`--agent-resource-role-arn` (string) @@ -232 +200 @@ JSON Syntax: -> Instructions that tell the agent what it should do and how it should interact with users. +> The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent. @@ -234 +202 @@ JSON Syntax: -`--memory-configuration` (structure) +`--customer-encryption-key-arn` (string) @@ -236,15 +204,5 @@ JSON Syntax: -> Contains the details of the memory configured for the agent. -> -> enabledMemoryTypes -> (list) -> ->> The type of memory that is stored. ->> ->> (string) -> -> sessionSummaryConfiguration -> (structure) -> ->> Contains the configuration for SESSION_SUMMARY memory type enabled for the agent. ->> ->> maxRecentSessions -> (integer) ->> ->>> Maximum number of recent session summaries to include in the agent’s prompt context. +> The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent. + +`--tags` (map) + +> Any tags that you want to attach to the agent. @@ -252 +210 @@ JSON Syntax: -> storageDays -> (integer) +> key -> (string) @@ -254 +212 @@ JSON Syntax: ->> The number of days the agent is configured to retain the conversational context. +> value -> (string) @@ -259 +217 @@ Shorthand Syntax: - enabledMemoryTypes=string,string,sessionSummaryConfiguration={maxRecentSessions=integer},storageDays=integer + KeyName1=string,KeyName2=string @@ -265,18 +223,2 @@ JSON Syntax: - { - "enabledMemoryTypes": ["SESSION_SUMMARY", ...], - "sessionSummaryConfiguration": { - "maxRecentSessions": integer - }, - "storageDays": integer - } - - -`--orchestration-type` (string) - -> Specifies the type of orchestration strategy for the agent. This is set to `DEFAULT` orchestration type, by default. -> -> Possible values: -> -> * `DEFAULT` -> * `CUSTOM_ORCHESTRATION` -> + {"string": "string" + ...} @@ -289,4 +230,0 @@ JSON Syntax: -> overrideLambda -> (string) -> ->> The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the `promptConfigurations` must contain a `parserMode` value that is set to `OVERRIDDEN` . For more information, see [Parser Lambda function in Amazon Bedrock Agents](https://docs.aws.amazon.com/bedrock/latest/userguide/lambda-parser.html) . -> @@ -301 +239 @@ JSON Syntax: