BedrockAgentCoreClient

Index > BedrockAgentCore > BedrockAgentCoreClient

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

BedrockAgentCoreClient

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

# BedrockAgentCoreClient usage example

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

def get_bedrock-agentcore_client() -> BedrockAgentCoreClient:
    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.DuplicateIdException,
    client.exceptions.InternalServerException,
    client.exceptions.InvalidInputException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.RetryableConflictException,
    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:
    ...

batch_create_memory_records

Creates multiple memory records in a single batch operation for the specified memory with custom content.

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

# batch_create_memory_records method definition

def batch_create_memory_records(
    self,
    *,
    memoryId: str,
    records: Sequence[MemoryRecordCreateInputTypeDef],  # (1)
    clientToken: str = ...,
) -> BatchCreateMemoryRecordsOutputTypeDef:  # (2)
    ...

1. See Sequence[MemoryRecordCreateInputTypeDef]
2. See BatchCreateMemoryRecordsOutputTypeDef

# batch_create_memory_records method usage example with argument unpacking

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

parent.batch_create_memory_records(**kwargs)

1. See BatchCreateMemoryRecordsInputTypeDef

batch_delete_memory_records

Deletes multiple memory records in a single batch operation from the specified memory.

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

# batch_delete_memory_records method definition

def batch_delete_memory_records(
    self,
    *,
    memoryId: str,
    records: Sequence[MemoryRecordDeleteInputTypeDef],  # (1)
) -> BatchDeleteMemoryRecordsOutputTypeDef:  # (2)
    ...

1. See Sequence[MemoryRecordDeleteInputTypeDef]
2. See BatchDeleteMemoryRecordsOutputTypeDef

# batch_delete_memory_records method usage example with argument unpacking

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

parent.batch_delete_memory_records(**kwargs)

1. See BatchDeleteMemoryRecordsInputTypeDef

batch_update_memory_records

Updates multiple memory records with custom content in a single batch operation within the specified memory.

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

# batch_update_memory_records method definition

def batch_update_memory_records(
    self,
    *,
    memoryId: str,
    records: Sequence[MemoryRecordUpdateInputTypeDef],  # (1)
) -> BatchUpdateMemoryRecordsOutputTypeDef:  # (2)
    ...

1. See Sequence[MemoryRecordUpdateInputTypeDef]
2. See BatchUpdateMemoryRecordsOutputTypeDef

# batch_update_memory_records method usage example with argument unpacking

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

parent.batch_update_memory_records(**kwargs)

1. See BatchUpdateMemoryRecordsInputTypeDef

complete_resource_token_auth

Confirms the user authentication session for obtaining OAuth2.0 tokens for a resource.

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

# complete_resource_token_auth method definition

def complete_resource_token_auth(
    self,
    *,
    userIdentifier: UserIdentifierTypeDef,  # (1)
    sessionUri: str,
) -> dict[str, Any]:
    ...

1. See UserIdentifierTypeDef

# complete_resource_token_auth method usage example with argument unpacking

kwargs: CompleteResourceTokenAuthRequestTypeDef = {  # (1)
    "userIdentifier": ...,
    "sessionUri": ...,
}

parent.complete_resource_token_auth(**kwargs)

1. See CompleteResourceTokenAuthRequestTypeDef

create_ab_test

Creates an A/B test for comparing agent configurations.

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

# create_ab_test method definition

def create_ab_test(
    self,
    *,
    name: str,
    gatewayArn: str,
    variants: Sequence[VariantTypeDef],  # (1)
    evaluationConfig: ABTestEvaluationConfigUnionTypeDef,  # (2)
    roleArn: str,
    description: str = ...,
    gatewayFilter: GatewayFilterUnionTypeDef = ...,  # (3)
    enableOnCreate: bool = ...,
    clientToken: str = ...,
) -> CreateABTestResponseTypeDef:  # (4)
    ...

1. See Sequence[VariantTypeDef]
2. See ABTestEvaluationConfigUnionTypeDef
3. See GatewayFilterUnionTypeDef
4. See CreateABTestResponseTypeDef

# create_ab_test method usage example with argument unpacking

kwargs: CreateABTestRequestTypeDef = {  # (1)
    "name": ...,
    "gatewayArn": ...,
    "variants": ...,
    "evaluationConfig": ...,
    "roleArn": ...,
}

parent.create_ab_test(**kwargs)

1. See CreateABTestRequestTypeDef

create_event

Creates an event in an AgentCore Memory resource.

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 = ...,
    metadata: Mapping[str, MetadataValueTypeDef] = ...,  # (3)
) -> CreateEventOutputTypeDef:  # (4)
    ...

1. See Sequence[PayloadTypeUnionTypeDef]
2. See BranchTypeDef
3. See Mapping[str, MetadataValueTypeDef]
4. See CreateEventOutputTypeDef

# create_event method usage example with argument unpacking

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

parent.create_event(**kwargs)

1. See CreateEventInputTypeDef

create_payment_instrument

Create a new payment instrument for a connector.

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

# create_payment_instrument method definition

def create_payment_instrument(
    self,
    *,
    paymentManagerArn: str,
    paymentConnectorId: str,
    paymentInstrumentType: PaymentInstrumentTypeType,  # (1)
    paymentInstrumentDetails: PaymentInstrumentDetailsUnionTypeDef,  # (2)
    userId: str = ...,
    agentName: str = ...,
    clientToken: str = ...,
) -> CreatePaymentInstrumentResponseTypeDef:  # (3)
    ...

1. See PaymentInstrumentTypeType
2. See PaymentInstrumentDetailsUnionTypeDef
3. See CreatePaymentInstrumentResponseTypeDef

# create_payment_instrument method usage example with argument unpacking

kwargs: CreatePaymentInstrumentRequestTypeDef = {  # (1)
    "paymentManagerArn": ...,
    "paymentConnectorId": ...,
    "paymentInstrumentType": ...,
    "paymentInstrumentDetails": ...,
}

parent.create_payment_instrument(**kwargs)

1. See CreatePaymentInstrumentRequestTypeDef

create_payment_session

Create a new payment manager session.

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

# create_payment_session method definition

def create_payment_session(
    self,
    *,
    paymentManagerArn: str,
    expiryTimeInMinutes: int,
    userId: str = ...,
    agentName: str = ...,
    limits: SessionLimitsTypeDef = ...,  # (1)
    clientToken: str = ...,
) -> CreatePaymentSessionResponseTypeDef:  # (2)
    ...

1. See SessionLimitsTypeDef
2. See CreatePaymentSessionResponseTypeDef

# create_payment_session method usage example with argument unpacking

kwargs: CreatePaymentSessionRequestTypeDef = {  # (1)
    "paymentManagerArn": ...,
    "expiryTimeInMinutes": ...,
}

parent.create_payment_session(**kwargs)

1. See CreatePaymentSessionRequestTypeDef

delete_ab_test

Deletes an A/B test and its associated gateway rules.

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

# delete_ab_test method definition

def delete_ab_test(
    self,
    *,
    abTestId: str,
) -> DeleteABTestResponseTypeDef:  # (1)
    ...

1. See DeleteABTestResponseTypeDef

# delete_ab_test method usage example with argument unpacking

kwargs: DeleteABTestRequestTypeDef = {  # (1)
    "abTestId": ...,
}

parent.delete_ab_test(**kwargs)

1. See DeleteABTestRequestTypeDef

delete_batch_evaluation

Deletes a batch evaluation and its associated results.

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

# delete_batch_evaluation method definition

def delete_batch_evaluation(
    self,
    *,
    batchEvaluationId: str,
) -> DeleteBatchEvaluationResponseTypeDef:  # (1)
    ...

1. See DeleteBatchEvaluationResponseTypeDef

# delete_batch_evaluation method usage example with argument unpacking

kwargs: DeleteBatchEvaluationRequestTypeDef = {  # (1)
    "batchEvaluationId": ...,
}

parent.delete_batch_evaluation(**kwargs)

1. See DeleteBatchEvaluationRequestTypeDef

delete_event

Deletes an event from an AgentCore Memory resource.

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 an AgentCore Memory resource.

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

delete_payment_instrument

Delete a payment instrument.

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

# delete_payment_instrument method definition

def delete_payment_instrument(
    self,
    *,
    paymentManagerArn: str,
    paymentConnectorId: str,
    paymentInstrumentId: str,
    userId: str = ...,
) -> DeletePaymentInstrumentResponseTypeDef:  # (1)
    ...

1. See DeletePaymentInstrumentResponseTypeDef

# delete_payment_instrument method usage example with argument unpacking

kwargs: DeletePaymentInstrumentRequestTypeDef = {  # (1)
    "paymentManagerArn": ...,
    "paymentConnectorId": ...,
    "paymentInstrumentId": ...,
}

parent.delete_payment_instrument(**kwargs)

1. See DeletePaymentInstrumentRequestTypeDef

delete_payment_session

Delete a payment manager session.

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

# delete_payment_session method definition

def delete_payment_session(
    self,
    *,
    paymentManagerArn: str,
    paymentSessionId: str,
    userId: str = ...,
) -> DeletePaymentSessionResponseTypeDef:  # (1)
    ...

1. See DeletePaymentSessionResponseTypeDef

# delete_payment_session method usage example with argument unpacking

kwargs: DeletePaymentSessionRequestTypeDef = {  # (1)
    "paymentManagerArn": ...,
    "paymentSessionId": ...,
}

parent.delete_payment_session(**kwargs)

1. See DeletePaymentSessionRequestTypeDef

delete_recommendation

Deletes a recommendation and its associated results.

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

# delete_recommendation method definition

def delete_recommendation(
    self,
    *,
    recommendationId: str,
) -> DeleteRecommendationResponseTypeDef:  # (1)
    ...

1. See DeleteRecommendationResponseTypeDef

# delete_recommendation method usage example with argument unpacking

kwargs: DeleteRecommendationRequestTypeDef = {  # (1)
    "recommendationId": ...,
}

parent.delete_recommendation(**kwargs)

1. See DeleteRecommendationRequestTypeDef

evaluate

Performs on-demand evaluation of agent traces using a specified evaluator.

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

# evaluate method definition

def evaluate(
    self,
    *,
    evaluatorId: str,
    evaluationInput: EvaluationInputTypeDef,  # (1)
    evaluationTarget: EvaluationTargetTypeDef = ...,  # (2)
    evaluationReferenceInputs: Sequence[EvaluationReferenceInputTypeDef] = ...,  # (3)
) -> EvaluateResponseTypeDef:  # (4)
    ...

1. See EvaluationInputTypeDef
2. See EvaluationTargetTypeDef
3. See Sequence[EvaluationReferenceInputTypeDef]
4. See EvaluateResponseTypeDef

# evaluate method usage example with argument unpacking

kwargs: EvaluateRequestTypeDef = {  # (1)
    "evaluatorId": ...,
    "evaluationInput": ...,
}

parent.evaluate(**kwargs)

1. See EvaluateRequestTypeDef

get_ab_test

Retrieves detailed information about an A/B test, including its configuration, status, and statistical results.

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

# get_ab_test method definition

def get_ab_test(
    self,
    *,
    abTestId: str,
) -> GetABTestResponseTypeDef:  # (1)
    ...

1. See GetABTestResponseTypeDef

# get_ab_test method usage example with argument unpacking

kwargs: GetABTestRequestTypeDef = {  # (1)
    "abTestId": ...,
}

parent.get_ab_test(**kwargs)

1. See GetABTestRequestTypeDef

get_agent_card

Retrieves the A2A agent card associated with an AgentCore Runtime agent.

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

# get_agent_card method definition

def get_agent_card(
    self,
    *,
    agentRuntimeArn: str,
    runtimeSessionId: str = ...,
    qualifier: str = ...,
) -> GetAgentCardResponseTypeDef:  # (1)
    ...

1. See GetAgentCardResponseTypeDef

# get_agent_card method usage example with argument unpacking

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

parent.get_agent_card(**kwargs)

1. See GetAgentCardRequestTypeDef

get_batch_evaluation

Retrieves detailed information about a batch evaluation, including its status, configuration, results, and any error details.

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

# get_batch_evaluation method definition

def get_batch_evaluation(
    self,
    *,
    batchEvaluationId: str,
) -> GetBatchEvaluationResponseTypeDef:  # (1)
    ...

1. See GetBatchEvaluationResponseTypeDef

# get_batch_evaluation method usage example with argument unpacking

kwargs: GetBatchEvaluationRequestTypeDef = {  # (1)
    "batchEvaluationId": ...,
}

parent.get_batch_evaluation(**kwargs)

1. See GetBatchEvaluationRequestTypeDef

get_browser_session

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

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 AgentCore.

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 an AgentCore Memory resource.

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 an AgentCore Memory resource.

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_payment_instrument

Get a payment instrument by ID.

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

# get_payment_instrument method definition

def get_payment_instrument(
    self,
    *,
    paymentManagerArn: str,
    paymentInstrumentId: str,
    userId: str = ...,
    agentName: str = ...,
    paymentConnectorId: str = ...,
) -> GetPaymentInstrumentResponseTypeDef:  # (1)
    ...

1. See GetPaymentInstrumentResponseTypeDef

# get_payment_instrument method usage example with argument unpacking

kwargs: GetPaymentInstrumentRequestTypeDef = {  # (1)
    "paymentManagerArn": ...,
    "paymentInstrumentId": ...,
}

parent.get_payment_instrument(**kwargs)

1. See GetPaymentInstrumentRequestTypeDef

get_payment_instrument_balance

Get the balance of a payment instrument.

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

# get_payment_instrument_balance method definition

def get_payment_instrument_balance(
    self,
    *,
    paymentManagerArn: str,
    paymentConnectorId: str,
    paymentInstrumentId: str,
    chain: BlockchainChainIdType,  # (1)
    token: InstrumentBalanceTokenType,  # (2)
    userId: str = ...,
    agentName: str = ...,
) -> GetPaymentInstrumentBalanceResponseTypeDef:  # (3)
    ...

1. See BlockchainChainIdType
2. See InstrumentBalanceTokenType
3. See GetPaymentInstrumentBalanceResponseTypeDef

# get_payment_instrument_balance method usage example with argument unpacking

kwargs: GetPaymentInstrumentBalanceRequestTypeDef = {  # (1)
    "paymentManagerArn": ...,
    "paymentConnectorId": ...,
    "paymentInstrumentId": ...,
    "chain": ...,
    "token": ...,
}

parent.get_payment_instrument_balance(**kwargs)

1. See GetPaymentInstrumentBalanceRequestTypeDef

get_payment_session

Get a payment session.

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

# get_payment_session method definition

def get_payment_session(
    self,
    *,
    paymentManagerArn: str,
    paymentSessionId: str,
    userId: str = ...,
    agentName: str = ...,
) -> GetPaymentSessionResponseTypeDef:  # (1)
    ...

1. See GetPaymentSessionResponseTypeDef

# get_payment_session method usage example with argument unpacking

kwargs: GetPaymentSessionRequestTypeDef = {  # (1)
    "paymentManagerArn": ...,
    "paymentSessionId": ...,
}

parent.get_payment_session(**kwargs)

1. See GetPaymentSessionRequestTypeDef

get_recommendation

Retrieves detailed information about a recommendation, including its configuration, status, and results.

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

# get_recommendation method definition

def get_recommendation(
    self,
    *,
    recommendationId: str,
) -> GetRecommendationResponseTypeDef:  # (1)
    ...

1. See GetRecommendationResponseTypeDef

# get_recommendation method usage example with argument unpacking

kwargs: GetRecommendationRequestTypeDef = {  # (1)
    "recommendationId": ...,
}

parent.get_recommendation(**kwargs)

1. See GetRecommendationRequestTypeDef

get_resource_api_key

Retrieves the 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

Returns the OAuth 2.0 token 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)
    sessionUri: str = ...,
    resourceOauth2ReturnUrl: str = ...,
    forceAuthentication: bool = ...,
    customParameters: Mapping[str, str] = ...,
    customState: str = ...,
    resources: Sequence[str] = ...,
    audiences: Sequence[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_resource_payment_token

Generates authentication tokens for payment providers that use vendor-specific authentication mechanisms.

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

# get_resource_payment_token method definition

def get_resource_payment_token(
    self,
    *,
    workloadIdentityToken: str,
    resourceCredentialProviderName: str,
    paymentTokenRequest: PaymentTokenRequestInputTypeDef,  # (1)
) -> GetResourcePaymentTokenResponseTypeDef:  # (2)
    ...

1. See PaymentTokenRequestInputTypeDef
2. See GetResourcePaymentTokenResponseTypeDef

# get_resource_payment_token method usage example with argument unpacking

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

parent.get_resource_payment_token(**kwargs)

1. See GetResourcePaymentTokenRequestTypeDef

get_workload_access_token

Obtains a workload access token for agentic workloads not acting on behalf of a 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 a workload access token for agentic workloads acting on behalf of a user, using a 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 a workload access token for agentic workloads acting on behalf of a user, using the user's 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 or tool hosted in an Amazon Bedrock AgentCore Runtime 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 = ...,
    accountId: 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_agent_runtime_command

Executes a command in a runtime session container and streams the output back to the caller.

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

# invoke_agent_runtime_command method definition

def invoke_agent_runtime_command(
    self,
    *,
    agentRuntimeArn: str,
    body: InvokeAgentRuntimeCommandRequestBodyTypeDef,  # (1)
    contentType: str = ...,
    accept: str = ...,
    runtimeSessionId: str = ...,
    traceId: str = ...,
    traceParent: str = ...,
    traceState: str = ...,
    baggage: str = ...,
    qualifier: str = ...,
    accountId: str = ...,
) -> InvokeAgentRuntimeCommandResponseTypeDef:  # (2)
    ...

1. See InvokeAgentRuntimeCommandRequestBodyTypeDef
2. See InvokeAgentRuntimeCommandResponseTypeDef

# invoke_agent_runtime_command method usage example with argument unpacking

kwargs: InvokeAgentRuntimeCommandRequestTypeDef = {  # (1)
    "agentRuntimeArn": ...,
    "body": ...,
}

parent.invoke_agent_runtime_command(**kwargs)

1. See InvokeAgentRuntimeCommandRequestTypeDef

invoke_browser

Invokes an operating system-level action on a browser session in Amazon Bedrock AgentCore.

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

# invoke_browser method definition

def invoke_browser(
    self,
    *,
    browserIdentifier: str,
    sessionId: str,
    action: BrowserActionTypeDef,  # (1)
) -> InvokeBrowserResponseTypeDef:  # (2)
    ...

1. See BrowserActionTypeDef
2. See InvokeBrowserResponseTypeDef

# invoke_browser method usage example with argument unpacking

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

parent.invoke_browser(**kwargs)

1. See InvokeBrowserRequestTypeDef

invoke_code_interpreter

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

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 = ...,
    traceId: str = ...,
    traceParent: 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

invoke_harness

Operation to invoke a Harness.

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

# invoke_harness method definition

def invoke_harness(
    self,
    *,
    harnessArn: str,
    runtimeSessionId: str,
    messages: Sequence[HarnessMessageTypeDef],  # (1)
    model: HarnessModelConfigurationTypeDef = ...,  # (2)
    systemPrompt: Sequence[HarnessSystemContentBlockTypeDef] = ...,  # (3)
    tools: Sequence[HarnessToolTypeDef] = ...,  # (4)
    skills: Sequence[HarnessSkillTypeDef] = ...,  # (5)
    allowedTools: Sequence[str] = ...,
    maxIterations: int = ...,
    maxTokens: int = ...,
    timeoutSeconds: int = ...,
    actorId: str = ...,
) -> InvokeHarnessResponseTypeDef:  # (6)
    ...

1. See Sequence[HarnessMessageTypeDef]
2. See HarnessModelConfigurationTypeDef
3. See Sequence[HarnessSystemContentBlockTypeDef]
4. See Sequence[HarnessToolTypeDef]
5. See Sequence[HarnessSkillTypeDef]
6. See InvokeHarnessResponseTypeDef

# invoke_harness method usage example with argument unpacking

kwargs: InvokeHarnessRequestTypeDef = {  # (1)
    "harnessArn": ...,
    "runtimeSessionId": ...,
    "messages": ...,
}

parent.invoke_harness(**kwargs)

1. See InvokeHarnessRequestTypeDef

list_ab_tests

Lists all A/B tests in the account.

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

# list_ab_tests method definition

def list_ab_tests(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListABTestsResponseTypeDef:  # (1)
    ...

1. See ListABTestsResponseTypeDef

# list_ab_tests method usage example with argument unpacking

kwargs: ListABTestsRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_ab_tests(**kwargs)

1. See ListABTestsRequestTypeDef

list_actors

Lists all actors in an AgentCore Memory resource.

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_batch_evaluations

Lists all batch evaluations in the account, providing summary information about each evaluation's status and configuration.

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

# list_batch_evaluations method definition

def list_batch_evaluations(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListBatchEvaluationsResponseTypeDef:  # (1)
    ...

1. See ListBatchEvaluationsResponseTypeDef

# list_batch_evaluations method usage example with argument unpacking

kwargs: ListBatchEvaluationsRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_batch_evaluations(**kwargs)

1. See ListBatchEvaluationsRequestTypeDef

list_browser_sessions

Retrieves a list of browser sessions in Amazon Bedrock AgentCore 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 AgentCore 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 an AgentCore Memory resource 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_extraction_jobs

Lists all long-term memory extraction jobs that are eligible to be started with optional filtering.

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

# list_memory_extraction_jobs method definition

def list_memory_extraction_jobs(
    self,
    *,
    memoryId: str,
    maxResults: int = ...,
    filter: ExtractionJobFilterInputTypeDef = ...,  # (1)
    nextToken: str = ...,
) -> ListMemoryExtractionJobsOutputTypeDef:  # (2)
    ...

1. See ExtractionJobFilterInputTypeDef
2. See ListMemoryExtractionJobsOutputTypeDef

# list_memory_extraction_jobs method usage example with argument unpacking

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

parent.list_memory_extraction_jobs(**kwargs)

1. See ListMemoryExtractionJobsInputTypeDef

list_memory_records

Lists memory records in an AgentCore Memory resource 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 = ...,
    namespacePath: str = ...,
    memoryStrategyId: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
    metadataFilters: Sequence[MemoryMetadataFilterExpressionTypeDef] = ...,  # (1)
) -> ListMemoryRecordsOutputTypeDef:  # (2)
    ...

1. See Sequence[MemoryMetadataFilterExpressionTypeDef]
2. See ListMemoryRecordsOutputTypeDef

# list_memory_records method usage example with argument unpacking

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

parent.list_memory_records(**kwargs)

1. See ListMemoryRecordsInputTypeDef

list_payment_instruments

List payment instruments for a manager.

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

# list_payment_instruments method definition

def list_payment_instruments(
    self,
    *,
    paymentManagerArn: str,
    userId: str = ...,
    agentName: str = ...,
    paymentConnectorId: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListPaymentInstrumentsResponseTypeDef:  # (1)
    ...

1. See ListPaymentInstrumentsResponseTypeDef

# list_payment_instruments method usage example with argument unpacking

kwargs: ListPaymentInstrumentsRequestTypeDef = {  # (1)
    "paymentManagerArn": ...,
}

parent.list_payment_instruments(**kwargs)

1. See ListPaymentInstrumentsRequestTypeDef

list_payment_sessions

List payment manager sessions.

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

# list_payment_sessions method definition

def list_payment_sessions(
    self,
    *,
    paymentManagerArn: str,
    userId: str = ...,
    agentName: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListPaymentSessionsResponseTypeDef:  # (1)
    ...

1. See ListPaymentSessionsResponseTypeDef

# list_payment_sessions method usage example with argument unpacking

kwargs: ListPaymentSessionsRequestTypeDef = {  # (1)
    "paymentManagerArn": ...,
}

parent.list_payment_sessions(**kwargs)

1. See ListPaymentSessionsRequestTypeDef

list_recommendations

Lists all recommendations in the account, with optional filtering by status.

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

# list_recommendations method definition

def list_recommendations(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    statusFilter: RecommendationStatusType = ...,  # (1)
) -> ListRecommendationsResponseTypeDef:  # (2)
    ...

1. See RecommendationStatusType
2. See ListRecommendationsResponseTypeDef

# list_recommendations method usage example with argument unpacking

kwargs: ListRecommendationsRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_recommendations(**kwargs)

1. See ListRecommendationsRequestTypeDef

list_sessions

Lists sessions in an AgentCore Memory resource 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 = ...,
    filter: SessionFilterTypeDef = ...,  # (1)
) -> ListSessionsOutputTypeDef:  # (2)
    ...

1. See SessionFilterTypeDef
2. See ListSessionsOutputTypeDef

# list_sessions method usage example with argument unpacking

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

parent.list_sessions(**kwargs)

1. See ListSessionsInputTypeDef

process_payment

Process a payment transaction.

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

# process_payment method definition

def process_payment(
    self,
    *,
    paymentManagerArn: str,
    paymentSessionId: str,
    paymentInstrumentId: str,
    paymentType: PaymentTypeType,  # (1)
    paymentInput: PaymentInputTypeDef,  # (2)
    userId: str = ...,
    agentName: str = ...,
    clientToken: str = ...,
) -> ProcessPaymentResponseTypeDef:  # (3)
    ...

1. See PaymentTypeType
2. See PaymentInputTypeDef
3. See ProcessPaymentResponseTypeDef

# process_payment method usage example with argument unpacking

kwargs: ProcessPaymentRequestTypeDef = {  # (1)
    "paymentManagerArn": ...,
    "paymentSessionId": ...,
    "paymentInstrumentId": ...,
    "paymentType": ...,
    "paymentInput": ...,
}

parent.process_payment(**kwargs)

1. See ProcessPaymentRequestTypeDef

retrieve_memory_records

Searches for and retrieves memory records from an AgentCore Memory resource 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,
    searchCriteria: SearchCriteriaTypeDef,  # (1)
    namespace: str = ...,
    namespacePath: str = ...,
    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": ...,
    "searchCriteria": ...,
}

parent.retrieve_memory_records(**kwargs)

1. See RetrieveMemoryRecordsInputTypeDef

save_browser_session_profile

Saves the current state of a browser session as a reusable profile in Amazon Bedrock AgentCore.

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

# save_browser_session_profile method definition

def save_browser_session_profile(
    self,
    *,
    profileIdentifier: str,
    browserIdentifier: str,
    sessionId: str,
    traceId: str = ...,
    traceParent: str = ...,
    clientToken: str = ...,
) -> SaveBrowserSessionProfileResponseTypeDef:  # (1)
    ...

1. See SaveBrowserSessionProfileResponseTypeDef

# save_browser_session_profile method usage example with argument unpacking

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

parent.save_browser_session_profile(**kwargs)

1. See SaveBrowserSessionProfileRequestTypeDef

search_registry_records

Searches for registry records using semantic, lexical, or hybrid queries.

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

# search_registry_records method definition

def search_registry_records(
    self,
    *,
    searchQuery: str,
    registryIds: Sequence[str],
    maxResults: int = ...,
    filters: Mapping[str, Any] = ...,
) -> SearchRegistryRecordsResponseTypeDef:  # (1)
    ...

1. See SearchRegistryRecordsResponseTypeDef

# search_registry_records method usage example with argument unpacking

kwargs: SearchRegistryRecordsRequestTypeDef = {  # (1)
    "searchQuery": ...,
    "registryIds": ...,
}

parent.search_registry_records(**kwargs)

1. See SearchRegistryRecordsRequestTypeDef

start_batch_evaluation

Starts a batch evaluation job that evaluates agent performance across multiple sessions.

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

# start_batch_evaluation method definition

def start_batch_evaluation(
    self,
    *,
    batchEvaluationName: str,
    dataSourceConfig: DataSourceConfigUnionTypeDef,  # (1)
    evaluators: Sequence[EvaluatorTypeDef] = ...,  # (2)
    clientToken: str = ...,
    evaluationMetadata: EvaluationMetadataTypeDef = ...,  # (3)
    description: str = ...,
) -> StartBatchEvaluationResponseTypeDef:  # (4)
    ...

1. See DataSourceConfigUnionTypeDef
2. See Sequence[EvaluatorTypeDef]
3. See EvaluationMetadataTypeDef
4. See StartBatchEvaluationResponseTypeDef

# start_batch_evaluation method usage example with argument unpacking

kwargs: StartBatchEvaluationRequestTypeDef = {  # (1)
    "batchEvaluationName": ...,
    "dataSourceConfig": ...,
}

parent.start_batch_evaluation(**kwargs)

1. See StartBatchEvaluationRequestTypeDef

start_browser_session

Creates and initializes a browser session in Amazon Bedrock AgentCore.

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,
    traceId: str = ...,
    traceParent: str = ...,
    name: str = ...,
    sessionTimeoutSeconds: int = ...,
    viewPort: ViewPortTypeDef = ...,  # (1)
    extensions: Sequence[BrowserExtensionTypeDef] = ...,  # (2)
    profileConfiguration: BrowserProfileConfigurationTypeDef = ...,  # (3)
    proxyConfiguration: ProxyConfigurationUnionTypeDef = ...,  # (4)
    enterprisePolicies: Sequence[BrowserEnterprisePolicyTypeDef] = ...,  # (5)
    certificates: Sequence[CertificateTypeDef] = ...,  # (6)
    clientToken: str = ...,
) -> StartBrowserSessionResponseTypeDef:  # (7)
    ...

1. See ViewPortTypeDef
2. See Sequence[BrowserExtensionTypeDef]
3. See BrowserProfileConfigurationTypeDef
4. See ProxyConfigurationUnionTypeDef
5. See Sequence[BrowserEnterprisePolicyTypeDef]
6. See Sequence[CertificateTypeDef]
7. 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 AgentCore.

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,
    traceId: str = ...,
    traceParent: str = ...,
    name: str = ...,
    sessionTimeoutSeconds: int = ...,
    certificates: Sequence[CertificateTypeDef] = ...,  # (1)
    clientToken: str = ...,
) -> StartCodeInterpreterSessionResponseTypeDef:  # (2)
    ...

1. See Sequence[CertificateTypeDef]
2. 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

start_memory_extraction_job

Starts a memory extraction job that processes events that failed extraction previously in an AgentCore Memory resource and produces structured memory records.

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

# start_memory_extraction_job method definition

def start_memory_extraction_job(
    self,
    *,
    memoryId: str,
    extractionJob: ExtractionJobTypeDef,  # (1)
    clientToken: str = ...,
) -> StartMemoryExtractionJobOutputTypeDef:  # (2)
    ...

1. See ExtractionJobTypeDef
2. See StartMemoryExtractionJobOutputTypeDef

# start_memory_extraction_job method usage example with argument unpacking

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

parent.start_memory_extraction_job(**kwargs)

1. See StartMemoryExtractionJobInputTypeDef

start_recommendation

Starts a recommendation job that analyzes agent traces and generates optimization suggestions for system prompts or tool descriptions to improve agent performance.

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

# start_recommendation method definition

def start_recommendation(
    self,
    *,
    name: str,
    type: RecommendationTypeType,  # (1)
    recommendationConfig: RecommendationConfigUnionTypeDef,  # (2)
    description: str = ...,
    clientToken: str = ...,
) -> StartRecommendationResponseTypeDef:  # (3)
    ...

1. See RecommendationTypeType
2. See RecommendationConfigUnionTypeDef
3. See StartRecommendationResponseTypeDef

# start_recommendation method usage example with argument unpacking

kwargs: StartRecommendationRequestTypeDef = {  # (1)
    "name": ...,
    "type": ...,
    "recommendationConfig": ...,
}

parent.start_recommendation(**kwargs)

1. See StartRecommendationRequestTypeDef

stop_batch_evaluation

Stops a running batch evaluation.

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

# stop_batch_evaluation method definition

def stop_batch_evaluation(
    self,
    *,
    batchEvaluationId: str,
) -> StopBatchEvaluationResponseTypeDef:  # (1)
    ...

1. See StopBatchEvaluationResponseTypeDef

# stop_batch_evaluation method usage example with argument unpacking

kwargs: StopBatchEvaluationRequestTypeDef = {  # (1)
    "batchEvaluationId": ...,
}

parent.stop_batch_evaluation(**kwargs)

1. See StopBatchEvaluationRequestTypeDef

stop_browser_session

Terminates an active browser session in Amazon Bedrock AgentCore.

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,
    traceId: str = ...,
    traceParent: 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 AgentCore.

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,
    traceId: str = ...,
    traceParent: 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

stop_runtime_session

Stops a session that is running in an running AgentCore Runtime agent.

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

# stop_runtime_session method definition

def stop_runtime_session(
    self,
    *,
    runtimeSessionId: str,
    agentRuntimeArn: str,
    qualifier: str = ...,
    clientToken: str = ...,
) -> StopRuntimeSessionResponseTypeDef:  # (1)
    ...

1. See StopRuntimeSessionResponseTypeDef

# stop_runtime_session method usage example with argument unpacking

kwargs: StopRuntimeSessionRequestTypeDef = {  # (1)
    "runtimeSessionId": ...,
    "agentRuntimeArn": ...,
}

parent.stop_runtime_session(**kwargs)

1. See StopRuntimeSessionRequestTypeDef

update_ab_test

Updates an A/B test's configuration, including variants, traffic allocation, evaluation settings, or execution status.

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

# update_ab_test method definition

def update_ab_test(
    self,
    *,
    abTestId: str,
    clientToken: str = ...,
    name: str = ...,
    description: str = ...,
    variants: Sequence[VariantTypeDef] = ...,  # (1)
    gatewayFilter: GatewayFilterUnionTypeDef = ...,  # (2)
    evaluationConfig: ABTestEvaluationConfigUnionTypeDef = ...,  # (3)
    roleArn: str = ...,
    executionStatus: ABTestExecutionStatusType = ...,  # (4)
) -> UpdateABTestResponseTypeDef:  # (5)
    ...

1. See Sequence[VariantTypeDef]
2. See GatewayFilterUnionTypeDef
3. See ABTestEvaluationConfigUnionTypeDef
4. See ABTestExecutionStatusType
5. See UpdateABTestResponseTypeDef

# update_ab_test method usage example with argument unpacking

kwargs: UpdateABTestRequestTypeDef = {  # (1)
    "abTestId": ...,
}

parent.update_ab_test(**kwargs)

1. See UpdateABTestRequestTypeDef

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.

• client.get_paginator("list_ab_tests") -> ListABTestsPaginator
• client.get_paginator("list_actors") -> ListActorsPaginator
• client.get_paginator("list_batch_evaluations") -> ListBatchEvaluationsPaginator
• client.get_paginator("list_events") -> ListEventsPaginator
• client.get_paginator("list_memory_extraction_jobs") -> ListMemoryExtractionJobsPaginator
• client.get_paginator("list_memory_records") -> ListMemoryRecordsPaginator
• client.get_paginator("list_payment_instruments") -> ListPaymentInstrumentsPaginator
• client.get_paginator("list_payment_sessions") -> ListPaymentSessionsPaginator
• client.get_paginator("list_recommendations") -> ListRecommendationsPaginator
• client.get_paginator("list_sessions") -> ListSessionsPaginator
• client.get_paginator("retrieve_memory_records") -> RetrieveMemoryRecordsPaginator