feat(client-bedrock-agent): This release adds support for using Guardrails with Bedrock Agents.

Author: awstools

clients/client-bedrock-agent/src/commands/CreateAgentCommand.ts

@@ -95,6 +95,10 @@ export interface CreateAgentCommandOutput extends CreateAgentResponse, __Metadat
  *     ],
  *     overrideLambda: "STRING_VALUE",
  *   },
+ *   guardrailConfiguration: { // GuardrailConfiguration
+ *     guardrailIdentifier: "STRING_VALUE",
+ *     guardrailVersion: "STRING_VALUE",
+ *   },
  * };
  * const command = new CreateAgentCommand(input);
  * const response = await client.send(command);
@@ -142,6 +146,10 @@ export interface CreateAgentCommandOutput extends CreateAgentResponse, __Metadat
  * //       ],
  * //       overrideLambda: "STRING_VALUE",
  * //     },
+ * //     guardrailConfiguration: { // GuardrailConfiguration
+ * //       guardrailIdentifier: "STRING_VALUE",
+ * //       guardrailVersion: "STRING_VALUE",
+ * //     },
  * //   },
  * // };
  *

clients/client-bedrock-agent/src/commands/GetAgentCommand.ts

@@ -83,6 +83,10 @@ export interface GetAgentCommandOutput extends GetAgentResponse, __MetadataBeare
  * //       ],
  * //       overrideLambda: "STRING_VALUE",
  * //     },
+ * //     guardrailConfiguration: { // GuardrailConfiguration
+ * //       guardrailIdentifier: "STRING_VALUE",
+ * //       guardrailVersion: "STRING_VALUE",
+ * //     },
  * //   },
  * // };
  *

clients/client-bedrock-agent/src/commands/GetAgentVersionCommand.ts

@@ -86,6 +86,10 @@ export interface GetAgentVersionCommandOutput extends GetAgentVersionResponse, _
  * //       ],
  * //       overrideLambda: "STRING_VALUE",
  * //     },
+ * //     guardrailConfiguration: { // GuardrailConfiguration
+ * //       guardrailIdentifier: "STRING_VALUE",
+ * //       guardrailVersion: "STRING_VALUE",
+ * //     },
  * //   },
  * // };
  *

clients/client-bedrock-agent/src/commands/ListAgentVersionsCommand.ts

@@ -50,6 +50,10 @@ export interface ListAgentVersionsCommandOutput extends ListAgentVersionsRespons
  * //       createdAt: new Date("TIMESTAMP"), // required
  * //       updatedAt: new Date("TIMESTAMP"), // required
  * //       description: "STRING_VALUE",
+ * //       guardrailConfiguration: { // GuardrailConfiguration
+ * //         guardrailIdentifier: "STRING_VALUE",
+ * //         guardrailVersion: "STRING_VALUE",
+ * //       },
  * //     },
  * //   ],
  * //   nextToken: "STRING_VALUE",

clients/client-bedrock-agent/src/commands/ListAgentsCommand.ts

@@ -49,6 +49,10 @@ export interface ListAgentsCommandOutput extends ListAgentsResponse, __MetadataB
  * //       description: "STRING_VALUE",
  * //       updatedAt: new Date("TIMESTAMP"), // required
  * //       latestAgentVersion: "STRING_VALUE",
+ * //       guardrailConfiguration: { // GuardrailConfiguration
+ * //         guardrailIdentifier: "STRING_VALUE",
+ * //         guardrailVersion: "STRING_VALUE",
+ * //       },
  * //     },
  * //   ],
  * //   nextToken: "STRING_VALUE",

clients/client-bedrock-agent/src/commands/UpdateAgentCommand.ts

@@ -69,6 +69,10 @@ export interface UpdateAgentCommandOutput extends UpdateAgentResponse, __Metadat
  *     ],
  *     overrideLambda: "STRING_VALUE",
  *   },
+ *   guardrailConfiguration: { // GuardrailConfiguration
+ *     guardrailIdentifier: "STRING_VALUE",
+ *     guardrailVersion: "STRING_VALUE",
+ *   },
  * };
  * const command = new UpdateAgentCommand(input);
  * const response = await client.send(command);
@@ -116,6 +120,10 @@ export interface UpdateAgentCommandOutput extends UpdateAgentResponse, __Metadat
  * //       ],
  * //       overrideLambda: "STRING_VALUE",
  * //     },
+ * //     guardrailConfiguration: { // GuardrailConfiguration
+ * //       guardrailIdentifier: "STRING_VALUE",
+ * //       guardrailVersion: "STRING_VALUE",
+ * //     },
  * //   },
  * // };
  *

clients/client-bedrock-agent/src/models/models_0.ts

@@ -933,6 +933,24 @@ export const AgentStatus = {
  */
 export type AgentStatus = (typeof AgentStatus)[keyof typeof AgentStatus];
 
+/**
+ * <p>The details of the guardrails configuration.</p>
+ * @public
+ */
+export interface GuardrailConfiguration {
+  /**
+   * <p>The guardrails identifier assigned to the guardrails configuration.</p>
+   * @public
+   */
+  guardrailIdentifier?: string;
+
+  /**
+   * <p>The guardrails version assigned to the guardrails configuration.</p>
+   * @public
+   */
+  guardrailVersion?: string;
+}
+
 /**
  * <p>Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the <code>promptType</code>. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>.</p>
  * @public
@@ -1059,7 +1077,7 @@ export interface PromptConfiguration {
   promptState?: PromptState;
 
   /**
-   * <p>Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html">Prompt template placeholder variables</a>.</p>
+   * <p>Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html">Prompt template placeholder variables</a>. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts-configure.html">Configure the prompt templates</a>.</p>
    * @public
    */
   basePromptTemplate?: string;
@@ -1089,7 +1107,7 @@ export interface PromptOverrideConfiguration {
   promptConfigurations: PromptConfiguration[] | undefined;
 
   /**
-   * <p>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 <code>promptConfigurations</code> must contain a <code>parserMode</code> value that is set to <code>OVERRIDDEN</code>.</p>
+   * <p>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 <code>promptConfigurations</code> must contain a <code>parserMode</code> value that is set to <code>OVERRIDDEN</code>. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/lambda-parser.html">Parser Lambda function in Agents for Amazon Bedrock</a>.</p>
    * @public
    */
   overrideLambda?: string;
@@ -1232,6 +1250,12 @@ export interface Agent {
    * @public
    */
   promptOverrideConfiguration?: PromptOverrideConfiguration;
+
+  /**
+   * <p>The guardrails configuration assigned to the agent.</p>
+   * @public
+   */
+  guardrailConfiguration?: GuardrailConfiguration;
 }
 
 /**
@@ -1594,6 +1618,12 @@ export interface CreateAgentRequest {
    * @public
    */
   promptOverrideConfiguration?: PromptOverrideConfiguration;
+
+  /**
+   * <p>The unique Guardrail configuration assigned to the agent when it is created.</p>
+   * @public
+   */
+  guardrailConfiguration?: GuardrailConfiguration;
 }
 
 /**
@@ -1720,6 +1750,12 @@ export interface AgentSummary {
    * @public
    */
   latestAgentVersion?: string;
+
+  /**
+   * <p>The details of the guardrails configuration in the agent summary.</p>
+   * @public
+   */
+  guardrailConfiguration?: GuardrailConfiguration;
 }
 
 /**
@@ -1837,6 +1873,12 @@ export interface UpdateAgentRequest {
    * @public
    */
   promptOverrideConfiguration?: PromptOverrideConfiguration;
+
+  /**
+   * <p>The unique Guardrail configuration assigned to the agent when it is updated.</p>
+   * @public
+   */
+  guardrailConfiguration?: GuardrailConfiguration;
 }
 
 /**
@@ -1951,6 +1993,12 @@ export interface AgentVersion {
    * @public
    */
   promptOverrideConfiguration?: PromptOverrideConfiguration;
+
+  /**
+   * <p>The guardrails configuration assigned to the agent version.</p>
+   * @public
+   */
+  guardrailConfiguration?: GuardrailConfiguration;
 }
 
 /**
@@ -1993,6 +2041,12 @@ export interface AgentVersionSummary {
    * @public
    */
   description?: string;
+
+  /**
+   * <p>The details of the guardrails configuration in the agent version summary.</p>
+   * @public
+   */
+  guardrailConfiguration?: GuardrailConfiguration;
 }
 
 /**

clients/client-bedrock-agent/src/protocols/Aws_restJson1.ts

@@ -138,6 +138,7 @@ import {
   FixedSizeChunkingConfiguration,
   Function,
   FunctionSchema,
+  GuardrailConfiguration,
   InferenceConfiguration,
   IngestionJob,
   IngestionJobFilter,
@@ -219,6 +220,7 @@ export const se_CreateAgentCommand = async (
       customerEncryptionKeyArn: [],
       description: [],
       foundationModel: [],
+      guardrailConfiguration: (_) => _json(_),
       idleSessionTTLInSeconds: [],
       instruction: [],
       promptOverrideConfiguration: (_) => se_PromptOverrideConfiguration(_, context),
@@ -927,6 +929,7 @@ export const se_UpdateAgentCommand = async (
       customerEncryptionKeyArn: [],
       description: [],
       foundationModel: [],
+      guardrailConfiguration: (_) => _json(_),
       idleSessionTTLInSeconds: [],
       instruction: [],
       promptOverrideConfiguration: (_) => se_PromptOverrideConfiguration(_, context),
@@ -2112,6 +2115,8 @@ const de_ValidationExceptionRes = async (parsedOutput: any, context: __SerdeCont
 
 // se_FunctionSchema omitted.
 
+// se_GuardrailConfiguration omitted.
+
 /**
  * serializeAws_restJson1InferenceConfiguration
  */
@@ -2256,6 +2261,7 @@ const de_Agent = (output: any, context: __SerdeContext): Agent => {
     description: __expectString,
     failureReasons: _json,
     foundationModel: __expectString,
+    guardrailConfiguration: _json,
     idleSessionTTLInSeconds: __expectInt32,
     instruction: __expectString,
     preparedAt: (_: any) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)),
@@ -2420,6 +2426,7 @@ const de_AgentSummary = (output: any, context: __SerdeContext): AgentSummary =>
     agentName: __expectString,
     agentStatus: __expectString,
     description: __expectString,
+    guardrailConfiguration: _json,
     latestAgentVersion: __expectString,
     updatedAt: (_: any) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)),
   }) as any;
@@ -2440,6 +2447,7 @@ const de_AgentVersion = (output: any, context: __SerdeContext): AgentVersion =>
     description: __expectString,
     failureReasons: _json,
     foundationModel: __expectString,
+    guardrailConfiguration: _json,
     idleSessionTTLInSeconds: __expectInt32,
     instruction: __expectString,
     promptOverrideConfiguration: (_: any) => de_PromptOverrideConfiguration(_, context),
@@ -2471,6 +2479,7 @@ const de_AgentVersionSummary = (output: any, context: __SerdeContext): AgentVers
     agentVersion: __expectString,
     createdAt: (_: any) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)),
     description: __expectString,
+    guardrailConfiguration: _json,
     updatedAt: (_: any) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)),
   }) as any;
 };
@@ -2537,6 +2546,8 @@ const de_DataSourceSummary = (output: any, context: __SerdeContext): DataSourceS
 
 // de_FunctionSchema omitted.
 
+// de_GuardrailConfiguration omitted.
+
 /**
  * deserializeAws_restJson1InferenceConfiguration
  */