Package-level declarations

Types

Link copied to clipboard

Amazon Bedrock Agents (now Amazon Bedrock Agents Classic) is no longer open to new customers. For capabilities similar to Bedrock Agents Classic, explore Amazon Bedrock AgentCore. Existing customers can continue to use the service as normal. For more information, see Amazon Bedrock Agents Classic availability change.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Inherited functions

Link copied to clipboard

Makes an agent a collaborator for another agent.

Link copied to clipboard

Associates a knowledge base with an agent. If a knowledge base is associated and its indexState is set to Enabled, the agent queries the knowledge base for information to augment its response to the user.

Link copied to clipboard

Amazon Bedrock Agents (now Amazon Bedrock Agents Classic) is no longer open to new customers. For capabilities similar to Bedrock Agents Classic, explore Amazon Bedrock AgentCore. Existing customers can continue to use the service as normal. For more information, see Amazon Bedrock Agents Classic availability change.

Link copied to clipboard

Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them.

Link copied to clipboard

Creates an alias of an agent that can be used to deploy the agent.

Link copied to clipboard

Connects a knowledge base to a data source. You specify the configuration for the specific data source service in the dataSourceConfiguration field.

Link copied to clipboard
inline suspend fun BedrockAgentClient.createFlow(crossinline block: CreateFlowRequest.Builder.() -> Unit): CreateFlowResponse

Creates a prompt flow that you can use to send an input through various steps to yield an output. Configure nodes, each of which corresponds to a step of the flow, and create connections between the nodes to create paths to different outputs. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Link copied to clipboard

Creates an alias of a flow for deployment. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Link copied to clipboard

Creates a version of the flow that you can deploy. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Link copied to clipboard

Creates a knowledge base. A knowledge base contains your data sources so that Large Language Models (LLMs) can use your data. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up a knowledge base.

Link copied to clipboard

Creates a prompt in your prompt library that you can add to a flow. For more information, see Prompt management in Amazon Bedrock, Create a prompt using Prompt management and Prompt flows in Amazon Bedrock in the Amazon Bedrock User Guide.

Link copied to clipboard

Creates a static snapshot of your prompt that can be deployed to production. For more information, see Deploy prompts using Prompt management by creating versions in the Amazon Bedrock User Guide.

Link copied to clipboard

Creates a new retrieval instruction. The retrieval instruction is usable once its status becomes ACTIVE. Use GetRetrievalInstruction to check whether it is ready.

Link copied to clipboard

Creates an immutable numbered version from the retrieval instruction's current reviewed content. The service creates the version synchronously.

Link copied to clipboard

Creates a VPC configuration that lets a knowledge base connect to a resource in your private VPC. This operation is asynchronous: it returns a vpcConfigurationId with status CREATING. Poll GetVpcConfiguration until the status becomes CREATED or CREATE_FAILED.

Link copied to clipboard

Deletes an agent.

Link copied to clipboard

Deletes an action group in an agent.

Link copied to clipboard

Deletes an alias of an agent.

Link copied to clipboard

Deletes a version of an agent.

Link copied to clipboard

Deletes a data source from a knowledge base.

Link copied to clipboard
inline suspend fun BedrockAgentClient.deleteFlow(crossinline block: DeleteFlowRequest.Builder.() -> Unit): DeleteFlowResponse

Deletes a flow.

Link copied to clipboard

Deletes an alias of a flow.

Link copied to clipboard

Deletes a version of a flow.

Link copied to clipboard

Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBase request.

Link copied to clipboard

Deletes documents from a data source and syncs the changes to the knowledge base that is connected to it. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.

Link copied to clipboard

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.

Link copied to clipboard

Removes the resource policy associated with a knowledge base. After deletion, other AWS accounts can no longer access the knowledge base using cross-account permissions.

Link copied to clipboard

Deletes a retrieval instruction or a single version of it. Omit retrievalInstructionVersion to delete the retrieval instruction itself; the service rejects that request with ConflictException while the retrieval instruction has versions or while lastTransitionStatus is CREATING or UPDATING. Specify retrievalInstructionVersion to delete only that version; the retrieval instruction and its other versions are unaffected.

Link copied to clipboard

Deletes a VPC configuration. This operation is asynchronous: it returns status DELETING. Poll GetVpcConfiguration until it returns a ResourceNotFoundException, indicating the configuration is deleted. Delete requests are idempotent and safe to retry.

Link copied to clipboard
Link copied to clipboard

Disassociates a knowledge base from an agent.

Link copied to clipboard
inline suspend fun BedrockAgentClient.getAgent(crossinline block: GetAgentRequest.Builder.() -> Unit): GetAgentResponse

Gets information about an agent.

Link copied to clipboard

Gets information about an action group for an agent.

Link copied to clipboard

Gets information about an alias of an agent.

Link copied to clipboard

Retrieves information about an agent's collaborator.

Link copied to clipboard

Gets information about a knowledge base associated with an agent.

Link copied to clipboard

Gets details about a version of an agent.

Link copied to clipboard

Gets information about a data source.

Link copied to clipboard
inline suspend fun BedrockAgentClient.getFlow(crossinline block: GetFlowRequest.Builder.() -> Unit): GetFlowResponse

Retrieves information about a flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Link copied to clipboard

Retrieves information about a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Link copied to clipboard

Retrieves information about a version of a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Link copied to clipboard

Gets information about a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.

Link copied to clipboard

Gets information about a knowledge base.

Link copied to clipboard

Retrieves specific documents from a data source that is connected to a knowledge base. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.

Link copied to clipboard
inline suspend fun BedrockAgentClient.getPrompt(crossinline block: GetPromptRequest.Builder.() -> Unit): GetPromptResponse

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.

Link copied to clipboard

Retrieves the resource policy associated with a knowledge base.

Link copied to clipboard

Gets a retrieval instruction. Also used to poll the terminal reporting of an asynchronous create or update.

Link copied to clipboard

Returns the details and current status of a single VPC configuration. Use this operation to poll for the outcome of an asynchronous create or delete.

Link copied to clipboard

Ingests documents directly into the knowledge base that is connected to the data source. The dataSourceType specified in the content for each document must match the type of the data source that you specify in the header. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.

Link copied to clipboard

Lists the action groups for an agent and information about each one.

Link copied to clipboard

Lists the aliases of an agent and information about each one.

Link copied to clipboard

Retrieve a list of an agent's collaborators.

Link copied to clipboard

Lists knowledge bases associated with an agent and information about each one.

Link copied to clipboard
inline suspend fun BedrockAgentClient.listAgents(crossinline block: ListAgentsRequest.Builder.() -> Unit): ListAgentsResponse

Lists the agents belonging to an account and information about each agent.

Link copied to clipboard

Lists the versions of an agent and information about each version.

Link copied to clipboard

Lists the data sources in a knowledge base and information about each one.

Link copied to clipboard

Returns a list of aliases for a flow.

Link copied to clipboard
inline suspend fun BedrockAgentClient.listFlows(crossinline block: ListFlowsRequest.Builder.() -> Unit): ListFlowsResponse

Returns a list of flows and information about each flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Link copied to clipboard

Returns a list of information about each flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Link copied to clipboard

Lists the data ingestion jobs for a data source. The list also includes information about each job.

Link copied to clipboard

Retrieves all the documents contained in a data source that is connected to a knowledge base. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.

Link copied to clipboard

Lists the knowledge bases in an account. The list also includesinformation about each knowledge base.

Link copied to clipboard

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.

Link copied to clipboard

Lists the retrieval instructions in the caller's account. Results are paginated. Use the nextToken parameter to retrieve additional results.

Link copied to clipboard

Lists the numbered versions of a retrieval instruction, newest first. DRAFT is not listed; read it with GetRetrievalInstruction without retrievalInstructionVersion. Results are paginated. Use the nextToken parameter to retrieve additional results.

Link copied to clipboard

List all the tags for the resource you specify.

Link copied to clipboard

Returns a paginated list of the VPC configurations for a knowledge base. You can optionally filter by status. Use the nextToken parameter to retrieve additional results.

Link copied to clipboard

Creates a DRAFT version of the agent that can be used for internal testing.

Link copied to clipboard

Prepares the DRAFT version of a flow so that it can be invoked. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Link copied to clipboard

Associates a resource policy with a knowledge base. A resource policy allows other AWS accounts to access the knowledge base. For more information, see Cross-account access for knowledge bases.

Link copied to clipboard

Begins a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.

Link copied to clipboard

Stops a currently running data ingestion job. You can send a StartIngestionJob request again to ingest the rest of your data when you are ready.

Link copied to clipboard

Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

Link copied to clipboard

Remove tags from a resource.

Link copied to clipboard

Updates the configuration of an agent.

Link copied to clipboard

Updates the configuration for an action group for an agent.

Link copied to clipboard

Updates configurations for an alias of an agent.

Link copied to clipboard

Updates an agent's collaborator.

Link copied to clipboard

Updates the configuration for a knowledge base that has been associated with an agent.

Link copied to clipboard

Updates the configurations for a data source connector.

Link copied to clipboard
inline suspend fun BedrockAgentClient.updateFlow(crossinline block: UpdateFlowRequest.Builder.() -> Unit): UpdateFlowResponse

Modifies a flow. Include both fields that you want to keep and fields that you want to change. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Link copied to clipboard

Modifies the alias of a flow. Include both fields that you want to keep and ones that you want to change. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Link copied to clipboard

Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same.

Link copied to clipboard

Modifies a prompt in your prompt library. Include both fields that you want to keep and fields that you want to replace. For more information, see Prompt management in Amazon Bedrock and Edit prompts in your prompt library in the Amazon Bedrock User Guide.

Link copied to clipboard

Updates the content of a retrieval instruction. The update is processed asynchronously; the stored content is a candidate until content review passes, and the served content does not change while the update is in flight. The service rejects the request with ConflictException while lastTransitionStatus is CREATING or UPDATING.

Link copied to clipboard

Validates the definition of a flow.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.