Interface BedrockAgentCoreClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface BedrockAgentCoreClient
extends AwsClient

Service client for accessing Amazon Bedrock AgentCore Data Plane Fronting Layer. This can be created using the static builder() method.

Amazon Bedrock AgentCore is in preview release and is subject to change.

Welcome to the Amazon Bedrock AgentCore Data Plane API reference. Data Plane actions process and handle data or workloads within Amazon Web Services services.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static BedrockAgentCoreClientBuilder	builder()	Create a builder that can be used to configure and create a BedrockAgentCoreClient.
static BedrockAgentCoreClient	create()	Create a BedrockAgentCoreClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateEventResponse	createEvent(Consumer<CreateEventRequest.Builder> createEventRequest)	Creates an event in an AgentCore Memory resource.
default CreateEventResponse	createEvent(CreateEventRequest createEventRequest)	Creates an event in an AgentCore Memory resource.
default DeleteEventResponse	deleteEvent(Consumer<DeleteEventRequest.Builder> deleteEventRequest)	Deletes an event from an AgentCore Memory resource.
default DeleteEventResponse	deleteEvent(DeleteEventRequest deleteEventRequest)	Deletes an event from an AgentCore Memory resource.
default DeleteMemoryRecordResponse	deleteMemoryRecord(Consumer<DeleteMemoryRecordRequest.Builder> deleteMemoryRecordRequest)	Deletes a memory record from an AgentCore Memory resource.
default DeleteMemoryRecordResponse	deleteMemoryRecord(DeleteMemoryRecordRequest deleteMemoryRecordRequest)	Deletes a memory record from an AgentCore Memory resource.
default GetBrowserSessionResponse	getBrowserSession(Consumer<GetBrowserSessionRequest.Builder> getBrowserSessionRequest)	Retrieves detailed information about a specific browser session in Amazon Bedrock.
default GetBrowserSessionResponse	getBrowserSession(GetBrowserSessionRequest getBrowserSessionRequest)	Retrieves detailed information about a specific browser session in Amazon Bedrock.
default GetCodeInterpreterSessionResponse	getCodeInterpreterSession(Consumer<GetCodeInterpreterSessionRequest.Builder> getCodeInterpreterSessionRequest)	Retrieves detailed information about a specific code interpreter session in Amazon Bedrock.
default GetCodeInterpreterSessionResponse	getCodeInterpreterSession(GetCodeInterpreterSessionRequest getCodeInterpreterSessionRequest)	Retrieves detailed information about a specific code interpreter session in Amazon Bedrock.
default GetEventResponse	getEvent(Consumer<GetEventRequest.Builder> getEventRequest)	Retrieves information about a specific event in an AgentCore Memory resource.
default GetEventResponse	getEvent(GetEventRequest getEventRequest)	Retrieves information about a specific event in an AgentCore Memory resource.
default GetMemoryRecordResponse	getMemoryRecord(Consumer<GetMemoryRecordRequest.Builder> getMemoryRecordRequest)	Retrieves a specific memory record from an AgentCore Memory resource.
default GetMemoryRecordResponse	getMemoryRecord(GetMemoryRecordRequest getMemoryRecordRequest)	Retrieves a specific memory record from an AgentCore Memory resource.
default GetResourceApiKeyResponse	getResourceApiKey(Consumer<GetResourceApiKeyRequest.Builder> getResourceApiKeyRequest)	Retrieves an API Key associated with an API Key Credential Provider
default GetResourceApiKeyResponse	getResourceApiKey(GetResourceApiKeyRequest getResourceApiKeyRequest)	Retrieves an API Key associated with an API Key Credential Provider
default GetResourceOauth2TokenResponse	getResourceOauth2Token(Consumer<GetResourceOauth2TokenRequest.Builder> getResourceOauth2TokenRequest)	Returns the OAuth 2.0 token of the provided resource
default GetResourceOauth2TokenResponse	getResourceOauth2Token(GetResourceOauth2TokenRequest getResourceOauth2TokenRequest)	Returns the OAuth 2.0 token of the provided resource
default GetWorkloadAccessTokenResponse	getWorkloadAccessToken(Consumer<GetWorkloadAccessTokenRequest.Builder> getWorkloadAccessTokenRequest)	Obtains an Workload access token for agentic workloads not acting on behalf of user.
default GetWorkloadAccessTokenResponse	getWorkloadAccessToken(GetWorkloadAccessTokenRequest getWorkloadAccessTokenRequest)	Obtains an Workload access token for agentic workloads not acting on behalf of user.
default GetWorkloadAccessTokenForJwtResponse	getWorkloadAccessTokenForJWT(Consumer<GetWorkloadAccessTokenForJwtRequest.Builder> getWorkloadAccessTokenForJwtRequest)	Obtains an Workload access token for agentic workloads acting on behalf of user with JWT token
default GetWorkloadAccessTokenForJwtResponse	getWorkloadAccessTokenForJWT(GetWorkloadAccessTokenForJwtRequest getWorkloadAccessTokenForJwtRequest)	Obtains an Workload access token for agentic workloads acting on behalf of user with JWT token
default GetWorkloadAccessTokenForUserIdResponse	getWorkloadAccessTokenForUserId(Consumer<GetWorkloadAccessTokenForUserIdRequest.Builder> getWorkloadAccessTokenForUserIdRequest)	Obtains an Workload access token for agentic workloads acting on behalf of user with User Id.
default GetWorkloadAccessTokenForUserIdResponse	getWorkloadAccessTokenForUserId(GetWorkloadAccessTokenForUserIdRequest getWorkloadAccessTokenForUserIdRequest)	Obtains an Workload access token for agentic workloads acting on behalf of user with User Id.
default ResponseInputStream<InvokeAgentRuntimeResponse>	invokeAgentRuntime(Consumer<InvokeAgentRuntimeRequest.Builder> invokeAgentRuntimeRequest)	Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.
default InvokeAgentRuntimeResponse	invokeAgentRuntime(Consumer<InvokeAgentRuntimeRequest.Builder> invokeAgentRuntimeRequest, Path destinationPath)	Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.
default <ReturnT> ReturnT	invokeAgentRuntime(Consumer<InvokeAgentRuntimeRequest.Builder> invokeAgentRuntimeRequest, ResponseTransformer<InvokeAgentRuntimeResponse,ReturnT> responseTransformer)	Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.
default ResponseInputStream<InvokeAgentRuntimeResponse>	invokeAgentRuntime(InvokeAgentRuntimeRequest invokeAgentRuntimeRequest)	Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.
default InvokeAgentRuntimeResponse	invokeAgentRuntime(InvokeAgentRuntimeRequest invokeAgentRuntimeRequest, Path destinationPath)	Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.
default <ReturnT> ReturnT	invokeAgentRuntime(InvokeAgentRuntimeRequest invokeAgentRuntimeRequest, ResponseTransformer<InvokeAgentRuntimeResponse,ReturnT> responseTransformer)	Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.
default ResponseBytes<InvokeAgentRuntimeResponse>	invokeAgentRuntimeAsBytes(Consumer<InvokeAgentRuntimeRequest.Builder> invokeAgentRuntimeRequest)	Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.
default ResponseBytes<InvokeAgentRuntimeResponse>	invokeAgentRuntimeAsBytes(InvokeAgentRuntimeRequest invokeAgentRuntimeRequest)	Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.
default ListActorsResponse	listActors(Consumer<ListActorsRequest.Builder> listActorsRequest)	Lists all actors in an AgentCore Memory resource.
default ListActorsResponse	listActors(ListActorsRequest listActorsRequest)	Lists all actors in an AgentCore Memory resource.
default ListActorsIterable	listActorsPaginator(Consumer<ListActorsRequest.Builder> listActorsRequest)	This is a variant of listActors(software.amazon.awssdk.services.bedrockagentcore.model.ListActorsRequest) operation.
default ListActorsIterable	listActorsPaginator(ListActorsRequest listActorsRequest)	This is a variant of listActors(software.amazon.awssdk.services.bedrockagentcore.model.ListActorsRequest) operation.
default ListBrowserSessionsResponse	listBrowserSessions(Consumer<ListBrowserSessionsRequest.Builder> listBrowserSessionsRequest)	Retrieves a list of browser sessions in Amazon Bedrock that match the specified criteria.
default ListBrowserSessionsResponse	listBrowserSessions(ListBrowserSessionsRequest listBrowserSessionsRequest)	Retrieves a list of browser sessions in Amazon Bedrock that match the specified criteria.
default ListCodeInterpreterSessionsResponse	listCodeInterpreterSessions(Consumer<ListCodeInterpreterSessionsRequest.Builder> listCodeInterpreterSessionsRequest)	Retrieves a list of code interpreter sessions in Amazon Bedrock that match the specified criteria.
default ListCodeInterpreterSessionsResponse	listCodeInterpreterSessions(ListCodeInterpreterSessionsRequest listCodeInterpreterSessionsRequest)	Retrieves a list of code interpreter sessions in Amazon Bedrock that match the specified criteria.
default ListEventsResponse	listEvents(Consumer<ListEventsRequest.Builder> listEventsRequest)	Lists events in an AgentCore Memory resource based on specified criteria.
default ListEventsResponse	listEvents(ListEventsRequest listEventsRequest)	Lists events in an AgentCore Memory resource based on specified criteria.
default ListEventsIterable	listEventsPaginator(Consumer<ListEventsRequest.Builder> listEventsRequest)	This is a variant of listEvents(software.amazon.awssdk.services.bedrockagentcore.model.ListEventsRequest) operation.
default ListEventsIterable	listEventsPaginator(ListEventsRequest listEventsRequest)	This is a variant of listEvents(software.amazon.awssdk.services.bedrockagentcore.model.ListEventsRequest) operation.
default ListMemoryRecordsResponse	listMemoryRecords(Consumer<ListMemoryRecordsRequest.Builder> listMemoryRecordsRequest)	Lists memory records in an AgentCore Memory resource based on specified criteria.
default ListMemoryRecordsResponse	listMemoryRecords(ListMemoryRecordsRequest listMemoryRecordsRequest)	Lists memory records in an AgentCore Memory resource based on specified criteria.
default ListMemoryRecordsIterable	listMemoryRecordsPaginator(Consumer<ListMemoryRecordsRequest.Builder> listMemoryRecordsRequest)	This is a variant of listMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryRecordsRequest) operation.
default ListMemoryRecordsIterable	listMemoryRecordsPaginator(ListMemoryRecordsRequest listMemoryRecordsRequest)	This is a variant of listMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryRecordsRequest) operation.
default ListSessionsResponse	listSessions(Consumer<ListSessionsRequest.Builder> listSessionsRequest)	Lists sessions in an AgentCore Memory resource based on specified criteria.
default ListSessionsResponse	listSessions(ListSessionsRequest listSessionsRequest)	Lists sessions in an AgentCore Memory resource based on specified criteria.
default ListSessionsIterable	listSessionsPaginator(Consumer<ListSessionsRequest.Builder> listSessionsRequest)	This is a variant of listSessions(software.amazon.awssdk.services.bedrockagentcore.model.ListSessionsRequest) operation.
default ListSessionsIterable	listSessionsPaginator(ListSessionsRequest listSessionsRequest)	This is a variant of listSessions(software.amazon.awssdk.services.bedrockagentcore.model.ListSessionsRequest) operation.
default RetrieveMemoryRecordsResponse	retrieveMemoryRecords(Consumer<RetrieveMemoryRecordsRequest.Builder> retrieveMemoryRecordsRequest)	Searches for and retrieves memory records from an AgentCore Memory resource based on specified search criteria.
default RetrieveMemoryRecordsResponse	retrieveMemoryRecords(RetrieveMemoryRecordsRequest retrieveMemoryRecordsRequest)	Searches for and retrieves memory records from an AgentCore Memory resource based on specified search criteria.
default RetrieveMemoryRecordsIterable	retrieveMemoryRecordsPaginator(Consumer<RetrieveMemoryRecordsRequest.Builder> retrieveMemoryRecordsRequest)	This is a variant of retrieveMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.RetrieveMemoryRecordsRequest) operation.
default RetrieveMemoryRecordsIterable	retrieveMemoryRecordsPaginator(RetrieveMemoryRecordsRequest retrieveMemoryRecordsRequest)	This is a variant of retrieveMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.RetrieveMemoryRecordsRequest) operation.
default BedrockAgentCoreServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartBrowserSessionResponse	startBrowserSession(Consumer<StartBrowserSessionRequest.Builder> startBrowserSessionRequest)	Creates and initializes a browser session in Amazon Bedrock.
default StartBrowserSessionResponse	startBrowserSession(StartBrowserSessionRequest startBrowserSessionRequest)	Creates and initializes a browser session in Amazon Bedrock.
default StartCodeInterpreterSessionResponse	startCodeInterpreterSession(Consumer<StartCodeInterpreterSessionRequest.Builder> startCodeInterpreterSessionRequest)	Creates and initializes a code interpreter session in Amazon Bedrock.
default StartCodeInterpreterSessionResponse	startCodeInterpreterSession(StartCodeInterpreterSessionRequest startCodeInterpreterSessionRequest)	Creates and initializes a code interpreter session in Amazon Bedrock.
default StopBrowserSessionResponse	stopBrowserSession(Consumer<StopBrowserSessionRequest.Builder> stopBrowserSessionRequest)	Terminates an active browser session in Amazon Bedrock.
default StopBrowserSessionResponse	stopBrowserSession(StopBrowserSessionRequest stopBrowserSessionRequest)	Terminates an active browser session in Amazon Bedrock.
default StopCodeInterpreterSessionResponse	stopCodeInterpreterSession(Consumer<StopCodeInterpreterSessionRequest.Builder> stopCodeInterpreterSessionRequest)	Terminates an active code interpreter session in Amazon Bedrock.
default StopCodeInterpreterSessionResponse	stopCodeInterpreterSession(StopCodeInterpreterSessionRequest stopCodeInterpreterSessionRequest)	Terminates an active code interpreter session in Amazon Bedrock.
default UpdateBrowserStreamResponse	updateBrowserStream(Consumer<UpdateBrowserStreamRequest.Builder> updateBrowserStreamRequest)	Updates a browser stream.
default UpdateBrowserStreamResponse	updateBrowserStream(UpdateBrowserStreamRequest updateBrowserStreamRequest)	Updates a browser stream.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createEvent

default CreateEventResponse createEvent(CreateEventRequest createEventRequest)
                                 throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Creates an event in an AgentCore Memory resource. Events represent interactions or activities that occur within a session and are associated with specific actors.

To use this operation, you must have the bedrock-agentcore:CreateEvent permission.

This operation is subject to request rate limiting.

Parameters:

createEventRequest -

Returns:

Result of the CreateEvent operation returned by the service.

See Also:

• AWS API Documentation

createEvent

default CreateEventResponse createEvent(Consumer<CreateEventRequest.Builder> createEventRequest)
                                 throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Creates an event in an AgentCore Memory resource. Events represent interactions or activities that occur within a session and are associated with specific actors.

To use this operation, you must have the bedrock-agentcore:CreateEvent permission.

This operation is subject to request rate limiting.

This is a convenience which creates an instance of the CreateEventRequest.Builder avoiding the need to create one manually via CreateEventRequest.builder()

Parameters:

createEventRequest - A Consumer that will call methods on CreateEventRequest.Builder to create a request.

Returns:

Result of the CreateEvent operation returned by the service.

See Also:

• AWS API Documentation

deleteEvent

default DeleteEventResponse deleteEvent(DeleteEventRequest deleteEventRequest)
                                 throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Deletes an event from an AgentCore Memory resource. When you delete an event, it is permanently removed.

To use this operation, you must have the bedrock-agentcore:DeleteEvent permission.

Parameters:

deleteEventRequest -

Returns:

Result of the DeleteEvent operation returned by the service.

See Also:

• AWS API Documentation

deleteEvent

default DeleteEventResponse deleteEvent(Consumer<DeleteEventRequest.Builder> deleteEventRequest)
                                 throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Deletes an event from an AgentCore Memory resource. When you delete an event, it is permanently removed.

To use this operation, you must have the bedrock-agentcore:DeleteEvent permission.

This is a convenience which creates an instance of the DeleteEventRequest.Builder avoiding the need to create one manually via DeleteEventRequest.builder()

Parameters:

deleteEventRequest - A Consumer that will call methods on DeleteEventRequest.Builder to create a request.

Returns:

Result of the DeleteEvent operation returned by the service.

See Also:

• AWS API Documentation

deleteMemoryRecord

default DeleteMemoryRecordResponse deleteMemoryRecord(DeleteMemoryRecordRequest deleteMemoryRecordRequest)
                                               throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Deletes a memory record from an AgentCore Memory resource. When you delete a memory record, it is permanently removed.

To use this operation, you must have the bedrock-agentcore:DeleteMemoryRecord permission.

Parameters:

deleteMemoryRecordRequest -

Returns:

Result of the DeleteMemoryRecord operation returned by the service.

See Also:

• AWS API Documentation

deleteMemoryRecord

default DeleteMemoryRecordResponse deleteMemoryRecord(Consumer<DeleteMemoryRecordRequest.Builder> deleteMemoryRecordRequest)
                                               throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Deletes a memory record from an AgentCore Memory resource. When you delete a memory record, it is permanently removed.

To use this operation, you must have the bedrock-agentcore:DeleteMemoryRecord permission.

This is a convenience which creates an instance of the DeleteMemoryRecordRequest.Builder avoiding the need to create one manually via DeleteMemoryRecordRequest.builder()

Parameters:

deleteMemoryRecordRequest - A Consumer that will call methods on DeleteMemoryRecordRequest.Builder to create a request.

Returns:

Result of the DeleteMemoryRecord operation returned by the service.

See Also:

• AWS API Documentation

getBrowserSession

default GetBrowserSessionResponse getBrowserSession(GetBrowserSessionRequest getBrowserSessionRequest)
                                             throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves detailed information about a specific browser session in Amazon Bedrock. This operation returns the session's configuration, current status, associated streams, and metadata.

To get a browser session, you must specify both the browser identifier and the session ID. The response includes information about the session's viewport configuration, timeout settings, and stream endpoints.

The following operations are related to GetBrowserSession:

• StartBrowserSession

• ListBrowserSessions

• StopBrowserSession

Parameters:

getBrowserSessionRequest -

Returns:

Result of the GetBrowserSession operation returned by the service.

See Also:

• AWS API Documentation

getBrowserSession

default GetBrowserSessionResponse getBrowserSession(Consumer<GetBrowserSessionRequest.Builder> getBrowserSessionRequest)
                                             throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves detailed information about a specific browser session in Amazon Bedrock. This operation returns the session's configuration, current status, associated streams, and metadata.

To get a browser session, you must specify both the browser identifier and the session ID. The response includes information about the session's viewport configuration, timeout settings, and stream endpoints.

The following operations are related to GetBrowserSession:

• StartBrowserSession

• ListBrowserSessions

• StopBrowserSession

This is a convenience which creates an instance of the GetBrowserSessionRequest.Builder avoiding the need to create one manually via GetBrowserSessionRequest.builder()

Parameters:

getBrowserSessionRequest - A Consumer that will call methods on GetBrowserSessionRequest.Builder to create a request.

Returns:

Result of the GetBrowserSession operation returned by the service.

See Also:

• AWS API Documentation

getCodeInterpreterSession

default GetCodeInterpreterSessionResponse getCodeInterpreterSession(GetCodeInterpreterSessionRequest getCodeInterpreterSessionRequest)
                                                             throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves detailed information about a specific code interpreter session in Amazon Bedrock. This operation returns the session's configuration, current status, and metadata.

To get a code interpreter session, you must specify both the code interpreter identifier and the session ID. The response includes information about the session's timeout settings and current status.

The following operations are related to GetCodeInterpreterSession:

• StartCodeInterpreterSession

• ListCodeInterpreterSessions

• StopCodeInterpreterSession

Parameters:

getCodeInterpreterSessionRequest -

Returns:

Result of the GetCodeInterpreterSession operation returned by the service.

See Also:

• AWS API Documentation

getCodeInterpreterSession

default GetCodeInterpreterSessionResponse getCodeInterpreterSession(Consumer<GetCodeInterpreterSessionRequest.Builder> getCodeInterpreterSessionRequest)
                                                             throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves detailed information about a specific code interpreter session in Amazon Bedrock. This operation returns the session's configuration, current status, and metadata.

To get a code interpreter session, you must specify both the code interpreter identifier and the session ID. The response includes information about the session's timeout settings and current status.

The following operations are related to GetCodeInterpreterSession:

• StartCodeInterpreterSession

• ListCodeInterpreterSessions

• StopCodeInterpreterSession

This is a convenience which creates an instance of the GetCodeInterpreterSessionRequest.Builder avoiding the need to create one manually via GetCodeInterpreterSessionRequest.builder()

Parameters:

getCodeInterpreterSessionRequest - A Consumer that will call methods on GetCodeInterpreterSessionRequest.Builder to create a request.

Returns:

Result of the GetCodeInterpreterSession operation returned by the service.

See Also:

• AWS API Documentation

getEvent

default GetEventResponse getEvent(GetEventRequest getEventRequest)
                           throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves information about a specific event in an AgentCore Memory resource.

To use this operation, you must have the bedrock-agentcore:GetEvent permission.

Parameters:

getEventRequest -

Returns:

Result of the GetEvent operation returned by the service.

See Also:

• AWS API Documentation

getEvent

default GetEventResponse getEvent(Consumer<GetEventRequest.Builder> getEventRequest)
                           throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves information about a specific event in an AgentCore Memory resource.

To use this operation, you must have the bedrock-agentcore:GetEvent permission.

This is a convenience which creates an instance of the GetEventRequest.Builder avoiding the need to create one manually via GetEventRequest.builder()

Parameters:

getEventRequest - A Consumer that will call methods on GetEventRequest.Builder to create a request.

Returns:

Result of the GetEvent operation returned by the service.

See Also:

• AWS API Documentation

getMemoryRecord

default GetMemoryRecordResponse getMemoryRecord(GetMemoryRecordRequest getMemoryRecordRequest)
                                         throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves a specific memory record from an AgentCore Memory resource.

To use this operation, you must have the bedrock-agentcore:GetMemoryRecord permission.

Parameters:

getMemoryRecordRequest -

Returns:

Result of the GetMemoryRecord operation returned by the service.

See Also:

• AWS API Documentation

getMemoryRecord

default GetMemoryRecordResponse getMemoryRecord(Consumer<GetMemoryRecordRequest.Builder> getMemoryRecordRequest)
                                         throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves a specific memory record from an AgentCore Memory resource.

To use this operation, you must have the bedrock-agentcore:GetMemoryRecord permission.

This is a convenience which creates an instance of the GetMemoryRecordRequest.Builder avoiding the need to create one manually via GetMemoryRecordRequest.builder()

Parameters:

getMemoryRecordRequest - A Consumer that will call methods on GetMemoryRecordRequest.Builder to create a request.

Returns:

Result of the GetMemoryRecord operation returned by the service.

See Also:

• AWS API Documentation

getResourceApiKey

default GetResourceApiKeyResponse getResourceApiKey(GetResourceApiKeyRequest getResourceApiKeyRequest)
                                             throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves an API Key associated with an API Key Credential Provider

Parameters:

getResourceApiKeyRequest -

Returns:

Result of the GetResourceApiKey operation returned by the service.

See Also:

• AWS API Documentation

getResourceApiKey

default GetResourceApiKeyResponse getResourceApiKey(Consumer<GetResourceApiKeyRequest.Builder> getResourceApiKeyRequest)
                                             throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves an API Key associated with an API Key Credential Provider

This is a convenience which creates an instance of the GetResourceApiKeyRequest.Builder avoiding the need to create one manually via GetResourceApiKeyRequest.builder()

Parameters:

getResourceApiKeyRequest - A Consumer that will call methods on GetResourceApiKeyRequest.Builder to create a request.

Returns:

Result of the GetResourceApiKey operation returned by the service.

See Also:

• AWS API Documentation

getResourceOauth2Token

default GetResourceOauth2TokenResponse getResourceOauth2Token(GetResourceOauth2TokenRequest getResourceOauth2TokenRequest)
                                                       throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Returns the OAuth 2.0 token of the provided resource

Parameters:

getResourceOauth2TokenRequest -

Returns:

Result of the GetResourceOauth2Token operation returned by the service.

See Also:

• AWS API Documentation

getResourceOauth2Token

default GetResourceOauth2TokenResponse getResourceOauth2Token(Consumer<GetResourceOauth2TokenRequest.Builder> getResourceOauth2TokenRequest)
                                                       throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Returns the OAuth 2.0 token of the provided resource

This is a convenience which creates an instance of the GetResourceOauth2TokenRequest.Builder avoiding the need to create one manually via GetResourceOauth2TokenRequest.builder()

Parameters:

getResourceOauth2TokenRequest - A Consumer that will call methods on GetResourceOauth2TokenRequest.Builder to create a request.

Returns:

Result of the GetResourceOauth2Token operation returned by the service.

See Also:

• AWS API Documentation

getWorkloadAccessToken

default GetWorkloadAccessTokenResponse getWorkloadAccessToken(GetWorkloadAccessTokenRequest getWorkloadAccessTokenRequest)
                                                       throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Obtains an Workload access token for agentic workloads not acting on behalf of user.

Parameters:

getWorkloadAccessTokenRequest -

Returns:

Result of the GetWorkloadAccessToken operation returned by the service.

See Also:

• AWS API Documentation

getWorkloadAccessToken

default GetWorkloadAccessTokenResponse getWorkloadAccessToken(Consumer<GetWorkloadAccessTokenRequest.Builder> getWorkloadAccessTokenRequest)
                                                       throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Obtains an Workload access token for agentic workloads not acting on behalf of user.

This is a convenience which creates an instance of the GetWorkloadAccessTokenRequest.Builder avoiding the need to create one manually via GetWorkloadAccessTokenRequest.builder()

Parameters:

getWorkloadAccessTokenRequest - A Consumer that will call methods on GetWorkloadAccessTokenRequest.Builder to create a request.

Returns:

Result of the GetWorkloadAccessToken operation returned by the service.

See Also:

• AWS API Documentation

getWorkloadAccessTokenForJWT

default GetWorkloadAccessTokenForJwtResponse getWorkloadAccessTokenForJWT(GetWorkloadAccessTokenForJwtRequest getWorkloadAccessTokenForJwtRequest)
                                                                   throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Obtains an Workload access token for agentic workloads acting on behalf of user with JWT token

Parameters:

getWorkloadAccessTokenForJwtRequest -

Returns:

Result of the GetWorkloadAccessTokenForJWT operation returned by the service.

See Also:

• AWS API Documentation

getWorkloadAccessTokenForJWT

default GetWorkloadAccessTokenForJwtResponse getWorkloadAccessTokenForJWT(Consumer<GetWorkloadAccessTokenForJwtRequest.Builder> getWorkloadAccessTokenForJwtRequest)
                                                                   throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Obtains an Workload access token for agentic workloads acting on behalf of user with JWT token

This is a convenience which creates an instance of the GetWorkloadAccessTokenForJwtRequest.Builder avoiding the need to create one manually via GetWorkloadAccessTokenForJwtRequest.builder()

Parameters:

getWorkloadAccessTokenForJwtRequest - A Consumer that will call methods on GetWorkloadAccessTokenForJwtRequest.Builder to create a request.

Returns:

Result of the GetWorkloadAccessTokenForJWT operation returned by the service.

See Also:

• AWS API Documentation

getWorkloadAccessTokenForUserId

default GetWorkloadAccessTokenForUserIdResponse getWorkloadAccessTokenForUserId(GetWorkloadAccessTokenForUserIdRequest getWorkloadAccessTokenForUserIdRequest)
                                                                         throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Obtains an Workload access token for agentic workloads acting on behalf of user with User Id.

Parameters:

getWorkloadAccessTokenForUserIdRequest -

Returns:

Result of the GetWorkloadAccessTokenForUserId operation returned by the service.

See Also:

• AWS API Documentation

getWorkloadAccessTokenForUserId

default GetWorkloadAccessTokenForUserIdResponse getWorkloadAccessTokenForUserId(Consumer<GetWorkloadAccessTokenForUserIdRequest.Builder> getWorkloadAccessTokenForUserIdRequest)
                                                                         throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Obtains an Workload access token for agentic workloads acting on behalf of user with User Id.

This is a convenience which creates an instance of the GetWorkloadAccessTokenForUserIdRequest.Builder avoiding the need to create one manually via GetWorkloadAccessTokenForUserIdRequest.builder()

Parameters:

getWorkloadAccessTokenForUserIdRequest - A Consumer that will call methods on GetWorkloadAccessTokenForUserIdRequest.Builder to create a request.

Returns:

Result of the GetWorkloadAccessTokenForUserId operation returned by the service.

See Also:

• AWS API Documentation

invokeAgentRuntime

default <ReturnT> ReturnT invokeAgentRuntime(InvokeAgentRuntimeRequest invokeAgentRuntimeRequest,
 ResponseTransformer<InvokeAgentRuntimeResponse,ReturnT> responseTransformer)
                                      throws ServiceQuotaExceededException,
ValidationException,
AccessDeniedException,
RuntimeClientErrorException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.

To invoke an agent you must specify the AgentCore Runtime ARN and provide a payload containing your request. You can optionally specify a qualifier to target a specific version or endpoint of the agent.

This operation supports streaming responses, allowing you to receive partial responses as they become available. We recommend using pagination to ensure that the operation returns quickly and successfully when processing large responses.

For example code, see Invoke an AgentCore Runtime agent.

If you're integrating your agent with OAuth, you can't use the Amazon Web Services SDK to call InvokeAgentRuntime. Instead, make a HTTPS request to InvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.

To use this operation, you must have the bedrock-agentcore:InvokeAgentRuntime permission.

Parameters:

invokeAgentRuntimeRequest -

responseTransformer - Functional interface for processing the streamed response content. The unmarshalled InvokeAgentRuntimeResponse and an InputStream to the response content are provided as parameters to the callback. The callback may return a transformed type which will be the return value of this method. See ResponseTransformer for details on implementing this interface and for links to pre-canned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows '

The response data from the agent runtime. The format of this data depends on the specific agent configuration and the requested accept type. For most agents, this is a JSON object containing the agent's response to the user's request.

'.

Returns:

The transformed result of the ResponseTransformer.

See Also:

• AWS API Documentation

invokeAgentRuntime

default <ReturnT> ReturnT invokeAgentRuntime(Consumer<InvokeAgentRuntimeRequest.Builder> invokeAgentRuntimeRequest,
 ResponseTransformer<InvokeAgentRuntimeResponse,ReturnT> responseTransformer)
                                      throws ServiceQuotaExceededException,
ValidationException,
AccessDeniedException,
RuntimeClientErrorException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.

To invoke an agent you must specify the AgentCore Runtime ARN and provide a payload containing your request. You can optionally specify a qualifier to target a specific version or endpoint of the agent.

This operation supports streaming responses, allowing you to receive partial responses as they become available. We recommend using pagination to ensure that the operation returns quickly and successfully when processing large responses.

For example code, see Invoke an AgentCore Runtime agent.

If you're integrating your agent with OAuth, you can't use the Amazon Web Services SDK to call InvokeAgentRuntime. Instead, make a HTTPS request to InvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.

To use this operation, you must have the bedrock-agentcore:InvokeAgentRuntime permission.

This is a convenience which creates an instance of the InvokeAgentRuntimeRequest.Builder avoiding the need to create one manually via InvokeAgentRuntimeRequest.builder()

Parameters:

invokeAgentRuntimeRequest - A Consumer that will call methods on InvokeAgentRuntimeRequest.Builder to create a request.

responseTransformer - Functional interface for processing the streamed response content. The unmarshalled InvokeAgentRuntimeResponse and an InputStream to the response content are provided as parameters to the callback. The callback may return a transformed type which will be the return value of this method. See ResponseTransformer for details on implementing this interface and for links to pre-canned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows '

The response data from the agent runtime. The format of this data depends on the specific agent configuration and the requested accept type. For most agents, this is a JSON object containing the agent's response to the user's request.

'.

Returns:

The transformed result of the ResponseTransformer.

See Also:

• AWS API Documentation

invokeAgentRuntime

default InvokeAgentRuntimeResponse invokeAgentRuntime(InvokeAgentRuntimeRequest invokeAgentRuntimeRequest,
 Path destinationPath)
                                               throws ServiceQuotaExceededException,
ValidationException,
AccessDeniedException,
RuntimeClientErrorException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.

To invoke an agent you must specify the AgentCore Runtime ARN and provide a payload containing your request. You can optionally specify a qualifier to target a specific version or endpoint of the agent.

This operation supports streaming responses, allowing you to receive partial responses as they become available. We recommend using pagination to ensure that the operation returns quickly and successfully when processing large responses.

For example code, see Invoke an AgentCore Runtime agent.

If you're integrating your agent with OAuth, you can't use the Amazon Web Services SDK to call InvokeAgentRuntime. Instead, make a HTTPS request to InvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.

To use this operation, you must have the bedrock-agentcore:InvokeAgentRuntime permission.

Parameters:

invokeAgentRuntimeRequest -

destinationPath - Path to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows '

The response data from the agent runtime. The format of this data depends on the specific agent configuration and the requested accept type. For most agents, this is a JSON object containing the agent's response to the user's request.

'.

Returns:

The transformed result of the ResponseTransformer.

See Also:

• invokeAgentRuntime(InvokeAgentRuntimeRequest, ResponseTransformer)
• AWS API Documentation

invokeAgentRuntime

default InvokeAgentRuntimeResponse invokeAgentRuntime(Consumer<InvokeAgentRuntimeRequest.Builder> invokeAgentRuntimeRequest,
 Path destinationPath)
                                               throws ServiceQuotaExceededException,
ValidationException,
AccessDeniedException,
RuntimeClientErrorException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.

To invoke an agent you must specify the AgentCore Runtime ARN and provide a payload containing your request. You can optionally specify a qualifier to target a specific version or endpoint of the agent.

This operation supports streaming responses, allowing you to receive partial responses as they become available. We recommend using pagination to ensure that the operation returns quickly and successfully when processing large responses.

For example code, see Invoke an AgentCore Runtime agent.

If you're integrating your agent with OAuth, you can't use the Amazon Web Services SDK to call InvokeAgentRuntime. Instead, make a HTTPS request to InvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.

To use this operation, you must have the bedrock-agentcore:InvokeAgentRuntime permission.

This is a convenience which creates an instance of the InvokeAgentRuntimeRequest.Builder avoiding the need to create one manually via InvokeAgentRuntimeRequest.builder()

Parameters:

invokeAgentRuntimeRequest - A Consumer that will call methods on InvokeAgentRuntimeRequest.Builder to create a request.

destinationPath - Path to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows '

The response data from the agent runtime. The format of this data depends on the specific agent configuration and the requested accept type. For most agents, this is a JSON object containing the agent's response to the user's request.

'.

Returns:

The transformed result of the ResponseTransformer.

See Also:

• invokeAgentRuntime(InvokeAgentRuntimeRequest, ResponseTransformer)
• AWS API Documentation

invokeAgentRuntime

default ResponseInputStream<InvokeAgentRuntimeResponse> invokeAgentRuntime(InvokeAgentRuntimeRequest invokeAgentRuntimeRequest)
                                                                    throws ServiceQuotaExceededException,
ValidationException,
AccessDeniedException,
RuntimeClientErrorException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.

To invoke an agent you must specify the AgentCore Runtime ARN and provide a payload containing your request. You can optionally specify a qualifier to target a specific version or endpoint of the agent.

This operation supports streaming responses, allowing you to receive partial responses as they become available. We recommend using pagination to ensure that the operation returns quickly and successfully when processing large responses.

For example code, see Invoke an AgentCore Runtime agent.

If you're integrating your agent with OAuth, you can't use the Amazon Web Services SDK to call InvokeAgentRuntime. Instead, make a HTTPS request to InvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.

To use this operation, you must have the bedrock-agentcore:InvokeAgentRuntime permission.

Parameters:

invokeAgentRuntimeRequest -

Returns:

A ResponseInputStream containing data streamed from service. Note that this is an unmanaged reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior and exhausting connections in the connection pool. The unmarshalled response object can be obtained via ResponseInputStream.response(). The service documentation for the response content is as follows '

The response data from the agent runtime. The format of this data depends on the specific agent configuration and the requested accept type. For most agents, this is a JSON object containing the agent's response to the user's request.

'.

See Also:

• invalid reference

  #getObject(invokeAgentRuntime, ResponseTransformer)

• AWS API Documentation

invokeAgentRuntime

default ResponseInputStream<InvokeAgentRuntimeResponse> invokeAgentRuntime(Consumer<InvokeAgentRuntimeRequest.Builder> invokeAgentRuntimeRequest)
                                                                    throws ServiceQuotaExceededException,
ValidationException,
AccessDeniedException,
RuntimeClientErrorException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.

To invoke an agent you must specify the AgentCore Runtime ARN and provide a payload containing your request. You can optionally specify a qualifier to target a specific version or endpoint of the agent.

This operation supports streaming responses, allowing you to receive partial responses as they become available. We recommend using pagination to ensure that the operation returns quickly and successfully when processing large responses.

For example code, see Invoke an AgentCore Runtime agent.

If you're integrating your agent with OAuth, you can't use the Amazon Web Services SDK to call InvokeAgentRuntime. Instead, make a HTTPS request to InvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.

To use this operation, you must have the bedrock-agentcore:InvokeAgentRuntime permission.

This is a convenience which creates an instance of the InvokeAgentRuntimeRequest.Builder avoiding the need to create one manually via InvokeAgentRuntimeRequest.builder()

Parameters:

invokeAgentRuntimeRequest - A Consumer that will call methods on InvokeAgentRuntimeRequest.Builder to create a request.

Returns:

A ResponseInputStream containing data streamed from service. Note that this is an unmanaged reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior and exhausting connections in the connection pool. The unmarshalled response object can be obtained via ResponseInputStream.response(). The service documentation for the response content is as follows '

The response data from the agent runtime. The format of this data depends on the specific agent configuration and the requested accept type. For most agents, this is a JSON object containing the agent's response to the user's request.

'.

See Also:

• invalid reference

  #getObject(invokeAgentRuntime, ResponseTransformer)

• AWS API Documentation

invokeAgentRuntimeAsBytes

default ResponseBytes<InvokeAgentRuntimeResponse> invokeAgentRuntimeAsBytes(InvokeAgentRuntimeRequest invokeAgentRuntimeRequest)
                                                                     throws ServiceQuotaExceededException,
ValidationException,
AccessDeniedException,
RuntimeClientErrorException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.

To invoke an agent you must specify the AgentCore Runtime ARN and provide a payload containing your request. You can optionally specify a qualifier to target a specific version or endpoint of the agent.

This operation supports streaming responses, allowing you to receive partial responses as they become available. We recommend using pagination to ensure that the operation returns quickly and successfully when processing large responses.

For example code, see Invoke an AgentCore Runtime agent.

If you're integrating your agent with OAuth, you can't use the Amazon Web Services SDK to call InvokeAgentRuntime. Instead, make a HTTPS request to InvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.

To use this operation, you must have the bedrock-agentcore:InvokeAgentRuntime permission.

Parameters:

invokeAgentRuntimeRequest -

Returns:

A ResponseBytes that loads the data streamed from the service into memory and exposes it in convenient in-memory representations like a byte buffer or string. The unmarshalled response object can be obtained via ResponseBytes.response(). The service documentation for the response content is as follows '

The response data from the agent runtime. The format of this data depends on the specific agent configuration and the requested accept type. For most agents, this is a JSON object containing the agent's response to the user's request.

'.

See Also:

• invalid reference

  #getObject(invokeAgentRuntime, ResponseTransformer)

• AWS API Documentation

invokeAgentRuntimeAsBytes

default ResponseBytes<InvokeAgentRuntimeResponse> invokeAgentRuntimeAsBytes(Consumer<InvokeAgentRuntimeRequest.Builder> invokeAgentRuntimeRequest)
                                                                     throws ServiceQuotaExceededException,
ValidationException,
AccessDeniedException,
RuntimeClientErrorException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.

To invoke an agent you must specify the AgentCore Runtime ARN and provide a payload containing your request. You can optionally specify a qualifier to target a specific version or endpoint of the agent.

This operation supports streaming responses, allowing you to receive partial responses as they become available. We recommend using pagination to ensure that the operation returns quickly and successfully when processing large responses.

For example code, see Invoke an AgentCore Runtime agent.

If you're integrating your agent with OAuth, you can't use the Amazon Web Services SDK to call InvokeAgentRuntime. Instead, make a HTTPS request to InvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.

To use this operation, you must have the bedrock-agentcore:InvokeAgentRuntime permission.

This is a convenience which creates an instance of the InvokeAgentRuntimeRequest.Builder avoiding the need to create one manually via InvokeAgentRuntimeRequest.builder()

Parameters:

invokeAgentRuntimeRequest - A Consumer that will call methods on InvokeAgentRuntimeRequest.Builder to create a request.

Returns:

A ResponseBytes that loads the data streamed from the service into memory and exposes it in convenient in-memory representations like a byte buffer or string. The unmarshalled response object can be obtained via ResponseBytes.response(). The service documentation for the response content is as follows '

The response data from the agent runtime. The format of this data depends on the specific agent configuration and the requested accept type. For most agents, this is a JSON object containing the agent's response to the user's request.

'.

See Also:

• invalid reference

  #getObject(invokeAgentRuntime, ResponseTransformer)

• AWS API Documentation

listActors

default ListActorsResponse listActors(ListActorsRequest listActorsRequest)
                               throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Lists all actors in an AgentCore Memory resource. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the bedrock-agentcore:ListActors permission.

Parameters:

listActorsRequest -

Returns:

Result of the ListActors operation returned by the service.

See Also:

• AWS API Documentation

listActors

default ListActorsResponse listActors(Consumer<ListActorsRequest.Builder> listActorsRequest)
                               throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Lists all actors in an AgentCore Memory resource. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the bedrock-agentcore:ListActors permission.

This is a convenience which creates an instance of the ListActorsRequest.Builder avoiding the need to create one manually via ListActorsRequest.builder()

Parameters:

listActorsRequest - A Consumer that will call methods on ListActorsRequest.Builder to create a request.

Returns:

Result of the ListActors operation returned by the service.

See Also:

• AWS API Documentation

listActorsPaginator

default ListActorsIterable listActorsPaginator(ListActorsRequest listActorsRequest)
                                        throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listActors(software.amazon.awssdk.services.bedrockagentcore.model.ListActorsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListActorsIterable responses = client.listActorsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.ListActorsIterable responses = client
             .listActorsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.ListActorsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListActorsIterable responses = client.listActorsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listActors(software.amazon.awssdk.services.bedrockagentcore.model.ListActorsRequest) operation.

Parameters:

listActorsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listActorsPaginator

default ListActorsIterable listActorsPaginator(Consumer<ListActorsRequest.Builder> listActorsRequest)
                                        throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listActors(software.amazon.awssdk.services.bedrockagentcore.model.ListActorsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListActorsIterable responses = client.listActorsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.ListActorsIterable responses = client
             .listActorsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.ListActorsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListActorsIterable responses = client.listActorsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listActors(software.amazon.awssdk.services.bedrockagentcore.model.ListActorsRequest) operation.

This is a convenience which creates an instance of the ListActorsRequest.Builder avoiding the need to create one manually via ListActorsRequest.builder()

Parameters:

listActorsRequest - A Consumer that will call methods on ListActorsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listBrowserSessions

default ListBrowserSessionsResponse listBrowserSessions(ListBrowserSessionsRequest listBrowserSessionsRequest)
                                                 throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves a list of browser sessions in Amazon Bedrock that match the specified criteria. This operation returns summary information about each session, including identifiers, status, and timestamps.

You can filter the results by browser identifier and session status. The operation supports pagination to handle large result sets efficiently.

We recommend using pagination to ensure that the operation returns quickly and successfully when retrieving large numbers of sessions.

The following operations are related to ListBrowserSessions:

• StartBrowserSession

• GetBrowserSession

Parameters:

listBrowserSessionsRequest -

Returns:

Result of the ListBrowserSessions operation returned by the service.

See Also:

• AWS API Documentation

listBrowserSessions

default ListBrowserSessionsResponse listBrowserSessions(Consumer<ListBrowserSessionsRequest.Builder> listBrowserSessionsRequest)
                                                 throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves a list of browser sessions in Amazon Bedrock that match the specified criteria. This operation returns summary information about each session, including identifiers, status, and timestamps.

You can filter the results by browser identifier and session status. The operation supports pagination to handle large result sets efficiently.

We recommend using pagination to ensure that the operation returns quickly and successfully when retrieving large numbers of sessions.

The following operations are related to ListBrowserSessions:

• StartBrowserSession

• GetBrowserSession

This is a convenience which creates an instance of the ListBrowserSessionsRequest.Builder avoiding the need to create one manually via ListBrowserSessionsRequest.builder()

Parameters:

listBrowserSessionsRequest - A Consumer that will call methods on ListBrowserSessionsRequest.Builder to create a request.

Returns:

Result of the ListBrowserSessions operation returned by the service.

See Also:

• AWS API Documentation

listCodeInterpreterSessions

default ListCodeInterpreterSessionsResponse listCodeInterpreterSessions(ListCodeInterpreterSessionsRequest listCodeInterpreterSessionsRequest)
                                                                 throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves a list of code interpreter sessions in Amazon Bedrock that match the specified criteria. This operation returns summary information about each session, including identifiers, status, and timestamps.

You can filter the results by code interpreter identifier and session status. The operation supports pagination to handle large result sets efficiently.

We recommend using pagination to ensure that the operation returns quickly and successfully when retrieving large numbers of sessions.

The following operations are related to ListCodeInterpreterSessions:

• StartCodeInterpreterSession

• GetCodeInterpreterSession

Parameters:

listCodeInterpreterSessionsRequest -

Returns:

Result of the ListCodeInterpreterSessions operation returned by the service.

See Also:

• AWS API Documentation

listCodeInterpreterSessions

default ListCodeInterpreterSessionsResponse listCodeInterpreterSessions(Consumer<ListCodeInterpreterSessionsRequest.Builder> listCodeInterpreterSessionsRequest)
                                                                 throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves a list of code interpreter sessions in Amazon Bedrock that match the specified criteria. This operation returns summary information about each session, including identifiers, status, and timestamps.

You can filter the results by code interpreter identifier and session status. The operation supports pagination to handle large result sets efficiently.

We recommend using pagination to ensure that the operation returns quickly and successfully when retrieving large numbers of sessions.

The following operations are related to ListCodeInterpreterSessions:

• StartCodeInterpreterSession

• GetCodeInterpreterSession

This is a convenience which creates an instance of the ListCodeInterpreterSessionsRequest.Builder avoiding the need to create one manually via ListCodeInterpreterSessionsRequest.builder()

Parameters:

listCodeInterpreterSessionsRequest - A Consumer that will call methods on ListCodeInterpreterSessionsRequest.Builder to create a request.

Returns:

Result of the ListCodeInterpreterSessions operation returned by the service.

See Also:

• AWS API Documentation

listEvents

default ListEventsResponse listEvents(ListEventsRequest listEventsRequest)
                               throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Lists events in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the bedrock-agentcore:ListEvents permission.

Parameters:

listEventsRequest -

Returns:

Result of the ListEvents operation returned by the service.

See Also:

• AWS API Documentation

listEvents

default ListEventsResponse listEvents(Consumer<ListEventsRequest.Builder> listEventsRequest)
                               throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Lists events in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the bedrock-agentcore:ListEvents permission.

This is a convenience which creates an instance of the ListEventsRequest.Builder avoiding the need to create one manually via ListEventsRequest.builder()

Parameters:

listEventsRequest - A Consumer that will call methods on ListEventsRequest.Builder to create a request.

Returns:

Result of the ListEvents operation returned by the service.

See Also:

• AWS API Documentation

listEventsPaginator

default ListEventsIterable listEventsPaginator(ListEventsRequest listEventsRequest)
                                        throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listEvents(software.amazon.awssdk.services.bedrockagentcore.model.ListEventsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListEventsIterable responses = client.listEventsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.ListEventsIterable responses = client
             .listEventsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.ListEventsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListEventsIterable responses = client.listEventsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listEvents(software.amazon.awssdk.services.bedrockagentcore.model.ListEventsRequest) operation.

Parameters:

listEventsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listEventsPaginator

default ListEventsIterable listEventsPaginator(Consumer<ListEventsRequest.Builder> listEventsRequest)
                                        throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listEvents(software.amazon.awssdk.services.bedrockagentcore.model.ListEventsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListEventsIterable responses = client.listEventsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.ListEventsIterable responses = client
             .listEventsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.ListEventsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListEventsIterable responses = client.listEventsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listEvents(software.amazon.awssdk.services.bedrockagentcore.model.ListEventsRequest) operation.

This is a convenience which creates an instance of the ListEventsRequest.Builder avoiding the need to create one manually via ListEventsRequest.builder()

Parameters:

listEventsRequest - A Consumer that will call methods on ListEventsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listMemoryRecords

default ListMemoryRecordsResponse listMemoryRecords(ListMemoryRecordsRequest listMemoryRecordsRequest)
                                             throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Lists memory records in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the bedrock-agentcore:ListMemoryRecords permission.

Parameters:

listMemoryRecordsRequest -

Returns:

Result of the ListMemoryRecords operation returned by the service.

See Also:

• AWS API Documentation

listMemoryRecords

default ListMemoryRecordsResponse listMemoryRecords(Consumer<ListMemoryRecordsRequest.Builder> listMemoryRecordsRequest)
                                             throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Lists memory records in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the bedrock-agentcore:ListMemoryRecords permission.

This is a convenience which creates an instance of the ListMemoryRecordsRequest.Builder avoiding the need to create one manually via ListMemoryRecordsRequest.builder()

Parameters:

listMemoryRecordsRequest - A Consumer that will call methods on ListMemoryRecordsRequest.Builder to create a request.

Returns:

Result of the ListMemoryRecords operation returned by the service.

See Also:

• AWS API Documentation

listMemoryRecordsPaginator

default ListMemoryRecordsIterable listMemoryRecordsPaginator(ListMemoryRecordsRequest listMemoryRecordsRequest)
                                                      throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryRecordsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListMemoryRecordsIterable responses = client.listMemoryRecordsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.ListMemoryRecordsIterable responses = client
             .listMemoryRecordsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryRecordsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListMemoryRecordsIterable responses = client.listMemoryRecordsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryRecordsRequest) operation.

Parameters:

listMemoryRecordsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listMemoryRecordsPaginator

default ListMemoryRecordsIterable listMemoryRecordsPaginator(Consumer<ListMemoryRecordsRequest.Builder> listMemoryRecordsRequest)
                                                      throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryRecordsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListMemoryRecordsIterable responses = client.listMemoryRecordsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.ListMemoryRecordsIterable responses = client
             .listMemoryRecordsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryRecordsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListMemoryRecordsIterable responses = client.listMemoryRecordsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryRecordsRequest) operation.

This is a convenience which creates an instance of the ListMemoryRecordsRequest.Builder avoiding the need to create one manually via ListMemoryRecordsRequest.builder()

Parameters:

listMemoryRecordsRequest - A Consumer that will call methods on ListMemoryRecordsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSessions

default ListSessionsResponse listSessions(ListSessionsRequest listSessionsRequest)
                                   throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Lists sessions in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the bedrock-agentcore:ListSessions permission.

Parameters:

listSessionsRequest -

Returns:

Result of the ListSessions operation returned by the service.

See Also:

• AWS API Documentation

listSessions

default ListSessionsResponse listSessions(Consumer<ListSessionsRequest.Builder> listSessionsRequest)
                                   throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Lists sessions in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the bedrock-agentcore:ListSessions permission.

This is a convenience which creates an instance of the ListSessionsRequest.Builder avoiding the need to create one manually via ListSessionsRequest.builder()

Parameters:

listSessionsRequest - A Consumer that will call methods on ListSessionsRequest.Builder to create a request.

Returns:

Result of the ListSessions operation returned by the service.

See Also:

• AWS API Documentation

listSessionsPaginator

default ListSessionsIterable listSessionsPaginator(ListSessionsRequest listSessionsRequest)
                                            throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listSessions(software.amazon.awssdk.services.bedrockagentcore.model.ListSessionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListSessionsIterable responses = client.listSessionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.ListSessionsIterable responses = client
             .listSessionsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.ListSessionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListSessionsIterable responses = client.listSessionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSessions(software.amazon.awssdk.services.bedrockagentcore.model.ListSessionsRequest) operation.

Parameters:

listSessionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSessionsPaginator

default ListSessionsIterable listSessionsPaginator(Consumer<ListSessionsRequest.Builder> listSessionsRequest)
                                            throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listSessions(software.amazon.awssdk.services.bedrockagentcore.model.ListSessionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListSessionsIterable responses = client.listSessionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.ListSessionsIterable responses = client
             .listSessionsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.ListSessionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListSessionsIterable responses = client.listSessionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSessions(software.amazon.awssdk.services.bedrockagentcore.model.ListSessionsRequest) operation.

This is a convenience which creates an instance of the ListSessionsRequest.Builder avoiding the need to create one manually via ListSessionsRequest.builder()

Parameters:

listSessionsRequest - A Consumer that will call methods on ListSessionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

retrieveMemoryRecords

default RetrieveMemoryRecordsResponse retrieveMemoryRecords(RetrieveMemoryRecordsRequest retrieveMemoryRecordsRequest)
                                                     throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Searches for and retrieves memory records from an AgentCore Memory resource based on specified search criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the bedrock-agentcore:RetrieveMemoryRecords permission.

Parameters:

retrieveMemoryRecordsRequest -

Returns:

Result of the RetrieveMemoryRecords operation returned by the service.

See Also:

• AWS API Documentation

retrieveMemoryRecords

default RetrieveMemoryRecordsResponse retrieveMemoryRecords(Consumer<RetrieveMemoryRecordsRequest.Builder> retrieveMemoryRecordsRequest)
                                                     throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Searches for and retrieves memory records from an AgentCore Memory resource based on specified search criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the bedrock-agentcore:RetrieveMemoryRecords permission.

This is a convenience which creates an instance of the RetrieveMemoryRecordsRequest.Builder avoiding the need to create one manually via RetrieveMemoryRecordsRequest.builder()

Parameters:

retrieveMemoryRecordsRequest - A Consumer that will call methods on RetrieveMemoryRecordsRequest.Builder to create a request.

Returns:

Result of the RetrieveMemoryRecords operation returned by the service.

See Also:

• AWS API Documentation

retrieveMemoryRecordsPaginator

default RetrieveMemoryRecordsIterable retrieveMemoryRecordsPaginator(RetrieveMemoryRecordsRequest retrieveMemoryRecordsRequest)
                                                              throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of retrieveMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.RetrieveMemoryRecordsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.RetrieveMemoryRecordsIterable responses = client.retrieveMemoryRecordsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.RetrieveMemoryRecordsIterable responses = client
             .retrieveMemoryRecordsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.RetrieveMemoryRecordsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.RetrieveMemoryRecordsIterable responses = client.retrieveMemoryRecordsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the retrieveMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.RetrieveMemoryRecordsRequest) operation.

Parameters:

retrieveMemoryRecordsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

retrieveMemoryRecordsPaginator

default RetrieveMemoryRecordsIterable retrieveMemoryRecordsPaginator(Consumer<RetrieveMemoryRecordsRequest.Builder> retrieveMemoryRecordsRequest)
                                                              throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
ThrottledException,
ServiceException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of retrieveMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.RetrieveMemoryRecordsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.RetrieveMemoryRecordsIterable responses = client.retrieveMemoryRecordsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.RetrieveMemoryRecordsIterable responses = client
             .retrieveMemoryRecordsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.RetrieveMemoryRecordsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.RetrieveMemoryRecordsIterable responses = client.retrieveMemoryRecordsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the retrieveMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.RetrieveMemoryRecordsRequest) operation.

This is a convenience which creates an instance of the RetrieveMemoryRecordsRequest.Builder avoiding the need to create one manually via RetrieveMemoryRecordsRequest.builder()

Parameters:

retrieveMemoryRecordsRequest - A Consumer that will call methods on RetrieveMemoryRecordsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

startBrowserSession

default StartBrowserSessionResponse startBrowserSession(StartBrowserSessionRequest startBrowserSessionRequest)
                                                 throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Creates and initializes a browser session in Amazon Bedrock. The session enables agents to navigate and interact with web content, extract information from websites, and perform web-based tasks as part of their response generation.

To create a session, you must specify a browser identifier and a name. You can also configure the viewport dimensions to control the visible area of web content. The session remains active until it times out or you explicitly stop it using the StopBrowserSession operation.

The following operations are related to StartBrowserSession:

• GetBrowserSession

• UpdateBrowserStream

• StopBrowserSession

Parameters:

startBrowserSessionRequest -

Returns:

Result of the StartBrowserSession operation returned by the service.

See Also:

• AWS API Documentation

startBrowserSession

default StartBrowserSessionResponse startBrowserSession(Consumer<StartBrowserSessionRequest.Builder> startBrowserSessionRequest)
                                                 throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Creates and initializes a browser session in Amazon Bedrock. The session enables agents to navigate and interact with web content, extract information from websites, and perform web-based tasks as part of their response generation.

To create a session, you must specify a browser identifier and a name. You can also configure the viewport dimensions to control the visible area of web content. The session remains active until it times out or you explicitly stop it using the StopBrowserSession operation.

The following operations are related to StartBrowserSession:

• GetBrowserSession

• UpdateBrowserStream

• StopBrowserSession

This is a convenience which creates an instance of the StartBrowserSessionRequest.Builder avoiding the need to create one manually via StartBrowserSessionRequest.builder()

Parameters:

startBrowserSessionRequest - A Consumer that will call methods on StartBrowserSessionRequest.Builder to create a request.

Returns:

Result of the StartBrowserSession operation returned by the service.

See Also:

• AWS API Documentation

startCodeInterpreterSession

default StartCodeInterpreterSessionResponse startCodeInterpreterSession(StartCodeInterpreterSessionRequest startCodeInterpreterSessionRequest)
                                                                 throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Creates and initializes a code interpreter session in Amazon Bedrock. The session enables agents to execute code as part of their response generation, supporting programming languages such as Python for data analysis, visualization, and computation tasks.

To create a session, you must specify a code interpreter identifier and a name. The session remains active until it times out or you explicitly stop it using the StopCodeInterpreterSession operation.

The following operations are related to StartCodeInterpreterSession:

• InvokeCodeInterpreter

• GetCodeInterpreterSession

• StopCodeInterpreterSession

Parameters:

startCodeInterpreterSessionRequest -

Returns:

Result of the StartCodeInterpreterSession operation returned by the service.

See Also:

• AWS API Documentation

startCodeInterpreterSession

default StartCodeInterpreterSessionResponse startCodeInterpreterSession(Consumer<StartCodeInterpreterSessionRequest.Builder> startCodeInterpreterSessionRequest)
                                                                 throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Creates and initializes a code interpreter session in Amazon Bedrock. The session enables agents to execute code as part of their response generation, supporting programming languages such as Python for data analysis, visualization, and computation tasks.

To create a session, you must specify a code interpreter identifier and a name. The session remains active until it times out or you explicitly stop it using the StopCodeInterpreterSession operation.

The following operations are related to StartCodeInterpreterSession:

• InvokeCodeInterpreter

• GetCodeInterpreterSession

• StopCodeInterpreterSession

This is a convenience which creates an instance of the StartCodeInterpreterSessionRequest.Builder avoiding the need to create one manually via StartCodeInterpreterSessionRequest.builder()

Parameters:

startCodeInterpreterSessionRequest - A Consumer that will call methods on StartCodeInterpreterSessionRequest.Builder to create a request.

Returns:

Result of the StartCodeInterpreterSession operation returned by the service.

See Also:

• AWS API Documentation

stopBrowserSession

default StopBrowserSessionResponse stopBrowserSession(StopBrowserSessionRequest stopBrowserSessionRequest)
                                               throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Terminates an active browser session in Amazon Bedrock. This operation stops the session, releases associated resources, and makes the session unavailable for further use.

To stop a browser session, you must specify both the browser identifier and the session ID. Once stopped, a session cannot be restarted; you must create a new session using StartBrowserSession.

The following operations are related to StopBrowserSession:

• StartBrowserSession

• GetBrowserSession

Parameters:

stopBrowserSessionRequest -

Returns:

Result of the StopBrowserSession operation returned by the service.

See Also:

• AWS API Documentation

stopBrowserSession

default StopBrowserSessionResponse stopBrowserSession(Consumer<StopBrowserSessionRequest.Builder> stopBrowserSessionRequest)
                                               throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Terminates an active browser session in Amazon Bedrock. This operation stops the session, releases associated resources, and makes the session unavailable for further use.

To stop a browser session, you must specify both the browser identifier and the session ID. Once stopped, a session cannot be restarted; you must create a new session using StartBrowserSession.

The following operations are related to StopBrowserSession:

• StartBrowserSession

• GetBrowserSession

This is a convenience which creates an instance of the StopBrowserSessionRequest.Builder avoiding the need to create one manually via StopBrowserSessionRequest.builder()

Parameters:

stopBrowserSessionRequest - A Consumer that will call methods on StopBrowserSessionRequest.Builder to create a request.

Returns:

Result of the StopBrowserSession operation returned by the service.

See Also:

• AWS API Documentation

stopCodeInterpreterSession

default StopCodeInterpreterSessionResponse stopCodeInterpreterSession(StopCodeInterpreterSessionRequest stopCodeInterpreterSessionRequest)
                                                               throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Terminates an active code interpreter session in Amazon Bedrock. This operation stops the session, releases associated resources, and makes the session unavailable for further use.

To stop a code interpreter session, you must specify both the code interpreter identifier and the session ID. Once stopped, a session cannot be restarted; you must create a new session using StartCodeInterpreterSession.

The following operations are related to StopCodeInterpreterSession:

• StartCodeInterpreterSession

• GetCodeInterpreterSession

Parameters:

stopCodeInterpreterSessionRequest -

Returns:

Result of the StopCodeInterpreterSession operation returned by the service.

See Also:

• AWS API Documentation

stopCodeInterpreterSession

default StopCodeInterpreterSessionResponse stopCodeInterpreterSession(Consumer<StopCodeInterpreterSessionRequest.Builder> stopCodeInterpreterSessionRequest)
                                                               throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Terminates an active code interpreter session in Amazon Bedrock. This operation stops the session, releases associated resources, and makes the session unavailable for further use.

To stop a code interpreter session, you must specify both the code interpreter identifier and the session ID. Once stopped, a session cannot be restarted; you must create a new session using StartCodeInterpreterSession.

The following operations are related to StopCodeInterpreterSession:

• StartCodeInterpreterSession

• GetCodeInterpreterSession

This is a convenience which creates an instance of the StopCodeInterpreterSessionRequest.Builder avoiding the need to create one manually via StopCodeInterpreterSessionRequest.builder()

Parameters:

stopCodeInterpreterSessionRequest - A Consumer that will call methods on StopCodeInterpreterSessionRequest.Builder to create a request.

Returns:

Result of the StopCodeInterpreterSession operation returned by the service.

See Also:

• AWS API Documentation

updateBrowserStream

default UpdateBrowserStreamResponse updateBrowserStream(UpdateBrowserStreamRequest updateBrowserStreamRequest)
                                                 throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Updates a browser stream. To use this operation, you must have permissions to perform the bedrock:UpdateBrowserStream action.

Parameters:

updateBrowserStreamRequest -

Returns:

Result of the UpdateBrowserStream operation returned by the service.

See Also:

• AWS API Documentation

updateBrowserStream

default UpdateBrowserStreamResponse updateBrowserStream(Consumer<UpdateBrowserStreamRequest.Builder> updateBrowserStreamRequest)
                                                 throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Updates a browser stream. To use this operation, you must have permissions to perform the bedrock:UpdateBrowserStream action.

This is a convenience which creates an instance of the UpdateBrowserStreamRequest.Builder avoiding the need to create one manually via UpdateBrowserStreamRequest.builder()

Parameters:

updateBrowserStreamRequest - A Consumer that will call methods on UpdateBrowserStreamRequest.Builder to create a request.

Returns:

Result of the UpdateBrowserStream operation returned by the service.

See Also:

• AWS API Documentation

create

static BedrockAgentCoreClient create()

Create a BedrockAgentCoreClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static BedrockAgentCoreClientBuilder builder()

Create a builder that can be used to configure and create a BedrockAgentCoreClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default BedrockAgentCoreServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration