Interface BedrockAgentCoreClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
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
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptiondefault BatchCreateMemoryRecordsResponsebatchCreateMemoryRecords(Consumer<BatchCreateMemoryRecordsRequest.Builder> batchCreateMemoryRecordsRequest) Creates multiple memory records in a single batch operation for the specified memory with custom content.default BatchCreateMemoryRecordsResponsebatchCreateMemoryRecords(BatchCreateMemoryRecordsRequest batchCreateMemoryRecordsRequest) Creates multiple memory records in a single batch operation for the specified memory with custom content.default BatchDeleteMemoryRecordsResponsebatchDeleteMemoryRecords(Consumer<BatchDeleteMemoryRecordsRequest.Builder> batchDeleteMemoryRecordsRequest) Deletes multiple memory records in a single batch operation from the specified memory.default BatchDeleteMemoryRecordsResponsebatchDeleteMemoryRecords(BatchDeleteMemoryRecordsRequest batchDeleteMemoryRecordsRequest) Deletes multiple memory records in a single batch operation from the specified memory.default BatchUpdateMemoryRecordsResponsebatchUpdateMemoryRecords(Consumer<BatchUpdateMemoryRecordsRequest.Builder> batchUpdateMemoryRecordsRequest) Updates multiple memory records with custom content in a single batch operation within the specified memory.default BatchUpdateMemoryRecordsResponsebatchUpdateMemoryRecords(BatchUpdateMemoryRecordsRequest batchUpdateMemoryRecordsRequest) Updates multiple memory records with custom content in a single batch operation within the specified memory.builder()Create a builder that can be used to configure and create aBedrockAgentCoreClient.completeResourceTokenAuth(Consumer<CompleteResourceTokenAuthRequest.Builder> completeResourceTokenAuthRequest) Confirms the user authentication session for obtaining OAuth2.0 tokens for a resource.completeResourceTokenAuth(CompleteResourceTokenAuthRequest completeResourceTokenAuthRequest) Confirms the user authentication session for obtaining OAuth2.0 tokens for a resource.static BedrockAgentCoreClientcreate()Create aBedrockAgentCoreClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateEventResponsecreateEvent(Consumer<CreateEventRequest.Builder> createEventRequest) Creates an event in an AgentCore Memory resource.default CreateEventResponsecreateEvent(CreateEventRequest createEventRequest) Creates an event in an AgentCore Memory resource.default DeleteEventResponsedeleteEvent(Consumer<DeleteEventRequest.Builder> deleteEventRequest) Deletes an event from an AgentCore Memory resource.default DeleteEventResponsedeleteEvent(DeleteEventRequest deleteEventRequest) Deletes an event from an AgentCore Memory resource.default DeleteMemoryRecordResponsedeleteMemoryRecord(Consumer<DeleteMemoryRecordRequest.Builder> deleteMemoryRecordRequest) Deletes a memory record from an AgentCore Memory resource.default DeleteMemoryRecordResponsedeleteMemoryRecord(DeleteMemoryRecordRequest deleteMemoryRecordRequest) Deletes a memory record from an AgentCore Memory resource.default GetAgentCardResponsegetAgentCard(Consumer<GetAgentCardRequest.Builder> getAgentCardRequest) Retrieves the A2A agent card associated with an AgentCore Runtime agent.default GetAgentCardResponsegetAgentCard(GetAgentCardRequest getAgentCardRequest) Retrieves the A2A agent card associated with an AgentCore Runtime agent.default GetBrowserSessionResponsegetBrowserSession(Consumer<GetBrowserSessionRequest.Builder> getBrowserSessionRequest) Retrieves detailed information about a specific browser session in Amazon Bedrock.default GetBrowserSessionResponsegetBrowserSession(GetBrowserSessionRequest getBrowserSessionRequest) Retrieves detailed information about a specific browser session in Amazon Bedrock.getCodeInterpreterSession(Consumer<GetCodeInterpreterSessionRequest.Builder> getCodeInterpreterSessionRequest) Retrieves detailed information about a specific code interpreter session in Amazon Bedrock.getCodeInterpreterSession(GetCodeInterpreterSessionRequest getCodeInterpreterSessionRequest) Retrieves detailed information about a specific code interpreter session in Amazon Bedrock.default GetEventResponsegetEvent(Consumer<GetEventRequest.Builder> getEventRequest) Retrieves information about a specific event in an AgentCore Memory resource.default GetEventResponsegetEvent(GetEventRequest getEventRequest) Retrieves information about a specific event in an AgentCore Memory resource.default GetMemoryRecordResponsegetMemoryRecord(Consumer<GetMemoryRecordRequest.Builder> getMemoryRecordRequest) Retrieves a specific memory record from an AgentCore Memory resource.default GetMemoryRecordResponsegetMemoryRecord(GetMemoryRecordRequest getMemoryRecordRequest) Retrieves a specific memory record from an AgentCore Memory resource.default GetResourceApiKeyResponsegetResourceApiKey(Consumer<GetResourceApiKeyRequest.Builder> getResourceApiKeyRequest) Retrieves the API key associated with an API key credential provider.default GetResourceApiKeyResponsegetResourceApiKey(GetResourceApiKeyRequest getResourceApiKeyRequest) Retrieves the API key associated with an API key credential provider.default GetResourceOauth2TokenResponsegetResourceOauth2Token(Consumer<GetResourceOauth2TokenRequest.Builder> getResourceOauth2TokenRequest) Returns the OAuth 2.0 token of the provided resource.default GetResourceOauth2TokenResponsegetResourceOauth2Token(GetResourceOauth2TokenRequest getResourceOauth2TokenRequest) Returns the OAuth 2.0 token of the provided resource.default GetWorkloadAccessTokenResponsegetWorkloadAccessToken(Consumer<GetWorkloadAccessTokenRequest.Builder> getWorkloadAccessTokenRequest) Obtains a workload access token for agentic workloads not acting on behalf of a user.default GetWorkloadAccessTokenResponsegetWorkloadAccessToken(GetWorkloadAccessTokenRequest getWorkloadAccessTokenRequest) Obtains a workload access token for agentic workloads not acting on behalf of a user.getWorkloadAccessTokenForJWT(Consumer<GetWorkloadAccessTokenForJwtRequest.Builder> getWorkloadAccessTokenForJwtRequest) Obtains a workload access token for agentic workloads acting on behalf of a user, using a JWT token.getWorkloadAccessTokenForJWT(GetWorkloadAccessTokenForJwtRequest getWorkloadAccessTokenForJwtRequest) Obtains a workload access token for agentic workloads acting on behalf of a user, using a JWT token.getWorkloadAccessTokenForUserId(Consumer<GetWorkloadAccessTokenForUserIdRequest.Builder> getWorkloadAccessTokenForUserIdRequest) Obtains a workload access token for agentic workloads acting on behalf of a user, using the user's ID.getWorkloadAccessTokenForUserId(GetWorkloadAccessTokenForUserIdRequest getWorkloadAccessTokenForUserIdRequest) Obtains a workload access token for agentic workloads acting on behalf of a user, using the user's ID.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 InvokeAgentRuntimeResponseinvokeAgentRuntime(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> ReturnTinvokeAgentRuntime(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.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 InvokeAgentRuntimeResponseinvokeAgentRuntime(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> ReturnTinvokeAgentRuntime(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 ListActorsResponselistActors(Consumer<ListActorsRequest.Builder> listActorsRequest) Lists all actors in an AgentCore Memory resource.default ListActorsResponselistActors(ListActorsRequest listActorsRequest) Lists all actors in an AgentCore Memory resource.default ListActorsIterablelistActorsPaginator(Consumer<ListActorsRequest.Builder> listActorsRequest) This is a variant oflistActors(software.amazon.awssdk.services.bedrockagentcore.model.ListActorsRequest)operation.default ListActorsIterablelistActorsPaginator(ListActorsRequest listActorsRequest) This is a variant oflistActors(software.amazon.awssdk.services.bedrockagentcore.model.ListActorsRequest)operation.default ListBrowserSessionsResponselistBrowserSessions(Consumer<ListBrowserSessionsRequest.Builder> listBrowserSessionsRequest) Retrieves a list of browser sessions in Amazon Bedrock that match the specified criteria.default ListBrowserSessionsResponselistBrowserSessions(ListBrowserSessionsRequest listBrowserSessionsRequest) Retrieves a list of browser sessions in Amazon Bedrock that match the specified criteria.listCodeInterpreterSessions(Consumer<ListCodeInterpreterSessionsRequest.Builder> listCodeInterpreterSessionsRequest) Retrieves a list of code interpreter sessions in Amazon Bedrock that match the specified criteria.listCodeInterpreterSessions(ListCodeInterpreterSessionsRequest listCodeInterpreterSessionsRequest) Retrieves a list of code interpreter sessions in Amazon Bedrock that match the specified criteria.default ListEventsResponselistEvents(Consumer<ListEventsRequest.Builder> listEventsRequest) Lists events in an AgentCore Memory resource based on specified criteria.default ListEventsResponselistEvents(ListEventsRequest listEventsRequest) Lists events in an AgentCore Memory resource based on specified criteria.default ListEventsIterablelistEventsPaginator(Consumer<ListEventsRequest.Builder> listEventsRequest) This is a variant oflistEvents(software.amazon.awssdk.services.bedrockagentcore.model.ListEventsRequest)operation.default ListEventsIterablelistEventsPaginator(ListEventsRequest listEventsRequest) This is a variant oflistEvents(software.amazon.awssdk.services.bedrockagentcore.model.ListEventsRequest)operation.default ListMemoryRecordsResponselistMemoryRecords(Consumer<ListMemoryRecordsRequest.Builder> listMemoryRecordsRequest) Lists memory records in an AgentCore Memory resource based on specified criteria.default ListMemoryRecordsResponselistMemoryRecords(ListMemoryRecordsRequest listMemoryRecordsRequest) Lists memory records in an AgentCore Memory resource based on specified criteria.default ListMemoryRecordsIterablelistMemoryRecordsPaginator(Consumer<ListMemoryRecordsRequest.Builder> listMemoryRecordsRequest) This is a variant oflistMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryRecordsRequest)operation.default ListMemoryRecordsIterablelistMemoryRecordsPaginator(ListMemoryRecordsRequest listMemoryRecordsRequest) This is a variant oflistMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryRecordsRequest)operation.default ListSessionsResponselistSessions(Consumer<ListSessionsRequest.Builder> listSessionsRequest) Lists sessions in an AgentCore Memory resource based on specified criteria.default ListSessionsResponselistSessions(ListSessionsRequest listSessionsRequest) Lists sessions in an AgentCore Memory resource based on specified criteria.default ListSessionsIterablelistSessionsPaginator(Consumer<ListSessionsRequest.Builder> listSessionsRequest) This is a variant oflistSessions(software.amazon.awssdk.services.bedrockagentcore.model.ListSessionsRequest)operation.default ListSessionsIterablelistSessionsPaginator(ListSessionsRequest listSessionsRequest) This is a variant oflistSessions(software.amazon.awssdk.services.bedrockagentcore.model.ListSessionsRequest)operation.default RetrieveMemoryRecordsResponseretrieveMemoryRecords(Consumer<RetrieveMemoryRecordsRequest.Builder> retrieveMemoryRecordsRequest) Searches for and retrieves memory records from an AgentCore Memory resource based on specified search criteria.default RetrieveMemoryRecordsResponseretrieveMemoryRecords(RetrieveMemoryRecordsRequest retrieveMemoryRecordsRequest) Searches for and retrieves memory records from an AgentCore Memory resource based on specified search criteria.default RetrieveMemoryRecordsIterableretrieveMemoryRecordsPaginator(Consumer<RetrieveMemoryRecordsRequest.Builder> retrieveMemoryRecordsRequest) This is a variant ofretrieveMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.RetrieveMemoryRecordsRequest)operation.default RetrieveMemoryRecordsIterableretrieveMemoryRecordsPaginator(RetrieveMemoryRecordsRequest retrieveMemoryRecordsRequest) This is a variant ofretrieveMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.RetrieveMemoryRecordsRequest)operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatadefault StartBrowserSessionResponsestartBrowserSession(Consumer<StartBrowserSessionRequest.Builder> startBrowserSessionRequest) Creates and initializes a browser session in Amazon Bedrock.default StartBrowserSessionResponsestartBrowserSession(StartBrowserSessionRequest startBrowserSessionRequest) Creates and initializes a browser session in Amazon Bedrock.startCodeInterpreterSession(Consumer<StartCodeInterpreterSessionRequest.Builder> startCodeInterpreterSessionRequest) Creates and initializes a code interpreter session in Amazon Bedrock.startCodeInterpreterSession(StartCodeInterpreterSessionRequest startCodeInterpreterSessionRequest) Creates and initializes a code interpreter session in Amazon Bedrock.default StopBrowserSessionResponsestopBrowserSession(Consumer<StopBrowserSessionRequest.Builder> stopBrowserSessionRequest) Terminates an active browser session in Amazon Bedrock.default StopBrowserSessionResponsestopBrowserSession(StopBrowserSessionRequest stopBrowserSessionRequest) Terminates an active browser session in Amazon Bedrock.stopCodeInterpreterSession(Consumer<StopCodeInterpreterSessionRequest.Builder> stopCodeInterpreterSessionRequest) Terminates an active code interpreter session in Amazon Bedrock.stopCodeInterpreterSession(StopCodeInterpreterSessionRequest stopCodeInterpreterSessionRequest) Terminates an active code interpreter session in Amazon Bedrock.default StopRuntimeSessionResponsestopRuntimeSession(Consumer<StopRuntimeSessionRequest.Builder> stopRuntimeSessionRequest) Stops a session that is running in an running AgentCore Runtime agent.default StopRuntimeSessionResponsestopRuntimeSession(StopRuntimeSessionRequest stopRuntimeSessionRequest) Stops a session that is running in an running AgentCore Runtime agent.default UpdateBrowserStreamResponseupdateBrowserStream(Consumer<UpdateBrowserStreamRequest.Builder> updateBrowserStreamRequest) Updates a browser stream.default UpdateBrowserStreamResponseupdateBrowserStream(UpdateBrowserStreamRequest updateBrowserStreamRequest) Updates a browser stream.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
batchCreateMemoryRecords
default BatchCreateMemoryRecordsResponse batchCreateMemoryRecords(BatchCreateMemoryRecordsRequest batchCreateMemoryRecordsRequest) throws ServiceQuotaExceededException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottledException, ServiceException, AwsServiceException, SdkClientException, BedrockAgentCoreException Creates multiple memory records in a single batch operation for the specified memory with custom content.
- Parameters:
batchCreateMemoryRecordsRequest-- Returns:
- Result of the BatchCreateMemoryRecords operation returned by the service.
- See Also:
-
batchCreateMemoryRecords
default BatchCreateMemoryRecordsResponse batchCreateMemoryRecords(Consumer<BatchCreateMemoryRecordsRequest.Builder> batchCreateMemoryRecordsRequest) throws ServiceQuotaExceededException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottledException, ServiceException, AwsServiceException, SdkClientException, BedrockAgentCoreException Creates multiple memory records in a single batch operation for the specified memory with custom content.
This is a convenience which creates an instance of the
BatchCreateMemoryRecordsRequest.Builderavoiding the need to create one manually viaBatchCreateMemoryRecordsRequest.builder()- Parameters:
batchCreateMemoryRecordsRequest- AConsumerthat will call methods onBatchCreateMemoryRecordsRequest.Builderto create a request.- Returns:
- Result of the BatchCreateMemoryRecords operation returned by the service.
- See Also:
-
batchDeleteMemoryRecords
default BatchDeleteMemoryRecordsResponse batchDeleteMemoryRecords(BatchDeleteMemoryRecordsRequest batchDeleteMemoryRecordsRequest) throws ServiceQuotaExceededException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottledException, ServiceException, AwsServiceException, SdkClientException, BedrockAgentCoreException Deletes multiple memory records in a single batch operation from the specified memory.
- Parameters:
batchDeleteMemoryRecordsRequest-- Returns:
- Result of the BatchDeleteMemoryRecords operation returned by the service.
- See Also:
-
batchDeleteMemoryRecords
default BatchDeleteMemoryRecordsResponse batchDeleteMemoryRecords(Consumer<BatchDeleteMemoryRecordsRequest.Builder> batchDeleteMemoryRecordsRequest) throws ServiceQuotaExceededException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottledException, ServiceException, AwsServiceException, SdkClientException, BedrockAgentCoreException Deletes multiple memory records in a single batch operation from the specified memory.
This is a convenience which creates an instance of the
BatchDeleteMemoryRecordsRequest.Builderavoiding the need to create one manually viaBatchDeleteMemoryRecordsRequest.builder()- Parameters:
batchDeleteMemoryRecordsRequest- AConsumerthat will call methods onBatchDeleteMemoryRecordsRequest.Builderto create a request.- Returns:
- Result of the BatchDeleteMemoryRecords operation returned by the service.
- See Also:
-
batchUpdateMemoryRecords
default BatchUpdateMemoryRecordsResponse batchUpdateMemoryRecords(BatchUpdateMemoryRecordsRequest batchUpdateMemoryRecordsRequest) throws ServiceQuotaExceededException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottledException, ServiceException, AwsServiceException, SdkClientException, BedrockAgentCoreException Updates multiple memory records with custom content in a single batch operation within the specified memory.
- Parameters:
batchUpdateMemoryRecordsRequest-- Returns:
- Result of the BatchUpdateMemoryRecords operation returned by the service.
- See Also:
-
batchUpdateMemoryRecords
default BatchUpdateMemoryRecordsResponse batchUpdateMemoryRecords(Consumer<BatchUpdateMemoryRecordsRequest.Builder> batchUpdateMemoryRecordsRequest) throws ServiceQuotaExceededException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottledException, ServiceException, AwsServiceException, SdkClientException, BedrockAgentCoreException Updates multiple memory records with custom content in a single batch operation within the specified memory.
This is a convenience which creates an instance of the
BatchUpdateMemoryRecordsRequest.Builderavoiding the need to create one manually viaBatchUpdateMemoryRecordsRequest.builder()- Parameters:
batchUpdateMemoryRecordsRequest- AConsumerthat will call methods onBatchUpdateMemoryRecordsRequest.Builderto create a request.- Returns:
- Result of the BatchUpdateMemoryRecords operation returned by the service.
- See Also:
-
completeResourceTokenAuth
default CompleteResourceTokenAuthResponse completeResourceTokenAuth(CompleteResourceTokenAuthRequest completeResourceTokenAuthRequest) throws UnauthorizedException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentCoreException Confirms the user authentication session for obtaining OAuth2.0 tokens for a resource.
- Parameters:
completeResourceTokenAuthRequest-- Returns:
- Result of the CompleteResourceTokenAuth operation returned by the service.
- See Also:
-
completeResourceTokenAuth
default CompleteResourceTokenAuthResponse completeResourceTokenAuth(Consumer<CompleteResourceTokenAuthRequest.Builder> completeResourceTokenAuthRequest) throws UnauthorizedException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentCoreException Confirms the user authentication session for obtaining OAuth2.0 tokens for a resource.
This is a convenience which creates an instance of the
CompleteResourceTokenAuthRequest.Builderavoiding the need to create one manually viaCompleteResourceTokenAuthRequest.builder()- Parameters:
completeResourceTokenAuthRequest- AConsumerthat will call methods onCompleteResourceTokenAuthRequest.Builderto create a request.- Returns:
- Result of the CompleteResourceTokenAuth operation returned by the service.
- See Also:
-
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:CreateEventpermission.This operation is subject to request rate limiting.
- Parameters:
createEventRequest-- Returns:
- Result of the CreateEvent operation returned by the service.
- See Also:
-
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:CreateEventpermission.This operation is subject to request rate limiting.
This is a convenience which creates an instance of the
CreateEventRequest.Builderavoiding the need to create one manually viaCreateEventRequest.builder()- Parameters:
createEventRequest- AConsumerthat will call methods onCreateEventRequest.Builderto create a request.- Returns:
- Result of the CreateEvent operation returned by the service.
- See Also:
-
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:DeleteEventpermission.- Parameters:
deleteEventRequest-- Returns:
- Result of the DeleteEvent operation returned by the service.
- See Also:
-
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:DeleteEventpermission.
This is a convenience which creates an instance of the
DeleteEventRequest.Builderavoiding the need to create one manually viaDeleteEventRequest.builder()- Parameters:
deleteEventRequest- AConsumerthat will call methods onDeleteEventRequest.Builderto create a request.- Returns:
- Result of the DeleteEvent operation returned by the service.
- See Also:
-
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:DeleteMemoryRecordpermission.- Parameters:
deleteMemoryRecordRequest-- Returns:
- Result of the DeleteMemoryRecord operation returned by the service.
- See Also:
-
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:DeleteMemoryRecordpermission.
This is a convenience which creates an instance of the
DeleteMemoryRecordRequest.Builderavoiding the need to create one manually viaDeleteMemoryRecordRequest.builder()- Parameters:
deleteMemoryRecordRequest- AConsumerthat will call methods onDeleteMemoryRecordRequest.Builderto create a request.- Returns:
- Result of the DeleteMemoryRecord operation returned by the service.
- See Also:
-
getAgentCard
default GetAgentCardResponse getAgentCard(GetAgentCardRequest getAgentCardRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, RuntimeClientErrorException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentCoreException Retrieves the A2A agent card associated with an AgentCore Runtime agent.
- Parameters:
getAgentCardRequest-- Returns:
- Result of the GetAgentCard operation returned by the service.
- See Also:
-
getAgentCard
default GetAgentCardResponse getAgentCard(Consumer<GetAgentCardRequest.Builder> getAgentCardRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, RuntimeClientErrorException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentCoreException Retrieves the A2A agent card associated with an AgentCore Runtime agent.
This is a convenience which creates an instance of the
GetAgentCardRequest.Builderavoiding the need to create one manually viaGetAgentCardRequest.builder()- Parameters:
getAgentCardRequest- AConsumerthat will call methods onGetAgentCardRequest.Builderto create a request.- Returns:
- Result of the GetAgentCard operation returned by the service.
- See Also:
-
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:- Parameters:
getBrowserSessionRequest-- Returns:
- Result of the GetBrowserSession operation returned by the service.
- See Also:
-
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:
This is a convenience which creates an instance of the
GetBrowserSessionRequest.Builderavoiding the need to create one manually viaGetBrowserSessionRequest.builder()- Parameters:
getBrowserSessionRequest- AConsumerthat will call methods onGetBrowserSessionRequest.Builderto create a request.- Returns:
- Result of the GetBrowserSession operation returned by the service.
- See Also:
-
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:- Parameters:
getCodeInterpreterSessionRequest-- Returns:
- Result of the GetCodeInterpreterSession operation returned by the service.
- See Also:
-
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:
This is a convenience which creates an instance of the
GetCodeInterpreterSessionRequest.Builderavoiding the need to create one manually viaGetCodeInterpreterSessionRequest.builder()- Parameters:
getCodeInterpreterSessionRequest- AConsumerthat will call methods onGetCodeInterpreterSessionRequest.Builderto create a request.- Returns:
- Result of the GetCodeInterpreterSession operation returned by the service.
- See Also:
-
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:GetEventpermission.- Parameters:
getEventRequest-- Returns:
- Result of the GetEvent operation returned by the service.
- See Also:
-
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:GetEventpermission.
This is a convenience which creates an instance of the
GetEventRequest.Builderavoiding the need to create one manually viaGetEventRequest.builder()- Parameters:
getEventRequest- AConsumerthat will call methods onGetEventRequest.Builderto create a request.- Returns:
- Result of the GetEvent operation returned by the service.
- See Also:
-
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:GetMemoryRecordpermission.- Parameters:
getMemoryRecordRequest-- Returns:
- Result of the GetMemoryRecord operation returned by the service.
- See Also:
-
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:GetMemoryRecordpermission.
This is a convenience which creates an instance of the
GetMemoryRecordRequest.Builderavoiding the need to create one manually viaGetMemoryRecordRequest.builder()- Parameters:
getMemoryRecordRequest- AConsumerthat will call methods onGetMemoryRecordRequest.Builderto create a request.- Returns:
- Result of the GetMemoryRecord operation returned by the service.
- See Also:
-
getResourceApiKey
default GetResourceApiKeyResponse getResourceApiKey(GetResourceApiKeyRequest getResourceApiKeyRequest) throws UnauthorizedException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentCoreException Retrieves the API key associated with an API key credential provider.
- Parameters:
getResourceApiKeyRequest-- Returns:
- Result of the GetResourceApiKey operation returned by the service.
- See Also:
-
getResourceApiKey
default GetResourceApiKeyResponse getResourceApiKey(Consumer<GetResourceApiKeyRequest.Builder> getResourceApiKeyRequest) throws UnauthorizedException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentCoreException Retrieves the API key associated with an API key credential provider.
This is a convenience which creates an instance of the
GetResourceApiKeyRequest.Builderavoiding the need to create one manually viaGetResourceApiKeyRequest.builder()- Parameters:
getResourceApiKeyRequest- AConsumerthat will call methods onGetResourceApiKeyRequest.Builderto create a request.- Returns:
- Result of the GetResourceApiKey operation returned by the service.
- See Also:
-
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:
-
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.Builderavoiding the need to create one manually viaGetResourceOauth2TokenRequest.builder()- Parameters:
getResourceOauth2TokenRequest- AConsumerthat will call methods onGetResourceOauth2TokenRequest.Builderto create a request.- Returns:
- Result of the GetResourceOauth2Token operation returned by the service.
- See Also:
-
getWorkloadAccessToken
default GetWorkloadAccessTokenResponse getWorkloadAccessToken(GetWorkloadAccessTokenRequest getWorkloadAccessTokenRequest) throws UnauthorizedException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentCoreException Obtains a workload access token for agentic workloads not acting on behalf of a user.
- Parameters:
getWorkloadAccessTokenRequest-- Returns:
- Result of the GetWorkloadAccessToken operation returned by the service.
- See Also:
-
getWorkloadAccessToken
default GetWorkloadAccessTokenResponse getWorkloadAccessToken(Consumer<GetWorkloadAccessTokenRequest.Builder> getWorkloadAccessTokenRequest) throws UnauthorizedException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentCoreException Obtains a workload access token for agentic workloads not acting on behalf of a user.
This is a convenience which creates an instance of the
GetWorkloadAccessTokenRequest.Builderavoiding the need to create one manually viaGetWorkloadAccessTokenRequest.builder()- Parameters:
getWorkloadAccessTokenRequest- AConsumerthat will call methods onGetWorkloadAccessTokenRequest.Builderto create a request.- Returns:
- Result of the GetWorkloadAccessToken operation returned by the service.
- See Also:
-
getWorkloadAccessTokenForJWT
default GetWorkloadAccessTokenForJwtResponse getWorkloadAccessTokenForJWT(GetWorkloadAccessTokenForJwtRequest getWorkloadAccessTokenForJwtRequest) throws UnauthorizedException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentCoreException Obtains a workload access token for agentic workloads acting on behalf of a user, using a JWT token.
- Parameters:
getWorkloadAccessTokenForJwtRequest-- Returns:
- Result of the GetWorkloadAccessTokenForJWT operation returned by the service.
- See Also:
-
getWorkloadAccessTokenForJWT
default GetWorkloadAccessTokenForJwtResponse getWorkloadAccessTokenForJWT(Consumer<GetWorkloadAccessTokenForJwtRequest.Builder> getWorkloadAccessTokenForJwtRequest) throws UnauthorizedException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentCoreException Obtains a workload access token for agentic workloads acting on behalf of a user, using a JWT token.
This is a convenience which creates an instance of the
GetWorkloadAccessTokenForJwtRequest.Builderavoiding the need to create one manually viaGetWorkloadAccessTokenForJwtRequest.builder()- Parameters:
getWorkloadAccessTokenForJwtRequest- AConsumerthat will call methods onGetWorkloadAccessTokenForJwtRequest.Builderto create a request.- Returns:
- Result of the GetWorkloadAccessTokenForJWT operation returned by the service.
- See Also:
-
getWorkloadAccessTokenForUserId
default GetWorkloadAccessTokenForUserIdResponse getWorkloadAccessTokenForUserId(GetWorkloadAccessTokenForUserIdRequest getWorkloadAccessTokenForUserIdRequest) throws UnauthorizedException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentCoreException Obtains a workload access token for agentic workloads acting on behalf of a user, using the user's ID.
- Parameters:
getWorkloadAccessTokenForUserIdRequest-- Returns:
- Result of the GetWorkloadAccessTokenForUserId operation returned by the service.
- See Also:
-
getWorkloadAccessTokenForUserId
default GetWorkloadAccessTokenForUserIdResponse getWorkloadAccessTokenForUserId(Consumer<GetWorkloadAccessTokenForUserIdRequest.Builder> getWorkloadAccessTokenForUserIdRequest) throws UnauthorizedException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentCoreException Obtains a workload access token for agentic workloads acting on behalf of a user, using the user's ID.
This is a convenience which creates an instance of the
GetWorkloadAccessTokenForUserIdRequest.Builderavoiding the need to create one manually viaGetWorkloadAccessTokenForUserIdRequest.builder()- Parameters:
getWorkloadAccessTokenForUserIdRequest- AConsumerthat will call methods onGetWorkloadAccessTokenForUserIdRequest.Builderto create a request.- Returns:
- Result of the GetWorkloadAccessTokenForUserId operation returned by the service.
- See Also:
-
invokeAgentRuntime
default <ReturnT> ReturnT invokeAgentRuntime(InvokeAgentRuntimeRequest invokeAgentRuntimeRequest, ResponseTransformer<InvokeAgentRuntimeResponse, ReturnT> responseTransformer) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, RuntimeClientErrorException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentCoreExceptionSends 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 toInvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.To use this operation, you must have the
bedrock-agentcore:InvokeAgentRuntimepermission. If you are making a call toInvokeAgentRuntimeon behalf of a user ID with theX-Amzn-Bedrock-AgentCore-Runtime-User-Idheader, You require permissions to both actions (bedrock-agentcore:InvokeAgentRuntimeandbedrock-agentcore:InvokeAgentRuntimeForUser).- 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. SeeResponseTransformerfor 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:
-
invokeAgentRuntime
default <ReturnT> ReturnT invokeAgentRuntime(Consumer<InvokeAgentRuntimeRequest.Builder> invokeAgentRuntimeRequest, ResponseTransformer<InvokeAgentRuntimeResponse, ReturnT> responseTransformer) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, RuntimeClientErrorException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentCoreExceptionSends 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 toInvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.To use this operation, you must have the
bedrock-agentcore:InvokeAgentRuntimepermission. If you are making a call toInvokeAgentRuntimeon behalf of a user ID with theX-Amzn-Bedrock-AgentCore-Runtime-User-Idheader, You require permissions to both actions (bedrock-agentcore:InvokeAgentRuntimeandbedrock-agentcore:InvokeAgentRuntimeForUser).
This is a convenience which creates an instance of the
InvokeAgentRuntimeRequest.Builderavoiding the need to create one manually viaInvokeAgentRuntimeRequest.builder()- Parameters:
invokeAgentRuntimeRequest- AConsumerthat will call methods onInvokeAgentRuntimeRequest.Builderto 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. SeeResponseTransformerfor 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:
-
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 toInvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.To use this operation, you must have the
bedrock-agentcore:InvokeAgentRuntimepermission. If you are making a call toInvokeAgentRuntimeon behalf of a user ID with theX-Amzn-Bedrock-AgentCore-Runtime-User-Idheader, You require permissions to both actions (bedrock-agentcore:InvokeAgentRuntimeandbedrock-agentcore:InvokeAgentRuntimeForUser).- Parameters:
invokeAgentRuntimeRequest-destinationPath-Pathto 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
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 toInvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.To use this operation, you must have the
bedrock-agentcore:InvokeAgentRuntimepermission. If you are making a call toInvokeAgentRuntimeon behalf of a user ID with theX-Amzn-Bedrock-AgentCore-Runtime-User-Idheader, You require permissions to both actions (bedrock-agentcore:InvokeAgentRuntimeandbedrock-agentcore:InvokeAgentRuntimeForUser).
This is a convenience which creates an instance of the
InvokeAgentRuntimeRequest.Builderavoiding the need to create one manually viaInvokeAgentRuntimeRequest.builder()- Parameters:
invokeAgentRuntimeRequest- AConsumerthat will call methods onInvokeAgentRuntimeRequest.Builderto create a request.destinationPath-Pathto 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
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 toInvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.To use this operation, you must have the
bedrock-agentcore:InvokeAgentRuntimepermission. If you are making a call toInvokeAgentRuntimeon behalf of a user ID with theX-Amzn-Bedrock-AgentCore-Runtime-User-Idheader, You require permissions to both actions (bedrock-agentcore:InvokeAgentRuntimeandbedrock-agentcore:InvokeAgentRuntimeForUser).- Parameters:
invokeAgentRuntimeRequest-- Returns:
- A
ResponseInputStreamcontaining 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 viaResponseInputStream.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:
-
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 toInvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.To use this operation, you must have the
bedrock-agentcore:InvokeAgentRuntimepermission. If you are making a call toInvokeAgentRuntimeon behalf of a user ID with theX-Amzn-Bedrock-AgentCore-Runtime-User-Idheader, You require permissions to both actions (bedrock-agentcore:InvokeAgentRuntimeandbedrock-agentcore:InvokeAgentRuntimeForUser).
This is a convenience which creates an instance of the
InvokeAgentRuntimeRequest.Builderavoiding the need to create one manually viaInvokeAgentRuntimeRequest.builder()- Parameters:
invokeAgentRuntimeRequest- AConsumerthat will call methods onInvokeAgentRuntimeRequest.Builderto create a request.- Returns:
- A
ResponseInputStreamcontaining 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 viaResponseInputStream.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:
-
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 toInvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.To use this operation, you must have the
bedrock-agentcore:InvokeAgentRuntimepermission. If you are making a call toInvokeAgentRuntimeon behalf of a user ID with theX-Amzn-Bedrock-AgentCore-Runtime-User-Idheader, You require permissions to both actions (bedrock-agentcore:InvokeAgentRuntimeandbedrock-agentcore:InvokeAgentRuntimeForUser).- Parameters:
invokeAgentRuntimeRequest-- Returns:
- A
ResponseBytesthat 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 viaResponseBytes.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:
-
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 toInvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.To use this operation, you must have the
bedrock-agentcore:InvokeAgentRuntimepermission. If you are making a call toInvokeAgentRuntimeon behalf of a user ID with theX-Amzn-Bedrock-AgentCore-Runtime-User-Idheader, You require permissions to both actions (bedrock-agentcore:InvokeAgentRuntimeandbedrock-agentcore:InvokeAgentRuntimeForUser).
This is a convenience which creates an instance of the
InvokeAgentRuntimeRequest.Builderavoiding the need to create one manually viaInvokeAgentRuntimeRequest.builder()- Parameters:
invokeAgentRuntimeRequest- AConsumerthat will call methods onInvokeAgentRuntimeRequest.Builderto create a request.- Returns:
- A
ResponseBytesthat 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 viaResponseBytes.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:
-
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:ListActorspermission.- Parameters:
listActorsRequest-- Returns:
- Result of the ListActors operation returned by the service.
- See Also:
-
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:ListActorspermission.
This is a convenience which creates an instance of the
ListActorsRequest.Builderavoiding the need to create one manually viaListActorsRequest.builder()- Parameters:
listActorsRequest- AConsumerthat will call methods onListActorsRequest.Builderto create a request.- Returns:
- Result of the ListActors operation returned by the service.
- See Also:
-
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
2) Using For loopsoftware.amazon.awssdk.services.bedrockagentcore.paginators.ListActorsIterable responses = client.listActorsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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:
-
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
2) Using For loopsoftware.amazon.awssdk.services.bedrockagentcore.paginators.ListActorsIterable responses = client.listActorsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListActorsRequest.builder()- Parameters:
listActorsRequest- AConsumerthat will call methods onListActorsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:- Parameters:
listBrowserSessionsRequest-- Returns:
- Result of the ListBrowserSessions operation returned by the service.
- See Also:
-
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:
This is a convenience which creates an instance of the
ListBrowserSessionsRequest.Builderavoiding the need to create one manually viaListBrowserSessionsRequest.builder()- Parameters:
listBrowserSessionsRequest- AConsumerthat will call methods onListBrowserSessionsRequest.Builderto create a request.- Returns:
- Result of the ListBrowserSessions operation returned by the service.
- See Also:
-
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:- Parameters:
listCodeInterpreterSessionsRequest-- Returns:
- Result of the ListCodeInterpreterSessions operation returned by the service.
- See Also:
-
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:
This is a convenience which creates an instance of the
ListCodeInterpreterSessionsRequest.Builderavoiding the need to create one manually viaListCodeInterpreterSessionsRequest.builder()- Parameters:
listCodeInterpreterSessionsRequest- AConsumerthat will call methods onListCodeInterpreterSessionsRequest.Builderto create a request.- Returns:
- Result of the ListCodeInterpreterSessions operation returned by the service.
- See Also:
-
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:ListEventspermission.- Parameters:
listEventsRequest-- Returns:
- Result of the ListEvents operation returned by the service.
- See Also:
-
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:ListEventspermission.
This is a convenience which creates an instance of the
ListEventsRequest.Builderavoiding the need to create one manually viaListEventsRequest.builder()- Parameters:
listEventsRequest- AConsumerthat will call methods onListEventsRequest.Builderto create a request.- Returns:
- Result of the ListEvents operation returned by the service.
- See Also:
-
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
2) Using For loopsoftware.amazon.awssdk.services.bedrockagentcore.paginators.ListEventsIterable responses = client.listEventsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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:
-
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
2) Using For loopsoftware.amazon.awssdk.services.bedrockagentcore.paginators.ListEventsIterable responses = client.listEventsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListEventsRequest.builder()- Parameters:
listEventsRequest- AConsumerthat will call methods onListEventsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:ListMemoryRecordspermission.- Parameters:
listMemoryRecordsRequest-- Returns:
- Result of the ListMemoryRecords operation returned by the service.
- See Also:
-
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:ListMemoryRecordspermission.
This is a convenience which creates an instance of the
ListMemoryRecordsRequest.Builderavoiding the need to create one manually viaListMemoryRecordsRequest.builder()- Parameters:
listMemoryRecordsRequest- AConsumerthat will call methods onListMemoryRecordsRequest.Builderto create a request.- Returns:
- Result of the ListMemoryRecords operation returned by the service.
- See Also:
-
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
2) Using For loopsoftware.amazon.awssdk.services.bedrockagentcore.paginators.ListMemoryRecordsIterable responses = client.listMemoryRecordsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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:
-
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
2) Using For loopsoftware.amazon.awssdk.services.bedrockagentcore.paginators.ListMemoryRecordsIterable responses = client.listMemoryRecordsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListMemoryRecordsRequest.builder()- Parameters:
listMemoryRecordsRequest- AConsumerthat will call methods onListMemoryRecordsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:ListSessionspermission.- Parameters:
listSessionsRequest-- Returns:
- Result of the ListSessions operation returned by the service.
- See Also:
-
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:ListSessionspermission.
This is a convenience which creates an instance of the
ListSessionsRequest.Builderavoiding the need to create one manually viaListSessionsRequest.builder()- Parameters:
listSessionsRequest- AConsumerthat will call methods onListSessionsRequest.Builderto create a request.- Returns:
- Result of the ListSessions operation returned by the service.
- See Also:
-
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
2) Using For loopsoftware.amazon.awssdk.services.bedrockagentcore.paginators.ListSessionsIterable responses = client.listSessionsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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:
-
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
2) Using For loopsoftware.amazon.awssdk.services.bedrockagentcore.paginators.ListSessionsIterable responses = client.listSessionsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListSessionsRequest.builder()- Parameters:
listSessionsRequest- AConsumerthat will call methods onListSessionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:RetrieveMemoryRecordspermission.- Parameters:
retrieveMemoryRecordsRequest-- Returns:
- Result of the RetrieveMemoryRecords operation returned by the service.
- See Also:
-
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:RetrieveMemoryRecordspermission.
This is a convenience which creates an instance of the
RetrieveMemoryRecordsRequest.Builderavoiding the need to create one manually viaRetrieveMemoryRecordsRequest.builder()- Parameters:
retrieveMemoryRecordsRequest- AConsumerthat will call methods onRetrieveMemoryRecordsRequest.Builderto create a request.- Returns:
- Result of the RetrieveMemoryRecords operation returned by the service.
- See Also:
-
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
2) Using For loopsoftware.amazon.awssdk.services.bedrockagentcore.paginators.RetrieveMemoryRecordsIterable responses = client.retrieveMemoryRecordsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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:
-
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
2) Using For loopsoftware.amazon.awssdk.services.bedrockagentcore.paginators.RetrieveMemoryRecordsIterable responses = client.retrieveMemoryRecordsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaRetrieveMemoryRecordsRequest.builder()- Parameters:
retrieveMemoryRecordsRequest- AConsumerthat will call methods onRetrieveMemoryRecordsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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
StopBrowserSessionoperation.The following operations are related to
StartBrowserSession:- Parameters:
startBrowserSessionRequest-- Returns:
- Result of the StartBrowserSession operation returned by the service.
- See Also:
-
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
StopBrowserSessionoperation.The following operations are related to
StartBrowserSession:
This is a convenience which creates an instance of the
StartBrowserSessionRequest.Builderavoiding the need to create one manually viaStartBrowserSessionRequest.builder()- Parameters:
startBrowserSessionRequest- AConsumerthat will call methods onStartBrowserSessionRequest.Builderto create a request.- Returns:
- Result of the StartBrowserSession operation returned by the service.
- See Also:
-
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
StopCodeInterpreterSessionoperation.The following operations are related to
StartCodeInterpreterSession:- Parameters:
startCodeInterpreterSessionRequest-- Returns:
- Result of the StartCodeInterpreterSession operation returned by the service.
- See Also:
-
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
StopCodeInterpreterSessionoperation.The following operations are related to
StartCodeInterpreterSession:
This is a convenience which creates an instance of the
StartCodeInterpreterSessionRequest.Builderavoiding the need to create one manually viaStartCodeInterpreterSessionRequest.builder()- Parameters:
startCodeInterpreterSessionRequest- AConsumerthat will call methods onStartCodeInterpreterSessionRequest.Builderto create a request.- Returns:
- Result of the StartCodeInterpreterSession operation returned by the service.
- See Also:
-
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:- Parameters:
stopBrowserSessionRequest-- Returns:
- Result of the StopBrowserSession operation returned by the service.
- See Also:
-
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:
This is a convenience which creates an instance of the
StopBrowserSessionRequest.Builderavoiding the need to create one manually viaStopBrowserSessionRequest.builder()- Parameters:
stopBrowserSessionRequest- AConsumerthat will call methods onStopBrowserSessionRequest.Builderto create a request.- Returns:
- Result of the StopBrowserSession operation returned by the service.
- See Also:
-
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:- Parameters:
stopCodeInterpreterSessionRequest-- Returns:
- Result of the StopCodeInterpreterSession operation returned by the service.
- See Also:
-
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:
This is a convenience which creates an instance of the
StopCodeInterpreterSessionRequest.Builderavoiding the need to create one manually viaStopCodeInterpreterSessionRequest.builder()- Parameters:
stopCodeInterpreterSessionRequest- AConsumerthat will call methods onStopCodeInterpreterSessionRequest.Builderto create a request.- Returns:
- Result of the StopCodeInterpreterSession operation returned by the service.
- See Also:
-
stopRuntimeSession
default StopRuntimeSessionResponse stopRuntimeSession(StopRuntimeSessionRequest stopRuntimeSessionRequest) throws ServiceQuotaExceededException, UnauthorizedException, ValidationException, AccessDeniedException, ConflictException, RuntimeClientErrorException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentCoreException Stops a session that is running in an running AgentCore Runtime agent.
- Parameters:
stopRuntimeSessionRequest-- Returns:
- Result of the StopRuntimeSession operation returned by the service.
- See Also:
-
stopRuntimeSession
default StopRuntimeSessionResponse stopRuntimeSession(Consumer<StopRuntimeSessionRequest.Builder> stopRuntimeSessionRequest) throws ServiceQuotaExceededException, UnauthorizedException, ValidationException, AccessDeniedException, ConflictException, RuntimeClientErrorException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentCoreException Stops a session that is running in an running AgentCore Runtime agent.
This is a convenience which creates an instance of the
StopRuntimeSessionRequest.Builderavoiding the need to create one manually viaStopRuntimeSessionRequest.builder()- Parameters:
stopRuntimeSessionRequest- AConsumerthat will call methods onStopRuntimeSessionRequest.Builderto create a request.- Returns:
- Result of the StopRuntimeSession operation returned by the service.
- See Also:
-
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:
-
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.Builderavoiding the need to create one manually viaUpdateBrowserStreamRequest.builder()- Parameters:
updateBrowserStreamRequest- AConsumerthat will call methods onUpdateBrowserStreamRequest.Builderto create a request.- Returns:
- Result of the UpdateBrowserStream operation returned by the service.
- See Also:
-
create
Create aBedrockAgentCoreClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aBedrockAgentCoreClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-