AWS cli documentation change
Summary
Updated AWS CLI version reference, reordered parameters, restructured documentation for prompt configuration fields, added cachePoint configurations, and revised encryption key documentation
Security assessment
The change documents the '--customer-encryption-key-arn' parameter for encrypting prompts with KMS, which is a security feature. However, there is no evidence this addresses a specific security vulnerability.
Diff
diff --git a/cli/latest/reference/bedrock-agent/update-prompt.md b/cli/latest/reference/bedrock-agent/update-prompt.md index 9d65f0979..885dc025b 100644 --- a//cli/latest/reference/bedrock-agent/update-prompt.md +++ b//cli/latest/reference/bedrock-agent/update-prompt.md @@ -15 +15 @@ - * [AWS CLI 2.28.8 Command Reference](../../index.html) » + * [AWS CLI 2.28.11 Command Reference](../../index.html) » @@ -68,0 +69,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc + --name <value> + [--description <value>] @@ -71,3 +72,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc - [--description <value>] - --name <value> - --prompt-identifier <value> @@ -74,0 +74 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc + --prompt-identifier <value> @@ -99,5 +99 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc -`--customer-encryption-key-arn` (string) - -> The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt. - -`--default-variant` (string) +`--name` (string) @@ -105 +101 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc -> The name of the default variant for the prompt. This value must match the `name` field in the relevant [PromptVariant](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html) object. +> A name for the prompt. @@ -111 +107 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc -`--name` (string) +`--customer-encryption-key-arn` (string) @@ -113 +109 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc -> A name for the prompt. +> The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt. @@ -115 +111 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc -`--prompt-identifier` (string) +`--default-variant` (string) @@ -117 +113 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc -> The unique identifier of the prompt. +> The name of the default variant for the prompt. This value must match the `name` field in the relevant [PromptVariant](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html) object. @@ -127 +123 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->> additionalModelRequestFields -> (document) +>> name -> (string) @@ -129 +125 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>> Contains model-specific inference configurations that aren’t in the `inferenceConfiguration` field. To see model-specific inference parameters, see [Inference request parameters and response fields for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html) . +>>> The name of the prompt variant. @@ -131 +127 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->> genAiResource -> (tagged union structure) +>> templateType -> (string) @@ -133,13 +129 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>> Specifies a generative AI resource with which to use the prompt. ->>> ->>> ### Note ->>> ->>> This is a Tagged Union structure. Only one of the following top level keys can be set: `agent`. ->>> ->>> agent -> (structure) ->>> ->>>> Specifies an Amazon Bedrock agent with which to use the prompt. ->>>> ->>>> agentIdentifier -> (string) ->>>> ->>>>> The ARN of the agent with which to use the prompt. +>>> The type of prompt template to use. @@ -147 +131 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->> inferenceConfiguration -> (tagged union structure) +>> templateConfiguration -> (tagged union structure) @@ -149 +133 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>> Contains inference configurations for the prompt variant. +>>> Contains configurations for the prompt template. @@ -153 +137 @@ 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: `text`. +>>> This is a Tagged Union structure. Only one of the following top level keys can be set: `text`, `chat`. @@ -157 +141 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>> Contains inference configurations for a text prompt. +>>>> Contains configurations for the text in a message for a prompt. @@ -159 +143 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>> maxTokens -> (integer) +>>>> text -> (string) @@ -161 +145 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>>> The maximum number of tokens to return in the response. +>>>>> The message for the prompt. @@ -163 +147 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>> stopSequences -> (list) +>>>> cachePoint -> (structure) @@ -165 +149 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>>> A list of strings that define sequences after which the model will stop generating. +>>>>> A cache checkpoint within a template configuration. @@ -167,45 +151,3 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>>> (string) ->>>> ->>>> temperature -> (float) ->>>> ->>>>> Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs. ->>>> ->>>> topP -> (float) ->>>> ->>>>> The percentage of most-likely candidates that the model considers for the next token. ->> ->> metadata -> (list) ->> ->>> An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant. ->>> ->>> (structure) ->>> ->>>> Contains a key-value pair that defines a metadata tag and value to attach to a prompt variant. For more information, see [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html) . ->>>> ->>>> key -> (string) ->>>> ->>>>> The key of a metadata tag for a prompt variant. ->>>> ->>>> value -> (string) ->>>> ->>>>> The value of a metadata tag for a prompt variant. ->> ->> modelId -> (string) ->> ->>> The unique identifier of the model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) with which to run inference on the prompt. ->> ->> name -> (string) ->> ->>> The name of the prompt variant. ->> ->> templateConfiguration -> (tagged union structure) ->> ->>> Contains configurations for the prompt template. ->>> ->>> ### Note ->>> ->>> This is a Tagged Union structure. Only one of the following top level keys can be set: `chat`, `text`. ->>> ->>> chat -> (structure) ->>> ->>>> Contains configurations to use the prompt in a conversational format. +>>>>> type -> (string) +>>>>> +>>>>>> Indicates that the CachePointBlock is of the default type @@ -223,0 +166,4 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc +>>> +>>> chat -> (structure) +>>> +>>>> Contains configurations to use the prompt in a conversational format. @@ -232,0 +179,4 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc +>>>>>> role -> (string) +>>>>>> +>>>>>>> The role that the message belongs to. +>>>>>> @@ -243 +193,5 @@ 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: `cachePoint`, `text`. +>>>>>>>> This is a Tagged Union structure. Only one of the following top level keys can be set: `text`, `cachePoint`. +>>>>>>>> +>>>>>>>> text -> (string) +>>>>>>>> +>>>>>>>>> The text in the message. @@ -252,8 +205,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>>>>>> ->>>>>>>> text -> (string) ->>>>>>>> ->>>>>>>>> The text in the message. ->>>>>> ->>>>>> role -> (string) ->>>>>> ->>>>>>> The role that the message belongs to. @@ -271 +217,5 @@ 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: `cachePoint`, `text`. +>>>>>> This is a Tagged Union structure. Only one of the following top level keys can be set: `text`, `cachePoint`. +>>>>>> +>>>>>> text -> (string) +>>>>>> +>>>>>>> The text in the system prompt. @@ -280,4 +229,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>>>> ->>>>>> text -> (string) ->>>>>> ->>>>>>> The text in the system prompt. @@ -285 +231 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>> toolConfiguration -> (structure) +>>>> inputVariables -> (list) @@ -287 +233 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>>> Configuration information for the tools that the model can use when generating a response. +>>>>> An array of the variables in the prompt template. @@ -289 +235 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>>> toolChoice -> (tagged union structure) +>>>>> (structure) @@ -291,13 +237 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>>>> Defines which tools the model should request when invoked. ->>>>>> ->>>>>> ### Note ->>>>>> ->>>>>> This is a Tagged Union structure. Only one of the following top level keys can be set: `any`, `auto`, `tool`. ->>>>>> ->>>>>> any -> (structure) ->>>>>> ->>>>>>> Defines tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response. ->>>>>> ->>>>>> auto -> (structure) ->>>>>> ->>>>>>> Defines tools. The model automatically decides whether to call a tool or to generate text instead. +>>>>>> Contains information about a variable in the prompt. @@ -305 +239 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>>>> tool -> (structure) +>>>>>> name -> (string)