BedrockAgentCoreControlClient

is in preview release and is subject to change.

Welcome to the Amazon Bedrock AgentCore Control plane API reference. Control plane actions configure, create, modify, and monitor Amazon Web Services resources.

Properties

Link copied to clipboard

BedrockAgentCoreControlClient's configuration

Functions

Link copied to clipboard

Creates an Amazon Bedrock AgentCore Runtime.

Link copied to clipboard

Creates an AgentCore Runtime endpoint.

Link copied to clipboard

Creates a new API key credential provider.

Link copied to clipboard

Creates a custom browser.

Link copied to clipboard

Creates a custom code interpreter.

Link copied to clipboard

Creates a gateway for Amazon Bedrock Agent. A gateway serves as an integration point between your agent and external services.

Link copied to clipboard

Creates a target for a gateway. A target defines an endpoint that the gateway can connect to.

Link copied to clipboard

Creates a new Amazon Bedrock AgentCore Memory resource.

Link copied to clipboard

Creates a new OAuth2 credential provider.

Link copied to clipboard

Creates a new workload identity.

Link copied to clipboard

Deletes an Amazon Bedrock AgentCore Runtime.

Link copied to clipboard

Deletes an AAgentCore Runtime endpoint.

Link copied to clipboard

Deletes an API key credential provider.

Link copied to clipboard

Deletes a custom browser.

Link copied to clipboard

Deletes a custom code interpreter.

Link copied to clipboard

Deletes a gateway.

Link copied to clipboard

Deletes a gateway target.

Link copied to clipboard

Deletes an Amazon Bedrock AgentCore Memory resource.

Link copied to clipboard

Deletes an OAuth2 credential provider.

Link copied to clipboard

Deletes a workload identity.

Link copied to clipboard

Gets an Amazon Bedrock AgentCore Runtime.

Link copied to clipboard

Gets information about an Amazon Secure AgentEndpoint.

Link copied to clipboard

Retrieves information about an API key credential provider.

Link copied to clipboard
abstract suspend fun getBrowser(input: GetBrowserRequest): GetBrowserResponse

Gets information about a custom browser.

Link copied to clipboard

Gets information about a custom code interpreter.

Link copied to clipboard
abstract suspend fun getGateway(input: GetGatewayRequest): GetGatewayResponse

Retrieves information about a specific Gateway.

Link copied to clipboard

Retrieves information about a specific gateway target.

Link copied to clipboard
abstract suspend fun getMemory(input: GetMemoryRequest): GetMemoryResponse

Retrieve an existing Amazon Bedrock AgentCore Memory resource.

Link copied to clipboard

Retrieves information about an OAuth2 credential provider.

Link copied to clipboard
abstract suspend fun getTokenVault(input: GetTokenVaultRequest = GetTokenVaultRequest { }): GetTokenVaultResponse

Retrieves information about a token vault.

Link copied to clipboard

Retrieves information about a workload identity.

Link copied to clipboard

Lists all endpoints for a specific Amazon Secure Agent.

Link copied to clipboard
abstract suspend fun listAgentRuntimes(input: ListAgentRuntimesRequest = ListAgentRuntimesRequest { }): ListAgentRuntimesResponse

Lists all Amazon Secure Agents in your account.

Link copied to clipboard

Lists all versions of a specific Amazon Secure Agent.

Link copied to clipboard
abstract suspend fun listApiKeyCredentialProviders(input: ListApiKeyCredentialProvidersRequest = ListApiKeyCredentialProvidersRequest { }): ListApiKeyCredentialProvidersResponse

Lists all API key credential providers in your account.

Link copied to clipboard
abstract suspend fun listBrowsers(input: ListBrowsersRequest = ListBrowsersRequest { }): ListBrowsersResponse

Lists all custom browsers in your account.

Link copied to clipboard
abstract suspend fun listCodeInterpreters(input: ListCodeInterpretersRequest = ListCodeInterpretersRequest { }): ListCodeInterpretersResponse

Lists all custom code interpreters in your account.

Link copied to clipboard
abstract suspend fun listGateways(input: ListGatewaysRequest = ListGatewaysRequest { }): ListGatewaysResponse

Lists all gateways in the account.

Link copied to clipboard

Lists all targets for a specific gateway.

Link copied to clipboard
abstract suspend fun listMemories(input: ListMemoriesRequest = ListMemoriesRequest { }): ListMemoriesResponse

Lists the available Amazon Bedrock AgentCore Memory resources in the current Amazon Web Services Region.

Link copied to clipboard
abstract suspend fun listOauth2CredentialProviders(input: ListOauth2CredentialProvidersRequest = ListOauth2CredentialProvidersRequest { }): ListOauth2CredentialProvidersResponse

Lists all OAuth2 credential providers in your account.

Link copied to clipboard

Lists the tags associated with the specified resource.

Link copied to clipboard
abstract suspend fun listWorkloadIdentities(input: ListWorkloadIdentitiesRequest = ListWorkloadIdentitiesRequest { }): ListWorkloadIdentitiesResponse

Lists all workload identities in your account.

Link copied to clipboard

Sets the customer master key (CMK) for a token vault.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.

Link copied to clipboard

Removes the specified tags from the specified resource.

Link copied to clipboard

Updates an existing Amazon Secure Agent.

Link copied to clipboard

Updates an existing Amazon Bedrock AgentCore Runtime endpoint.

Link copied to clipboard

Updates an existing API key credential provider.

Link copied to clipboard

Updates an existing gateway.

Link copied to clipboard

Updates an existing gateway target.

Link copied to clipboard

Update an Amazon Bedrock AgentCore Memory resource memory.

Link copied to clipboard

Updates an existing OAuth2 credential provider.

Link copied to clipboard

Updates an existing workload identity.

Inherited functions

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

Creates an Amazon Bedrock AgentCore Runtime.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Creates a custom browser.

Link copied to clipboard

Creates a custom code interpreter.

Link copied to clipboard

Creates a gateway for Amazon Bedrock Agent. A gateway serves as an integration point between your agent and external services.

Link copied to clipboard

Creates a target for a gateway. A target defines an endpoint that the gateway can connect to.

Link copied to clipboard

Creates a new Amazon Bedrock AgentCore Memory resource.

Link copied to clipboard
Link copied to clipboard

Creates a new workload identity.

Link copied to clipboard

Deletes an Amazon Bedrock AgentCore Runtime.

Link copied to clipboard
Link copied to clipboard

Deletes a custom browser.

Link copied to clipboard

Deletes a custom code interpreter.

Link copied to clipboard

Deletes a gateway.

Link copied to clipboard
Link copied to clipboard

Deletes an Amazon Bedrock AgentCore Memory resource.

Link copied to clipboard
Link copied to clipboard

Gets an Amazon Bedrock AgentCore Runtime.

Link copied to clipboard

Gets information about an Amazon Secure AgentEndpoint.

Link copied to clipboard

Retrieves information about an API key credential provider.

Link copied to clipboard

Gets information about a custom browser.

Link copied to clipboard

Gets information about a custom code interpreter.

Link copied to clipboard

Retrieves information about a specific Gateway.

Link copied to clipboard

Retrieves information about a specific gateway target.

Link copied to clipboard

Retrieve an existing Amazon Bedrock AgentCore Memory resource.

Link copied to clipboard

Retrieves information about an OAuth2 credential provider.

Link copied to clipboard

Retrieves information about a token vault.

Link copied to clipboard

Retrieves information about a workload identity.

Link copied to clipboard

Lists all endpoints for a specific Amazon Secure Agent.

Link copied to clipboard

Lists all Amazon Secure Agents in your account.

Link copied to clipboard

Lists all versions of a specific Amazon Secure Agent.

Link copied to clipboard

Lists all API key credential providers in your account.

Link copied to clipboard

Lists all custom browsers in your account.

Link copied to clipboard

Lists all custom code interpreters in your account.

Link copied to clipboard

Lists all gateways in the account.

Link copied to clipboard

Lists all targets for a specific gateway.

Link copied to clipboard

Lists the available Amazon Bedrock AgentCore Memory resources in the current Amazon Web Services Region.

Link copied to clipboard

Lists all OAuth2 credential providers in your account.

Link copied to clipboard

Lists the tags associated with the specified resource.

Link copied to clipboard

Lists all workload identities in your account.

Link copied to clipboard

Sets the customer master key (CMK) for a token vault.

Link copied to clipboard

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.

Link copied to clipboard

Removes the specified tags from the specified resource.

Link copied to clipboard

Updates an existing Amazon Secure Agent.

Link copied to clipboard

Updates an existing Amazon Bedrock AgentCore Runtime endpoint.

Link copied to clipboard

Updates an existing API key credential provider.

Link copied to clipboard

Updates an existing gateway.

Link copied to clipboard

Updates an existing gateway target.

Link copied to clipboard

Update an Amazon Bedrock AgentCore Memory resource memory.

Link copied to clipboard
Link copied to clipboard

Updates an existing workload identity.

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.