Deletes a prompt or a prompt version from the Prompt management tool. For more information, see Delete prompts from the Prompt management tool and Delete a version of a prompt from the Prompt management tool in the Amazon Bedrock User Guide.
+ *Deletes a prompt or a version of it, depending on whether you include the promptVersion field or not. For more information, see Delete prompts from the Prompt management tool and Delete a version of a prompt from the Prompt management tool in the Amazon Bedrock User Guide.
Retrieves information about a prompt or a version of it. For more information, see View information about prompts using Prompt management and View information about a version of your prompt in the Amazon Bedrock User Guide.
+ *Retrieves information about the working draft (DRAFT version) of a prompt or a version of it, depending on whether you include the promptVersion field or not. For more information, see View information about prompts using Prompt management and View information about a version of your prompt in the Amazon Bedrock User Guide.
Returns a list of prompts from the Prompt management tool and information about each prompt. For more information, see View information about prompts using Prompt management in the Amazon Bedrock User Guide.
+ *Returns either information about the working draft (DRAFT version) of each prompt in an account, or information about of all versions of a prompt, depending on whether you include the promptIdentifier field or not. For more information, see View information about prompts using Prompt management in the Amazon Bedrock User Guide.
Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.
*This data type is used in the following API operations:
@@ -314,6 +328,12 @@ export interface Function { * @public */ parameters?: RecordContains information if user confirmation is required to invoke the function.
+ * @public + */ + requireConfirmation?: RequireConfirmation; } /** @@ -2487,7 +2507,7 @@ export interface ConfluenceSourceConfiguration { /** *The Amazon Resource Name of an Secrets Manager secret that - * stores your authentication credentials for your SharePoint site/sites. + * stores your authentication credentials for your Confluence instance URL. * For more information on the key-value pairs that must be included in * your secret, depending on your authentication type, see * Confluence connection configuration.
@@ -2588,7 +2608,7 @@ export interface SalesforceSourceConfiguration { /** *The Amazon Resource Name of an Secrets Manager secret that - * stores your authentication credentials for your SharePoint site/sites. + * stores your authentication credentials for your Salesforce instance URL. * For more information on the key-value pairs that must be included in * your secret, depending on your authentication type, see * Salesforce connection configuration.
@@ -3342,14 +3362,16 @@ export interface CreateDataSourceRequest { *You can set the data deletion policy to:
*DELETE: Deletes all underlying data belonging to - * the data source from the vector store upon deletion of a knowledge base or data - * source resource. Note that the vector store itself is not deleted, only the - * underlying data. This flag is ignored if an Amazon Web Services account is deleted.
+ *DELETE: Deletes all data from your data source that’s converted + * into vector embeddings upon deletion of a knowledge base or data source resource. + * Note that the vector store itself is not deleted, + * only the data. This flag is ignored if an Amazon Web Services account is deleted.
*RETAIN: Retains all underlying data in your - * vector store upon deletion of a knowledge base or data source resource.
+ *RETAIN: Retains all data from your data source that’s converted + * into vector embeddings upon deletion of a knowledge base or data source resource. + * Note that the vector store itself is not deleted + * if you delete a knowledge base or data source resource.
*The name of the flow alias.
+ *The name of the alias.
* @public */ name: string | undefined; @@ -5150,7 +5172,7 @@ export interface GetFlowAliasResponse { createdAt: Date | undefined; /** - *The time at which the flow alias was last updated.
+ *The time at which the alias was last updated.
* @public */ updatedAt: Date | undefined; @@ -5223,7 +5245,7 @@ export interface FlowAliasSummary { id: string | undefined; /** - *The Amazon Resource Name (ARN) of the flow alias.
+ *The Amazon Resource Name (ARN) of the alias.
* @public */ arn: string | undefined; @@ -5246,7 +5268,7 @@ export interface FlowAliasSummary { */ export interface ListFlowAliasesResponse { /** - *A list, each member of which contains information about a flow alias.
+ *A list, each member of which contains information about an alias.
* @public */ flowAliasSummaries: FlowAliasSummary[] | undefined; @@ -5263,13 +5285,13 @@ export interface ListFlowAliasesResponse { */ export interface UpdateFlowAliasRequest { /** - *The name of the flow alias.
+ *The name of the alias.
* @public */ name: string | undefined; /** - *A description for the flow alias.
+ *A description for the alias.
* @public */ description?: string; @@ -5298,7 +5320,7 @@ export interface UpdateFlowAliasRequest { */ export interface UpdateFlowAliasResponse { /** - *The name of the flow alias.
+ *The name of the alias.
* @public */ name: string | undefined; @@ -5340,7 +5362,7 @@ export interface UpdateFlowAliasResponse { createdAt: Date | undefined; /** - *The time at which the flow alias was last updated.
+ *The time at which the alias was last updated.
* @public */ updatedAt: Date | undefined; @@ -5375,13 +5397,13 @@ export interface CreateFlowVersionRequest { */ export interface CreateFlowVersionResponse { /** - *The name of the flow version.
+ *The name of the version.
* @public */ name: string | undefined; /** - *The description of the flow version.
+ *The description of the version.
* @public */ description?: string; @@ -5497,7 +5519,7 @@ export interface GetFlowVersionRequest { */ export interface GetFlowVersionResponse { /** - *The name of the flow version.
+ *The name of the version.
* @public */ name: string | undefined; @@ -5581,7 +5603,7 @@ export interface ListFlowVersionsRequest { } /** - *Contains information about the flow version.
+ *Contains information about a version of a flow.
*This data type is used in the following API operations:
*The time at the flow version was created.
+ *The time at the version was created.
* @public */ createdAt: Date | undefined; @@ -7599,13 +7621,13 @@ export interface CreatePromptVersionRequest { */ export interface CreatePromptVersionResponse { /** - *The name of the prompt version.
+ *The name of the prompt.
* @public */ name: string | undefined; /** - *A description for the prompt version.
+ *A description for the version.
* @public */ description?: string; @@ -7670,7 +7692,7 @@ export interface DeletePromptRequest { promptIdentifier: string | undefined; /** - *The version of the prompt to delete.
+ *The version of the prompt to delete. To delete the prompt, omit this field.
* @public */ promptVersion?: string; @@ -7704,7 +7726,7 @@ export interface GetPromptRequest { promptIdentifier: string | undefined; /** - *The version of the prompt about which you want to retrieve information.
+ *The version of the prompt about which you want to retrieve information. Omit this field to return information about the working draft of the prompt.
* @public */ promptVersion?: string; @@ -7751,7 +7773,7 @@ export interface GetPromptResponse { id: string | undefined; /** - *The Amazon Resource Name (ARN) of the prompt.
+ *The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).
* @public */ arn: string | undefined; @@ -7780,7 +7802,7 @@ export interface GetPromptResponse { */ export interface ListPromptsRequest { /** - *The unique identifier of the prompt.
+ *The unique identifier of the prompt for whose versions you want to return information. Omit this field to list information about all prompts in an account.
* @public */ promptIdentifier?: string; @@ -7830,7 +7852,7 @@ export interface PromptSummary { id: string | undefined; /** - *The Amazon Resource Name (ARN) of the prompt.
+ *The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).
* @public */ arn: string | undefined; diff --git a/codegen/sdk-codegen/aws-models/bedrock-agent.json b/codegen/sdk-codegen/aws-models/bedrock-agent.json index 37ad75eb7adf9..1b92d71a7fc69 100644 --- a/codegen/sdk-codegen/aws-models/bedrock-agent.json +++ b/codegen/sdk-codegen/aws-models/bedrock-agent.json @@ -2263,7 +2263,7 @@ "credentialsSecretArn": { "target": "com.amazonaws.bedrockagent#SecretArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name of an Secrets Manager secret that \n stores your authentication credentials for your SharePoint site/sites. \n For more information on the key-value pairs that must be included in \n your secret, depending on your authentication type, see \n Confluence connection configuration.
", + "smithy.api#documentation": "The Amazon Resource Name of an Secrets Manager secret that \n stores your authentication credentials for your Confluence instance URL. \n For more information on the key-value pairs that must be included in \n your secret, depending on your authentication type, see \n Confluence connection configuration.
", "smithy.api#required": {} } } @@ -2759,7 +2759,7 @@ "dataDeletionPolicy": { "target": "com.amazonaws.bedrockagent#DataDeletionPolicy", "traits": { - "smithy.api#documentation": "The data deletion policy for the data source.
\nYou can set the data deletion policy to:
\nDELETE: Deletes all underlying data belonging to \n the data source from the vector store upon deletion of a knowledge base or data \n source resource. Note that the vector store itself is not deleted, only the \n underlying data. This flag is ignored if an Amazon Web Services account is deleted.
\nRETAIN: Retains all underlying data in your \n vector store upon deletion of a knowledge base or data source resource.
\nThe data deletion policy for the data source.
\nYou can set the data deletion policy to:
\nDELETE: Deletes all data from your data source that’s converted \n into vector embeddings upon deletion of a knowledge base or data source resource. \n Note that the vector store itself is not deleted, \n only the data. This flag is ignored if an Amazon Web Services account is deleted.
\nRETAIN: Retains all data from your data source that’s converted \n into vector embeddings upon deletion of a knowledge base or data source resource. \n Note that the vector store itself is not deleted \n if you delete a knowledge base or data source resource.
\nThe name of the flow version.
", + "smithy.api#documentation": "The name of the version.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.bedrockagent#FlowDescription", "traits": { - "smithy.api#documentation": "The description of the flow version.
" + "smithy.api#documentation": "The description of the version.
" } }, "executionRoleArn": { @@ -3629,14 +3629,14 @@ "name": { "target": "com.amazonaws.bedrockagent#PromptName", "traits": { - "smithy.api#documentation": "The name of the prompt version.
", + "smithy.api#documentation": "The name of the prompt.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.bedrockagent#PromptDescription", "traits": { - "smithy.api#documentation": "A description for the prompt version.
" + "smithy.api#documentation": "A description for the version.
" } }, "customerEncryptionKeyArn": { @@ -4849,7 +4849,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a prompt or a prompt version from the Prompt management tool. For more information, see Delete prompts from the Prompt management tool and Delete a version of a prompt from the Prompt management tool in the Amazon Bedrock User Guide.
", + "smithy.api#documentation": "Deletes a prompt or a version of it, depending on whether you include the promptVersion field or not. For more information, see Delete prompts from the Prompt management tool and Delete a version of a prompt from the Prompt management tool in the Amazon Bedrock User Guide.
The version of the prompt to delete.
", + "smithy.api#documentation": "The version of the prompt to delete. To delete the prompt, omit this field.
", "smithy.api#httpQuery": "promptVersion" } } @@ -5254,7 +5254,7 @@ "arn": { "target": "com.amazonaws.bedrockagent#FlowAliasArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow alias.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alias.
", "smithy.api#required": {} } }, @@ -6128,7 +6128,7 @@ "createdAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { - "smithy.api#documentation": "The time at the flow version was created.
", + "smithy.api#documentation": "The time at the version was created.
", "smithy.api#required": {} } }, @@ -6141,7 +6141,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains information about the flow version.
\nThis data type is used in the following API operations:
\nContains information about a version of a flow.
\nThis data type is used in the following API operations:
\nThe parameters that the agent elicits from the user to fulfill the function.
" } + }, + "requireConfirmation": { + "target": "com.amazonaws.bedrockagent#RequireConfirmation", + "traits": { + "smithy.api#documentation": "Contains information if user confirmation is required to invoke the function.
" + } } }, "traits": { @@ -6760,7 +6766,7 @@ "name": { "target": "com.amazonaws.bedrockagent#Name", "traits": { - "smithy.api#documentation": "The name of the flow alias.
", + "smithy.api#documentation": "The name of the alias.
", "smithy.api#required": {} } }, @@ -6808,7 +6814,7 @@ "updatedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { - "smithy.api#documentation": "The time at which the flow alias was last updated.
", + "smithy.api#documentation": "The time at which the alias was last updated.
", "smithy.api#required": {} } } @@ -6987,7 +6993,7 @@ "name": { "target": "com.amazonaws.bedrockagent#FlowName", "traits": { - "smithy.api#documentation": "The name of the flow version.
", + "smithy.api#documentation": "The name of the version.
", "smithy.api#required": {} } }, @@ -7232,7 +7238,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves information about a prompt or a version of it. For more information, see View information about prompts using Prompt management and View information about a version of your prompt in the Amazon Bedrock User Guide.
", + "smithy.api#documentation": "Retrieves information about the working draft (DRAFT version) of a prompt or a version of it, depending on whether you include the promptVersion field or not. For more information, see View information about prompts using Prompt management and View information about a version of your prompt in the Amazon Bedrock User Guide.
The version of the prompt about which you want to retrieve information.
", + "smithy.api#documentation": "The version of the prompt about which you want to retrieve information. Omit this field to return information about the working draft of the prompt.
", "smithy.api#httpQuery": "promptVersion" } } @@ -7309,7 +7315,7 @@ "arn": { "target": "com.amazonaws.bedrockagent#PromptArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).
", "smithy.api#required": {} } }, @@ -8934,7 +8940,7 @@ "flowAliasSummaries": { "target": "com.amazonaws.bedrockagent#FlowAliasSummaries", "traits": { - "smithy.api#documentation": "A list, each member of which contains information about a flow alias.
", + "smithy.api#documentation": "A list, each member of which contains information about an alias.
", "smithy.api#required": {} } }, @@ -9341,7 +9347,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of prompts from the Prompt management tool and information about each prompt. For more information, see View information about prompts using Prompt management in the Amazon Bedrock User Guide.
", + "smithy.api#documentation": "Returns either information about the working draft (DRAFT version) of each prompt in an account, or information about of all versions of a prompt, depending on whether you include the promptIdentifier field or not. For more information, see View information about prompts using Prompt management in the Amazon Bedrock User Guide.
The unique identifier of the prompt.
", + "smithy.api#documentation": "The unique identifier of the prompt for whose versions you want to return information. Omit this field to list information about all prompts in an account.
", "smithy.api#httpQuery": "promptIdentifier" } }, @@ -10570,7 +10576,7 @@ "arn": { "target": "com.amazonaws.bedrockagent#PromptArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).
", "smithy.api#required": {} } }, @@ -10928,6 +10934,26 @@ "smithy.api#pattern": "^.*$" } }, + "com.amazonaws.bedrockagent#RequireConfirmation": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + }, + "traits": { + "smithy.api#documentation": "ENUM to check if action requires user confirmation" + } + }, "com.amazonaws.bedrockagent#ResourceNotFoundException": { "type": "structure", "members": { @@ -11175,7 +11201,7 @@ "credentialsSecretArn": { "target": "com.amazonaws.bedrockagent#SecretArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name of an Secrets Manager secret that \n stores your authentication credentials for your SharePoint site/sites. \n For more information on the key-value pairs that must be included in \n your secret, depending on your authentication type, see \n Salesforce connection configuration.
", + "smithy.api#documentation": "The Amazon Resource Name of an Secrets Manager secret that \n stores your authentication credentials for your Salesforce instance URL. \n For more information on the key-value pairs that must be included in \n your secret, depending on your authentication type, see \n Salesforce connection configuration.
", "smithy.api#required": {} } } @@ -12694,14 +12720,14 @@ "name": { "target": "com.amazonaws.bedrockagent#Name", "traits": { - "smithy.api#documentation": "The name of the flow alias.
", + "smithy.api#documentation": "The name of the alias.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.bedrockagent#Description", "traits": { - "smithy.api#documentation": "A description for the flow alias.
" + "smithy.api#documentation": "A description for the alias.
" } }, "routingConfiguration": { @@ -12738,7 +12764,7 @@ "name": { "target": "com.amazonaws.bedrockagent#Name", "traits": { - "smithy.api#documentation": "The name of the flow alias.
", + "smithy.api#documentation": "The name of the alias.
", "smithy.api#required": {} } }, @@ -12786,7 +12812,7 @@ "updatedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { - "smithy.api#documentation": "The time at which the flow alias was last updated.
", + "smithy.api#documentation": "The time at which the alias was last updated.
", "smithy.api#required": {} } }