Skip to content

BedrockAgentCoreDataPlaneFrontingLayerClient#

Index > BedrockAgentCoreDataPlaneFrontingLayer > BedrockAgentCoreDataPlaneFrontingLayerClient

Auto-generated documentation for BedrockAgentCoreDataPlaneFrontingLayer type annotations stubs module mypy-boto3-bedrock-agentcore.

BedrockAgentCoreDataPlaneFrontingLayerClient#

Type annotations and code completion for boto3.client("bedrock-agentcore"). boto3 documentation

# BedrockAgentCoreDataPlaneFrontingLayerClient usage example

from boto3.session import Session
from mypy_boto3_bedrock_agentcore.client import BedrockAgentCoreDataPlaneFrontingLayerClient

def get_bedrock-agentcore_client() -> BedrockAgentCoreDataPlaneFrontingLayerClient:
    return Session().client("bedrock-agentcore")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("bedrock-agentcore").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("bedrock-agentcore")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.InvalidInputException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.RuntimeClientError,
    client.exceptions.ServiceException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottledException,
    client.exceptions.ThrottlingException,
    client.exceptions.UnauthorizedException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_bedrock_agentcore.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("bedrock-agentcore").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("bedrock-agentcore").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

create_event#

Creates an event in a memory store.

Type annotations and code completion for boto3.client("bedrock-agentcore").create_event method. boto3 documentation

# create_event method definition

def create_event(
    self,
    *,
    memoryId: str,
    actorId: str,
    eventTimestamp: TimestampTypeDef,
    payload: Sequence[PayloadTypeUnionTypeDef],  # (1)
    sessionId: str = ...,
    branch: BranchTypeDef = ...,  # (2)
    clientToken: str = ...,
) -> CreateEventOutputTypeDef:  # (3)
    ...
  1. See Sequence[PayloadTypeUnionTypeDef]
  2. See BranchTypeDef
  3. See CreateEventOutputTypeDef
# create_event method usage example with argument unpacking

kwargs: CreateEventInputTypeDef = {  # (1)
    "memoryId": ...,
    "actorId": ...,
    "eventTimestamp": ...,
    "payload": ...,
}

parent.create_event(**kwargs)
  1. See CreateEventInputTypeDef

delete_event#

Deletes an event from a memory store.

Type annotations and code completion for boto3.client("bedrock-agentcore").delete_event method. boto3 documentation

# delete_event method definition

def delete_event(
    self,
    *,
    memoryId: str,
    sessionId: str,
    eventId: str,
    actorId: str,
) -> DeleteEventOutputTypeDef:  # (1)
    ...
  1. See DeleteEventOutputTypeDef
# delete_event method usage example with argument unpacking

kwargs: DeleteEventInputTypeDef = {  # (1)
    "memoryId": ...,
    "sessionId": ...,
    "eventId": ...,
    "actorId": ...,
}

parent.delete_event(**kwargs)
  1. See DeleteEventInputTypeDef

delete_memory_record#

Deletes a memory record from a memory store.

Type annotations and code completion for boto3.client("bedrock-agentcore").delete_memory_record method. boto3 documentation

# delete_memory_record method definition

def delete_memory_record(
    self,
    *,
    memoryId: str,
    memoryRecordId: str,
) -> DeleteMemoryRecordOutputTypeDef:  # (1)
    ...
  1. See DeleteMemoryRecordOutputTypeDef
# delete_memory_record method usage example with argument unpacking

kwargs: DeleteMemoryRecordInputTypeDef = {  # (1)
    "memoryId": ...,
    "memoryRecordId": ...,
}

parent.delete_memory_record(**kwargs)
  1. See DeleteMemoryRecordInputTypeDef

get_browser_session#

Retrieves detailed information about a specific browser session in Amazon Bedrock.

Type annotations and code completion for boto3.client("bedrock-agentcore").get_browser_session method. boto3 documentation

# get_browser_session method definition

def get_browser_session(
    self,
    *,
    browserIdentifier: str,
    sessionId: str,
) -> GetBrowserSessionResponseTypeDef:  # (1)
    ...
  1. See GetBrowserSessionResponseTypeDef
# get_browser_session method usage example with argument unpacking

kwargs: GetBrowserSessionRequestTypeDef = {  # (1)
    "browserIdentifier": ...,
    "sessionId": ...,
}

parent.get_browser_session(**kwargs)
  1. See GetBrowserSessionRequestTypeDef

get_code_interpreter_session#

Retrieves detailed information about a specific code interpreter session in Amazon Bedrock.

Type annotations and code completion for boto3.client("bedrock-agentcore").get_code_interpreter_session method. boto3 documentation

# get_code_interpreter_session method definition

def get_code_interpreter_session(
    self,
    *,
    codeInterpreterIdentifier: str,
    sessionId: str,
) -> GetCodeInterpreterSessionResponseTypeDef:  # (1)
    ...
  1. See GetCodeInterpreterSessionResponseTypeDef
# get_code_interpreter_session method usage example with argument unpacking

kwargs: GetCodeInterpreterSessionRequestTypeDef = {  # (1)
    "codeInterpreterIdentifier": ...,
    "sessionId": ...,
}

parent.get_code_interpreter_session(**kwargs)
  1. See GetCodeInterpreterSessionRequestTypeDef

get_event#

Retrieves information about a specific event in a memory store.

Type annotations and code completion for boto3.client("bedrock-agentcore").get_event method. boto3 documentation

# get_event method definition

def get_event(
    self,
    *,
    memoryId: str,
    sessionId: str,
    actorId: str,
    eventId: str,
) -> GetEventOutputTypeDef:  # (1)
    ...
  1. See GetEventOutputTypeDef
# get_event method usage example with argument unpacking

kwargs: GetEventInputTypeDef = {  # (1)
    "memoryId": ...,
    "sessionId": ...,
    "actorId": ...,
    "eventId": ...,
}

parent.get_event(**kwargs)
  1. See GetEventInputTypeDef

get_memory_record#

Retrieves a specific memory record from a memory store.

Type annotations and code completion for boto3.client("bedrock-agentcore").get_memory_record method. boto3 documentation

# get_memory_record method definition

def get_memory_record(
    self,
    *,
    memoryId: str,
    memoryRecordId: str,
) -> GetMemoryRecordOutputTypeDef:  # (1)
    ...
  1. See GetMemoryRecordOutputTypeDef
# get_memory_record method usage example with argument unpacking

kwargs: GetMemoryRecordInputTypeDef = {  # (1)
    "memoryId": ...,
    "memoryRecordId": ...,
}

parent.get_memory_record(**kwargs)
  1. See GetMemoryRecordInputTypeDef

get_resource_api_key#

Retrieves an API Key associated with an API Key Credential Provider.

Type annotations and code completion for boto3.client("bedrock-agentcore").get_resource_api_key method. boto3 documentation

# get_resource_api_key method definition

def get_resource_api_key(
    self,
    *,
    workloadIdentityToken: str,
    resourceCredentialProviderName: str,
) -> GetResourceApiKeyResponseTypeDef:  # (1)
    ...
  1. See GetResourceApiKeyResponseTypeDef
# get_resource_api_key method usage example with argument unpacking

kwargs: GetResourceApiKeyRequestTypeDef = {  # (1)
    "workloadIdentityToken": ...,
    "resourceCredentialProviderName": ...,
}

parent.get_resource_api_key(**kwargs)
  1. See GetResourceApiKeyRequestTypeDef

get_resource_oauth2_token#

Reaturns the Oauth2Token of the provided resource.

Type annotations and code completion for boto3.client("bedrock-agentcore").get_resource_oauth2_token method. boto3 documentation

# get_resource_oauth2_token method definition

def get_resource_oauth2_token(
    self,
    *,
    workloadIdentityToken: str,
    resourceCredentialProviderName: str,
    scopes: Sequence[str],
    oauth2Flow: Oauth2FlowTypeType,  # (1)
    userId: str = ...,
    resourceOauth2ReturnUrl: str = ...,
    forceAuthentication: bool = ...,
    customParameters: Mapping[str, str] = ...,
) -> GetResourceOauth2TokenResponseTypeDef:  # (2)
    ...
  1. See Oauth2FlowTypeType
  2. See GetResourceOauth2TokenResponseTypeDef
# get_resource_oauth2_token method usage example with argument unpacking

kwargs: GetResourceOauth2TokenRequestTypeDef = {  # (1)
    "workloadIdentityToken": ...,
    "resourceCredentialProviderName": ...,
    "scopes": ...,
    "oauth2Flow": ...,
}

parent.get_resource_oauth2_token(**kwargs)
  1. See GetResourceOauth2TokenRequestTypeDef

get_workload_access_token#

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

Type annotations and code completion for boto3.client("bedrock-agentcore").get_workload_access_token method. boto3 documentation

# get_workload_access_token method definition

def get_workload_access_token(
    self,
    *,
    workloadName: str,
) -> GetWorkloadAccessTokenResponseTypeDef:  # (1)
    ...
  1. See GetWorkloadAccessTokenResponseTypeDef
# get_workload_access_token method usage example with argument unpacking

kwargs: GetWorkloadAccessTokenRequestTypeDef = {  # (1)
    "workloadName": ...,
}

parent.get_workload_access_token(**kwargs)
  1. See GetWorkloadAccessTokenRequestTypeDef

get_workload_access_token_for_jwt#

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

Type annotations and code completion for boto3.client("bedrock-agentcore").get_workload_access_token_for_jwt method. boto3 documentation

# get_workload_access_token_for_jwt method definition

def get_workload_access_token_for_jwt(
    self,
    *,
    workloadName: str,
    userToken: str,
) -> GetWorkloadAccessTokenForJWTResponseTypeDef:  # (1)
    ...
  1. See GetWorkloadAccessTokenForJWTResponseTypeDef
# get_workload_access_token_for_jwt method usage example with argument unpacking

kwargs: GetWorkloadAccessTokenForJWTRequestTypeDef = {  # (1)
    "workloadName": ...,
    "userToken": ...,
}

parent.get_workload_access_token_for_jwt(**kwargs)
  1. See GetWorkloadAccessTokenForJWTRequestTypeDef

get_workload_access_token_for_user_id#

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

Type annotations and code completion for boto3.client("bedrock-agentcore").get_workload_access_token_for_user_id method. boto3 documentation

# get_workload_access_token_for_user_id method definition

def get_workload_access_token_for_user_id(
    self,
    *,
    workloadName: str,
    userId: str,
) -> GetWorkloadAccessTokenForUserIdResponseTypeDef:  # (1)
    ...
  1. See GetWorkloadAccessTokenForUserIdResponseTypeDef
# get_workload_access_token_for_user_id method usage example with argument unpacking

kwargs: GetWorkloadAccessTokenForUserIdRequestTypeDef = {  # (1)
    "workloadName": ...,
    "userId": ...,
}

parent.get_workload_access_token_for_user_id(**kwargs)
  1. See GetWorkloadAccessTokenForUserIdRequestTypeDef

invoke_agent_runtime#

Sends a request to an agent runtime in Amazon Bedrock and receives responses in real-time.

Type annotations and code completion for boto3.client("bedrock-agentcore").invoke_agent_runtime method. boto3 documentation

# invoke_agent_runtime method definition

def invoke_agent_runtime(
    self,
    *,
    agentRuntimeArn: str,
    payload: BlobTypeDef,
    contentType: str = ...,
    accept: str = ...,
    mcpSessionId: str = ...,
    runtimeSessionId: str = ...,
    mcpProtocolVersion: str = ...,
    runtimeUserId: str = ...,
    traceId: str = ...,
    traceParent: str = ...,
    traceState: str = ...,
    baggage: str = ...,
    qualifier: str = ...,
) -> InvokeAgentRuntimeResponseTypeDef:  # (1)
    ...
  1. See InvokeAgentRuntimeResponseTypeDef
# invoke_agent_runtime method usage example with argument unpacking

kwargs: InvokeAgentRuntimeRequestTypeDef = {  # (1)
    "agentRuntimeArn": ...,
    "payload": ...,
}

parent.invoke_agent_runtime(**kwargs)
  1. See InvokeAgentRuntimeRequestTypeDef

invoke_code_interpreter#

Executes code within an active code interpreter session in Amazon Bedrock.

Type annotations and code completion for boto3.client("bedrock-agentcore").invoke_code_interpreter method. boto3 documentation

# invoke_code_interpreter method definition

def invoke_code_interpreter(
    self,
    *,
    codeInterpreterIdentifier: str,
    name: ToolNameType,  # (1)
    sessionId: str = ...,
    arguments: ToolArgumentsTypeDef = ...,  # (2)
) -> InvokeCodeInterpreterResponseTypeDef:  # (3)
    ...
  1. See ToolNameType
  2. See ToolArgumentsTypeDef
  3. See InvokeCodeInterpreterResponseTypeDef
# invoke_code_interpreter method usage example with argument unpacking

kwargs: InvokeCodeInterpreterRequestTypeDef = {  # (1)
    "codeInterpreterIdentifier": ...,
    "name": ...,
}

parent.invoke_code_interpreter(**kwargs)
  1. See InvokeCodeInterpreterRequestTypeDef

list_actors#

Lists all actors in a memory store.

Type annotations and code completion for boto3.client("bedrock-agentcore").list_actors method. boto3 documentation

# list_actors method definition

def list_actors(
    self,
    *,
    memoryId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListActorsOutputTypeDef:  # (1)
    ...
  1. See ListActorsOutputTypeDef
# list_actors method usage example with argument unpacking

kwargs: ListActorsInputTypeDef = {  # (1)
    "memoryId": ...,
}

parent.list_actors(**kwargs)
  1. See ListActorsInputTypeDef

list_browser_sessions#

Retrieves a list of browser sessions in Amazon Bedrock that match the specified criteria.

Type annotations and code completion for boto3.client("bedrock-agentcore").list_browser_sessions method. boto3 documentation

# list_browser_sessions method definition

def list_browser_sessions(
    self,
    *,
    browserIdentifier: str,
    maxResults: int = ...,
    nextToken: str = ...,
    status: BrowserSessionStatusType = ...,  # (1)
) -> ListBrowserSessionsResponseTypeDef:  # (2)
    ...
  1. See BrowserSessionStatusType
  2. See ListBrowserSessionsResponseTypeDef
# list_browser_sessions method usage example with argument unpacking

kwargs: ListBrowserSessionsRequestTypeDef = {  # (1)
    "browserIdentifier": ...,
}

parent.list_browser_sessions(**kwargs)
  1. See ListBrowserSessionsRequestTypeDef

list_code_interpreter_sessions#

Retrieves a list of code interpreter sessions in Amazon Bedrock that match the specified criteria.

Type annotations and code completion for boto3.client("bedrock-agentcore").list_code_interpreter_sessions method. boto3 documentation

# list_code_interpreter_sessions method definition

def list_code_interpreter_sessions(
    self,
    *,
    codeInterpreterIdentifier: str,
    maxResults: int = ...,
    nextToken: str = ...,
    status: CodeInterpreterSessionStatusType = ...,  # (1)
) -> ListCodeInterpreterSessionsResponseTypeDef:  # (2)
    ...
  1. See CodeInterpreterSessionStatusType
  2. See ListCodeInterpreterSessionsResponseTypeDef
# list_code_interpreter_sessions method usage example with argument unpacking

kwargs: ListCodeInterpreterSessionsRequestTypeDef = {  # (1)
    "codeInterpreterIdentifier": ...,
}

parent.list_code_interpreter_sessions(**kwargs)
  1. See ListCodeInterpreterSessionsRequestTypeDef

list_events#

Lists events in a memory store based on specified criteria.

Type annotations and code completion for boto3.client("bedrock-agentcore").list_events method. boto3 documentation

# list_events method definition

def list_events(
    self,
    *,
    memoryId: str,
    sessionId: str,
    actorId: str,
    includePayloads: bool = ...,
    filter: FilterInputTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListEventsOutputTypeDef:  # (2)
    ...
  1. See FilterInputTypeDef
  2. See ListEventsOutputTypeDef
# list_events method usage example with argument unpacking

kwargs: ListEventsInputTypeDef = {  # (1)
    "memoryId": ...,
    "sessionId": ...,
    "actorId": ...,
}

parent.list_events(**kwargs)
  1. See ListEventsInputTypeDef

list_memory_records#

Lists memory records in a memory store based on specified criteria.

Type annotations and code completion for boto3.client("bedrock-agentcore").list_memory_records method. boto3 documentation

# list_memory_records method definition

def list_memory_records(
    self,
    *,
    memoryId: str,
    namespace: str,
    memoryStrategyId: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListMemoryRecordsOutputTypeDef:  # (1)
    ...
  1. See ListMemoryRecordsOutputTypeDef
# list_memory_records method usage example with argument unpacking

kwargs: ListMemoryRecordsInputTypeDef = {  # (1)
    "memoryId": ...,
    "namespace": ...,
}

parent.list_memory_records(**kwargs)
  1. See ListMemoryRecordsInputTypeDef

list_sessions#

Lists sessions in a memory store based on specified criteria.

Type annotations and code completion for boto3.client("bedrock-agentcore").list_sessions method. boto3 documentation

# list_sessions method definition

def list_sessions(
    self,
    *,
    memoryId: str,
    actorId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListSessionsOutputTypeDef:  # (1)
    ...
  1. See ListSessionsOutputTypeDef
# list_sessions method usage example with argument unpacking

kwargs: ListSessionsInputTypeDef = {  # (1)
    "memoryId": ...,
    "actorId": ...,
}

parent.list_sessions(**kwargs)
  1. See ListSessionsInputTypeDef

retrieve_memory_records#

Searches for and retrieves memory records from a memory store based on specified search criteria.

Type annotations and code completion for boto3.client("bedrock-agentcore").retrieve_memory_records method. boto3 documentation

# retrieve_memory_records method definition

def retrieve_memory_records(
    self,
    *,
    memoryId: str,
    namespace: str,
    searchCriteria: SearchCriteriaTypeDef,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> RetrieveMemoryRecordsOutputTypeDef:  # (2)
    ...
  1. See SearchCriteriaTypeDef
  2. See RetrieveMemoryRecordsOutputTypeDef
# retrieve_memory_records method usage example with argument unpacking

kwargs: RetrieveMemoryRecordsInputTypeDef = {  # (1)
    "memoryId": ...,
    "namespace": ...,
    "searchCriteria": ...,
}

parent.retrieve_memory_records(**kwargs)
  1. See RetrieveMemoryRecordsInputTypeDef

start_browser_session#

Creates and initializes a browser session in Amazon Bedrock.

Type annotations and code completion for boto3.client("bedrock-agentcore").start_browser_session method. boto3 documentation

# start_browser_session method definition

def start_browser_session(
    self,
    *,
    browserIdentifier: str,
    name: str = ...,
    sessionTimeoutSeconds: int = ...,
    viewPort: ViewPortTypeDef = ...,  # (1)
    clientToken: str = ...,
) -> StartBrowserSessionResponseTypeDef:  # (2)
    ...
  1. See ViewPortTypeDef
  2. See StartBrowserSessionResponseTypeDef
# start_browser_session method usage example with argument unpacking

kwargs: StartBrowserSessionRequestTypeDef = {  # (1)
    "browserIdentifier": ...,
}

parent.start_browser_session(**kwargs)
  1. See StartBrowserSessionRequestTypeDef

start_code_interpreter_session#

Creates and initializes a code interpreter session in Amazon Bedrock.

Type annotations and code completion for boto3.client("bedrock-agentcore").start_code_interpreter_session method. boto3 documentation

# start_code_interpreter_session method definition

def start_code_interpreter_session(
    self,
    *,
    codeInterpreterIdentifier: str,
    name: str = ...,
    sessionTimeoutSeconds: int = ...,
    clientToken: str = ...,
) -> StartCodeInterpreterSessionResponseTypeDef:  # (1)
    ...
  1. See StartCodeInterpreterSessionResponseTypeDef
# start_code_interpreter_session method usage example with argument unpacking

kwargs: StartCodeInterpreterSessionRequestTypeDef = {  # (1)
    "codeInterpreterIdentifier": ...,
}

parent.start_code_interpreter_session(**kwargs)
  1. See StartCodeInterpreterSessionRequestTypeDef

stop_browser_session#

Terminates an active browser session in Amazon Bedrock.

Type annotations and code completion for boto3.client("bedrock-agentcore").stop_browser_session method. boto3 documentation

# stop_browser_session method definition

def stop_browser_session(
    self,
    *,
    browserIdentifier: str,
    sessionId: str,
    clientToken: str = ...,
) -> StopBrowserSessionResponseTypeDef:  # (1)
    ...
  1. See StopBrowserSessionResponseTypeDef
# stop_browser_session method usage example with argument unpacking

kwargs: StopBrowserSessionRequestTypeDef = {  # (1)
    "browserIdentifier": ...,
    "sessionId": ...,
}

parent.stop_browser_session(**kwargs)
  1. See StopBrowserSessionRequestTypeDef

stop_code_interpreter_session#

Terminates an active code interpreter session in Amazon Bedrock.

Type annotations and code completion for boto3.client("bedrock-agentcore").stop_code_interpreter_session method. boto3 documentation

# stop_code_interpreter_session method definition

def stop_code_interpreter_session(
    self,
    *,
    codeInterpreterIdentifier: str,
    sessionId: str,
    clientToken: str = ...,
) -> StopCodeInterpreterSessionResponseTypeDef:  # (1)
    ...
  1. See StopCodeInterpreterSessionResponseTypeDef
# stop_code_interpreter_session method usage example with argument unpacking

kwargs: StopCodeInterpreterSessionRequestTypeDef = {  # (1)
    "codeInterpreterIdentifier": ...,
    "sessionId": ...,
}

parent.stop_code_interpreter_session(**kwargs)
  1. See StopCodeInterpreterSessionRequestTypeDef

update_browser_stream#

Updates a browser stream.

Type annotations and code completion for boto3.client("bedrock-agentcore").update_browser_stream method. boto3 documentation

# update_browser_stream method definition

def update_browser_stream(
    self,
    *,
    browserIdentifier: str,
    sessionId: str,
    streamUpdate: StreamUpdateTypeDef,  # (1)
    clientToken: str = ...,
) -> UpdateBrowserStreamResponseTypeDef:  # (2)
    ...
  1. See StreamUpdateTypeDef
  2. See UpdateBrowserStreamResponseTypeDef
# update_browser_stream method usage example with argument unpacking

kwargs: UpdateBrowserStreamRequestTypeDef = {  # (1)
    "browserIdentifier": ...,
    "sessionId": ...,
    "streamUpdate": ...,
}

parent.update_browser_stream(**kwargs)
  1. See UpdateBrowserStreamRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("bedrock-agentcore").get_paginator method with overloads.