BatchCreateMemoryRecords

$result = $client->batchCreateMemoryRecords([/* ... */]);
$promise = $client->batchCreateMemoryRecordsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchCreateMemoryRecords([
    'clientToken' => '<string>',
    'memoryId' => '<string>', // REQUIRED
    'records' => [ // REQUIRED
        [
            'content' => [ // REQUIRED
                'text' => '<string>',
            ],
            'memoryStrategyId' => '<string>',
            'namespaces' => ['<string>', ...], // REQUIRED
            'requestIdentifier' => '<string>', // REQUIRED
            'timestamp' => <integer || string || DateTime>, // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'failedRecords' => [
        [
            'errorCode' => <integer>,
            'errorMessage' => '<string>',
            'memoryRecordId' => '<string>',
            'requestIdentifier' => '<string>',
            'status' => 'SUCCEEDED|FAILED',
        ],
        // ...
    ],
    'successfulRecords' => [
        [
            'errorCode' => <integer>,
            'errorMessage' => '<string>',
            'memoryRecordId' => '<string>',
            'requestIdentifier' => '<string>',
            'status' => 'SUCCEEDED|FAILED',
        ],
        // ...
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottledException:

The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException:

The service encountered an internal error. Try your request again later.

BatchDeleteMemoryRecords

$result = $client->batchDeleteMemoryRecords([/* ... */]);
$promise = $client->batchDeleteMemoryRecordsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchDeleteMemoryRecords([
    'memoryId' => '<string>', // REQUIRED
    'records' => [ // REQUIRED
        [
            'memoryRecordId' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'failedRecords' => [
        [
            'errorCode' => <integer>,
            'errorMessage' => '<string>',
            'memoryRecordId' => '<string>',
            'requestIdentifier' => '<string>',
            'status' => 'SUCCEEDED|FAILED',
        ],
        // ...
    ],
    'successfulRecords' => [
        [
            'errorCode' => <integer>,
            'errorMessage' => '<string>',
            'memoryRecordId' => '<string>',
            'requestIdentifier' => '<string>',
            'status' => 'SUCCEEDED|FAILED',
        ],
        // ...
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottledException:

The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException:

The service encountered an internal error. Try your request again later.

BatchUpdateMemoryRecords

$result = $client->batchUpdateMemoryRecords([/* ... */]);
$promise = $client->batchUpdateMemoryRecordsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchUpdateMemoryRecords([
    'memoryId' => '<string>', // REQUIRED
    'records' => [ // REQUIRED
        [
            'content' => [
                'text' => '<string>',
            ],
            'memoryRecordId' => '<string>', // REQUIRED
            'memoryStrategyId' => '<string>',
            'namespaces' => ['<string>', ...],
            'timestamp' => <integer || string || DateTime>, // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'failedRecords' => [
        [
            'errorCode' => <integer>,
            'errorMessage' => '<string>',
            'memoryRecordId' => '<string>',
            'requestIdentifier' => '<string>',
            'status' => 'SUCCEEDED|FAILED',
        ],
        // ...
    ],
    'successfulRecords' => [
        [
            'errorCode' => <integer>,
            'errorMessage' => '<string>',
            'memoryRecordId' => '<string>',
            'requestIdentifier' => '<string>',
            'status' => 'SUCCEEDED|FAILED',
        ],
        // ...
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottledException:

The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException:

The service encountered an internal error. Try your request again later.

CreateEvent

$result = $client->createEvent([/* ... */]);
$promise = $client->createEventAsync([/* ... */]);

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

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

This operation is subject to request rate limiting.

Parameter Syntax

$result = $client->createEvent([
    'actorId' => '<string>', // REQUIRED
    'branch' => [
        'name' => '<string>', // REQUIRED
        'rootEventId' => '<string>',
    ],
    'clientToken' => '<string>',
    'eventTimestamp' => <integer || string || DateTime>, // REQUIRED
    'memoryId' => '<string>', // REQUIRED
    'metadata' => [
        '<MetadataKey>' => [
            'stringValue' => '<string>',
        ],
        // ...
    ],
    'payload' => [ // REQUIRED
        [
            'blob' => [
            ],
            'conversational' => [
                'content' => [ // REQUIRED
                    'text' => '<string>',
                ],
                'role' => 'ASSISTANT|USER|TOOL|OTHER', // REQUIRED
            ],
        ],
        // ...
    ],
    'sessionId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'event' => [
        'actorId' => '<string>',
        'branch' => [
            'name' => '<string>',
            'rootEventId' => '<string>',
        ],
        'eventId' => '<string>',
        'eventTimestamp' => <DateTime>,
        'memoryId' => '<string>',
        'metadata' => [
            '<MetadataKey>' => [
                'stringValue' => '<string>',
            ],
            // ...
        ],
        'payload' => [
            [
                'blob' => [
                ],
                'conversational' => [
                    'content' => [
                        'text' => '<string>',
                    ],
                    'role' => 'ASSISTANT|USER|TOOL|OTHER',
                ],
            ],
            // ...
        ],
        'sessionId' => '<string>',
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException:

The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottledException:

The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException:

The service encountered an internal error. Try your request again later.

DeleteEvent

$result = $client->deleteEvent([/* ... */]);
$promise = $client->deleteEventAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->deleteEvent([
    'actorId' => '<string>', // REQUIRED
    'eventId' => '<string>', // REQUIRED
    'memoryId' => '<string>', // REQUIRED
    'sessionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'eventId' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException:

The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottledException:

The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException:

The service encountered an internal error. Try your request again later.

DeleteMemoryRecord

$result = $client->deleteMemoryRecord([/* ... */]);
$promise = $client->deleteMemoryRecordAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->deleteMemoryRecord([
    'memoryId' => '<string>', // REQUIRED
    'memoryRecordId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'memoryRecordId' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException:

The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottledException:

The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException:

The service encountered an internal error. Try your request again later.

GetAgentCard

$result = $client->getAgentCard([/* ... */]);
$promise = $client->getAgentCardAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getAgentCard([
    'agentRuntimeArn' => '<string>', // REQUIRED
    'qualifier' => '<string>',
    'runtimeSessionId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'agentCard' => [
    ],
    'runtimeSessionId' => '<string>',
    'statusCode' => <integer>,
]

Result Details

Errors

ServiceQuotaExceededException:

The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

RuntimeClientError:

The exception that occurs when there is an error in the runtime client. This can happen due to network issues, invalid configuration, or other client-side problems. Check the error message for specific details about the error.

ThrottlingException:

The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException:

The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

GetBrowserSession

$result = $client->getBrowserSession([/* ... */]);
$promise = $client->getBrowserSessionAsync([/* ... */]);

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

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

The following operations are related to GetBrowserSession:

• StartBrowserSession

• ListBrowserSessions

• StopBrowserSession

Parameter Syntax

$result = $client->getBrowserSession([
    'browserIdentifier' => '<string>', // REQUIRED
    'sessionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'browserIdentifier' => '<string>',
    'createdAt' => <DateTime>,
    'lastUpdatedAt' => <DateTime>,
    'name' => '<string>',
    'sessionId' => '<string>',
    'sessionReplayArtifact' => '<string>',
    'sessionTimeoutSeconds' => <integer>,
    'status' => 'READY|TERMINATED',
    'streams' => [
        'automationStream' => [
            'streamEndpoint' => '<string>',
            'streamStatus' => 'ENABLED|DISABLED',
        ],
        'liveViewStream' => [
            'streamEndpoint' => '<string>',
        ],
    ],
    'viewPort' => [
        'height' => <integer>,
        'width' => <integer>,
    ],
]

Result Details

Errors

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException:

The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException:

The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

GetCodeInterpreterSession

$result = $client->getCodeInterpreterSession([/* ... */]);
$promise = $client->getCodeInterpreterSessionAsync([/* ... */]);

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

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

The following operations are related to GetCodeInterpreterSession:

• StartCodeInterpreterSession

• ListCodeInterpreterSessions

• StopCodeInterpreterSession

Parameter Syntax

$result = $client->getCodeInterpreterSession([
    'codeInterpreterIdentifier' => '<string>', // REQUIRED
    'sessionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'codeInterpreterIdentifier' => '<string>',
    'createdAt' => <DateTime>,
    'name' => '<string>',
    'sessionId' => '<string>',
    'sessionTimeoutSeconds' => <integer>,
    'status' => 'READY|TERMINATED',
]

Result Details

Errors

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException:

The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException:

The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

GetEvent

$result = $client->getEvent([/* ... */]);
$promise = $client->getEventAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->getEvent([
    'actorId' => '<string>', // REQUIRED
    'eventId' => '<string>', // REQUIRED
    'memoryId' => '<string>', // REQUIRED
    'sessionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'event' => [
        'actorId' => '<string>',
        'branch' => [
            'name' => '<string>',
            'rootEventId' => '<string>',
        ],
        'eventId' => '<string>',
        'eventTimestamp' => <DateTime>,
        'memoryId' => '<string>',
        'metadata' => [
            '<MetadataKey>' => [
                'stringValue' => '<string>',
            ],
            // ...
        ],
        'payload' => [
            [
                'blob' => [
                ],
                'conversational' => [
                    'content' => [
                        'text' => '<string>',
                    ],
                    'role' => 'ASSISTANT|USER|TOOL|OTHER',
                ],
            ],
            // ...
        ],
        'sessionId' => '<string>',
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException:

The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottledException:

The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException:

The service encountered an internal error. Try your request again later.

GetMemoryRecord

$result = $client->getMemoryRecord([/* ... */]);
$promise = $client->getMemoryRecordAsync([/* ... */]);

Retrieves a specific memory record from an AgentCore Memory resource.

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

Parameter Syntax

$result = $client->getMemoryRecord([
    'memoryId' => '<string>', // REQUIRED
    'memoryRecordId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'memoryRecord' => [
        'content' => [
            'text' => '<string>',
        ],
        'createdAt' => <DateTime>,
        'memoryRecordId' => '<string>',
        'memoryStrategyId' => '<string>',
        'namespaces' => ['<string>', ...],
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException:

The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottledException:

The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException:

The service encountered an internal error. Try your request again later.

GetResourceApiKey

$result = $client->getResourceApiKey([/* ... */]);
$promise = $client->getResourceApiKeyAsync([/* ... */]);

Retrieves the API key associated with an API key credential provider.

Parameter Syntax

$result = $client->getResourceApiKey([
    'resourceCredentialProviderName' => '<string>', // REQUIRED
    'workloadIdentityToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'apiKey' => '<string>',
]

Result Details

Errors

UnauthorizedException:

This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException:

The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException:

The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

GetResourceOauth2Token

$result = $client->getResourceOauth2Token([/* ... */]);
$promise = $client->getResourceOauth2TokenAsync([/* ... */]);

Returns the OAuth 2.0 token of the provided resource.

Parameter Syntax

$result = $client->getResourceOauth2Token([
    'customParameters' => ['<string>', ...],
    'forceAuthentication' => true || false,
    'oauth2Flow' => 'USER_FEDERATION|M2M', // REQUIRED
    'resourceCredentialProviderName' => '<string>', // REQUIRED
    'resourceOauth2ReturnUrl' => '<string>',
    'scopes' => ['<string>', ...], // REQUIRED
    'workloadIdentityToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'accessToken' => '<string>',
    'authorizationUrl' => '<string>',
]

Result Details

Errors

UnauthorizedException:

This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException:

The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException:

The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

GetWorkloadAccessToken

$result = $client->getWorkloadAccessToken([/* ... */]);
$promise = $client->getWorkloadAccessTokenAsync([/* ... */]);

Obtains a workload access token for agentic workloads not acting on behalf of a user.

Parameter Syntax

$result = $client->getWorkloadAccessToken([
    'workloadName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'workloadAccessToken' => '<string>',
]

Result Details

Errors

UnauthorizedException:

This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException:

The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException:

The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

GetWorkloadAccessTokenForJWT

$result = $client->getWorkloadAccessTokenForJWT([/* ... */]);
$promise = $client->getWorkloadAccessTokenForJWTAsync([/* ... */]);

Obtains a workload access token for agentic workloads acting on behalf of a user, using a JWT token.

Parameter Syntax

$result = $client->getWorkloadAccessTokenForJWT([
    'userToken' => '<string>', // REQUIRED
    'workloadName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'workloadAccessToken' => '<string>',
]

Result Details

Errors

UnauthorizedException:

This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException:

The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException:

The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

GetWorkloadAccessTokenForUserId

$result = $client->getWorkloadAccessTokenForUserId([/* ... */]);
$promise = $client->getWorkloadAccessTokenForUserIdAsync([/* ... */]);

Obtains a workload access token for agentic workloads acting on behalf of a user, using the user's ID.

Parameter Syntax

$result = $client->getWorkloadAccessTokenForUserId([
    'userId' => '<string>', // REQUIRED
    'workloadName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'workloadAccessToken' => '<string>',
]

Result Details

Errors

UnauthorizedException:

This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException:

The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException:

The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

InvokeAgentRuntime

$result = $client->invokeAgentRuntime([/* ... */]);
$promise = $client->invokeAgentRuntimeAsync([/* ... */]);

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

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

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

For example code, see Invoke an AgentCore Runtime agent.

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

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

Parameter Syntax

$result = $client->invokeAgentRuntime([
    'accept' => '<string>',
    'agentRuntimeArn' => '<string>', // REQUIRED
    'baggage' => '<string>',
    'contentType' => '<string>',
    'mcpProtocolVersion' => '<string>',
    'mcpSessionId' => '<string>',
    'payload' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'qualifier' => '<string>',
    'runtimeSessionId' => '<string>',
    'runtimeUserId' => '<string>',
    'traceId' => '<string>',
    'traceParent' => '<string>',
    'traceState' => '<string>',
]);

Parameter Details

Result Syntax

[
    'baggage' => '<string>',
    'contentType' => '<string>',
    'mcpProtocolVersion' => '<string>',
    'mcpSessionId' => '<string>',
    'response' => <string || resource || Psr\Http\Message\StreamInterface>,
    'runtimeSessionId' => '<string>',
    'statusCode' => <integer>,
    'traceId' => '<string>',
    'traceParent' => '<string>',
    'traceState' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

RuntimeClientError:

The exception that occurs when there is an error in the runtime client. This can happen due to network issues, invalid configuration, or other client-side problems. Check the error message for specific details about the error.

ThrottlingException:

The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException:

The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

InvokeCodeInterpreter

$result = $client->invokeCodeInterpreter([/* ... */]);
$promise = $client->invokeCodeInterpreterAsync([/* ... */]);

Executes code within an active code interpreter session in Amazon Bedrock. This operation processes the provided code, runs it in a secure environment, and returns the execution results including output, errors, and generated visualizations.

To execute code, you must specify the code interpreter identifier, session ID, and the code to run in the arguments parameter. The operation returns a stream containing the execution results, which can include text output, error messages, and data visualizations.

This operation is subject to request rate limiting based on your account's service quotas.

The following operations are related to InvokeCodeInterpreter:

• StartCodeInterpreterSession

• GetCodeInterpreterSession

Parameter Syntax

$result = $client->invokeCodeInterpreter([
    'arguments' => [
        'clearContext' => true || false,
        'code' => '<string>',
        'command' => '<string>',
        'content' => [
            [
                'blob' => <string || resource || Psr\Http\Message\StreamInterface>,
                'path' => '<string>', // REQUIRED
                'text' => '<string>',
            ],
            // ...
        ],
        'directoryPath' => '<string>',
        'language' => 'python|javascript|typescript',
        'path' => '<string>',
        'paths' => ['<string>', ...],
        'taskId' => '<string>',
    ],
    'codeInterpreterIdentifier' => '<string>', // REQUIRED
    'name' => 'executeCode|executeCommand|readFiles|listFiles|removeFiles|writeFiles|startCommandExecution|getTask|stopTask', // REQUIRED
    'sessionId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'sessionId' => '<string>',
    'stream' => [ // EventParsingIterator
        'accessDeniedException' => [
            'message' => '<string>',
        ],
        'conflictException' => [
            'message' => '<string>',
        ],
        'internalServerException' => [
            'message' => '<string>',
        ],
        'resourceNotFoundException' => [
            'message' => '<string>',
        ],
        'result' => [
            'content' => [
                [
                    'data' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'description' => '<string>',
                    'mimeType' => '<string>',
                    'name' => '<string>',
                    'resource' => [
                        'blob' => <string || resource || Psr\Http\Message\StreamInterface>,
                        'mimeType' => '<string>',
                        'text' => '<string>',
                        'type' => 'text|blob',
                        'uri' => '<string>',
                    ],
                    'size' => <integer>,
                    'text' => '<string>',
                    'type' => 'text|image|resource|resource_link',
                    'uri' => '<string>',
                ],
                // ...
            ],
            'isError' => true || false,
            'structuredContent' => [
                'executionTime' => <float>,
                'exitCode' => <integer>,
                'stderr' => '<string>',
                'stdout' => '<string>',
                'taskId' => '<string>',
                'taskStatus' => 'submitted|working|completed|canceled|failed',
            ],
        ],
        'serviceQuotaExceededException' => [
            'message' => '<string>',
        ],
        'throttlingException' => [
            'message' => '<string>',
        ],
        'validationException' => [
            'fieldList' => [
                [
                    'message' => '<string>',
                    'name' => '<string>',
                ],
                // ...
            ],
            'message' => '<string>',
            'reason' => 'CannotParse|FieldValidationFailed|IdempotentParameterMismatchException|EventInOtherSession|ResourceConflict',
        ],
    ],
]

Result Details

Using an EventParsingIterator

To use an EventParsingIterator, you will need to loop over the events it will generate and check the top-level field to determine which type of event it is.

foreach($result['stream'] as $event) {
    if (isset($event['accessDeniedException'])) {
        // Handle the 'accessDeniedException' event.
    } else if (isset($event['conflictException'])) {
        // Handle the 'conflictException' event.
    } else if (isset($event['internalServerException'])) {
        // Handle the 'internalServerException' event.
    } else if (isset($event['resourceNotFoundException'])) {
        // Handle the 'resourceNotFoundException' event.
    } else if (isset($event['result'])) {
        // Handle the 'result' event.
    } else if (isset($event['serviceQuotaExceededException'])) {
        // Handle the 'serviceQuotaExceededException' event.
    } else if (isset($event['throttlingException'])) {
        // Handle the 'throttlingException' event.
    } else if (isset($event['validationException'])) {
        // Handle the 'validationException' event.
    }
}

Errors

ServiceQuotaExceededException:

The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException:

The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException:

The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException:

The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

ListActors

$result = $client->listActors([/* ... */]);
$promise = $client->listActorsAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->listActors([
    'maxResults' => <integer>,
    'memoryId' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'actorSummaries' => [
        [
            'actorId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException:

The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottledException:

The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException:

The service encountered an internal error. Try your request again later.

ListBrowserSessions

$result = $client->listBrowserSessions([/* ... */]);
$promise = $client->listBrowserSessionsAsync([/* ... */]);

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

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

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

The following operations are related to ListBrowserSessions:

• StartBrowserSession

• GetBrowserSession

Parameter Syntax

$result = $client->listBrowserSessions([
    'browserIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'status' => 'READY|TERMINATED',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'browserIdentifier' => '<string>',
            'createdAt' => <DateTime>,
            'lastUpdatedAt' => <DateTime>,
            'name' => '<string>',
            'sessionId' => '<string>',
            'status' => 'READY|TERMINATED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException:

The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException:

The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

ListCodeInterpreterSessions

$result = $client->listCodeInterpreterSessions([/* ... */]);
$promise = $client->listCodeInterpreterSessionsAsync([/* ... */]);

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

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

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

The following operations are related to ListCodeInterpreterSessions:

• StartCodeInterpreterSession

• GetCodeInterpreterSession

Parameter Syntax

$result = $client->listCodeInterpreterSessions([
    'codeInterpreterIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'status' => 'READY|TERMINATED',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'codeInterpreterIdentifier' => '<string>',
            'createdAt' => <DateTime>,
            'lastUpdatedAt' => <DateTime>,
            'name' => '<string>',
            'sessionId' => '<string>',
            'status' => 'READY|TERMINATED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException:

The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException:

The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

ListEvents

$result = $client->listEvents([/* ... */]);
$promise = $client->listEventsAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->listEvents([
    'actorId' => '<string>', // REQUIRED
    'filter' => [
        'branch' => [
            'includeParentBranches' => true || false,
            'name' => '<string>', // REQUIRED
        ],
        'eventMetadata' => [
            [
                'left' => [ // REQUIRED
                    'metadataKey' => '<string>',
                ],
                'operator' => 'EQUALS_TO|EXISTS|NOT_EXISTS', // REQUIRED
                'right' => [
                    'metadataValue' => [
                        'stringValue' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
    ],
    'includePayloads' => true || false,
    'maxResults' => <integer>,
    'memoryId' => '<string>', // REQUIRED
    'nextToken' => '<string>',
    'sessionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'events' => [
        [
            'actorId' => '<string>',
            'branch' => [
                'name' => '<string>',
                'rootEventId' => '<string>',
            ],
            'eventId' => '<string>',
            'eventTimestamp' => <DateTime>,
            'memoryId' => '<string>',
            'metadata' => [
                '<MetadataKey>' => [
                    'stringValue' => '<string>',
                ],
                // ...
            ],
            'payload' => [
                [
                    'blob' => [
                    ],
                    'conversational' => [
                        'content' => [
                            'text' => '<string>',
                        ],
                        'role' => 'ASSISTANT|USER|TOOL|OTHER',
                    ],
                ],
                // ...
            ],
            'sessionId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException:

The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottledException:

The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException:

The service encountered an internal error. Try your request again later.

ListMemoryRecords

$result = $client->listMemoryRecords([/* ... */]);
$promise = $client->listMemoryRecordsAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->listMemoryRecords([
    'maxResults' => <integer>,
    'memoryId' => '<string>', // REQUIRED
    'memoryStrategyId' => '<string>',
    'namespace' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'memoryRecordSummaries' => [
        [
            'content' => [
                'text' => '<string>',
            ],
            'createdAt' => <DateTime>,
            'memoryRecordId' => '<string>',
            'memoryStrategyId' => '<string>',
            'namespaces' => ['<string>', ...],
            'score' => <float>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException:

The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottledException:

The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException:

The service encountered an internal error. Try your request again later.

ListSessions

$result = $client->listSessions([/* ... */]);
$promise = $client->listSessionsAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->listSessions([
    'actorId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'memoryId' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'sessionSummaries' => [
        [
            'actorId' => '<string>',
            'createdAt' => <DateTime>,
            'sessionId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException:

The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottledException:

The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException:

The service encountered an internal error. Try your request again later.

RetrieveMemoryRecords

$result = $client->retrieveMemoryRecords([/* ... */]);
$promise = $client->retrieveMemoryRecordsAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->retrieveMemoryRecords([
    'maxResults' => <integer>,
    'memoryId' => '<string>', // REQUIRED
    'namespace' => '<string>', // REQUIRED
    'nextToken' => '<string>',
    'searchCriteria' => [ // REQUIRED
        'memoryStrategyId' => '<string>',
        'searchQuery' => '<string>', // REQUIRED
        'topK' => <integer>,
    ],
]);

Parameter Details

Result Syntax

[
    'memoryRecordSummaries' => [
        [
            'content' => [
                'text' => '<string>',
            ],
            'createdAt' => <DateTime>,
            'memoryRecordId' => '<string>',
            'memoryStrategyId' => '<string>',
            'namespaces' => ['<string>', ...],
            'score' => <float>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException:

The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottledException:

The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException:

The service encountered an internal error. Try your request again later.

StartBrowserSession

$result = $client->startBrowserSession([/* ... */]);
$promise = $client->startBrowserSessionAsync([/* ... */]);

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

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

The following operations are related to StartBrowserSession:

• GetBrowserSession

• UpdateBrowserStream

• StopBrowserSession

Parameter Syntax

$result = $client->startBrowserSession([
    'browserIdentifier' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'name' => '<string>',
    'sessionTimeoutSeconds' => <integer>,
    'viewPort' => [
        'height' => <integer>, // REQUIRED
        'width' => <integer>, // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'browserIdentifier' => '<string>',
    'createdAt' => <DateTime>,
    'sessionId' => '<string>',
    'streams' => [
        'automationStream' => [
            'streamEndpoint' => '<string>',
            'streamStatus' => 'ENABLED|DISABLED',
        ],
        'liveViewStream' => [
            'streamEndpoint' => '<string>',
        ],
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException:

The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException:

The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException:

The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

StartCodeInterpreterSession

$result = $client->startCodeInterpreterSession([/* ... */]);
$promise = $client->startCodeInterpreterSessionAsync([/* ... */]);

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

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

The following operations are related to StartCodeInterpreterSession:

• InvokeCodeInterpreter

• GetCodeInterpreterSession

• StopCodeInterpreterSession

Parameter Syntax

$result = $client->startCodeInterpreterSession([
    'clientToken' => '<string>',
    'codeInterpreterIdentifier' => '<string>', // REQUIRED
    'name' => '<string>',
    'sessionTimeoutSeconds' => <integer>,
]);

Parameter Details

Result Syntax

[
    'codeInterpreterIdentifier' => '<string>',
    'createdAt' => <DateTime>,
    'sessionId' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException:

The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException:

The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException:

The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

StopBrowserSession

$result = $client->stopBrowserSession([/* ... */]);
$promise = $client->stopBrowserSessionAsync([/* ... */]);

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

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

The following operations are related to StopBrowserSession:

• StartBrowserSession

• GetBrowserSession

Parameter Syntax

$result = $client->stopBrowserSession([
    'browserIdentifier' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'sessionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'browserIdentifier' => '<string>',
    'lastUpdatedAt' => <DateTime>,
    'sessionId' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException:

The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException:

The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException:

The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

StopCodeInterpreterSession

$result = $client->stopCodeInterpreterSession([/* ... */]);
$promise = $client->stopCodeInterpreterSessionAsync([/* ... */]);

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

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

The following operations are related to StopCodeInterpreterSession:

• StartCodeInterpreterSession

• GetCodeInterpreterSession

Parameter Syntax

$result = $client->stopCodeInterpreterSession([
    'clientToken' => '<string>',
    'codeInterpreterIdentifier' => '<string>', // REQUIRED
    'sessionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'codeInterpreterIdentifier' => '<string>',
    'lastUpdatedAt' => <DateTime>,
    'sessionId' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException:

The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException:

The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException:

The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

StopRuntimeSession

$result = $client->stopRuntimeSession([/* ... */]);
$promise = $client->stopRuntimeSessionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->stopRuntimeSession([
    'agentRuntimeArn' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'qualifier' => '<string>',
    'runtimeSessionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'runtimeSessionId' => '<string>',
    'statusCode' => <integer>,
]

Result Details

Errors

ServiceQuotaExceededException:

The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

UnauthorizedException:

This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException:

The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

RuntimeClientError:

The exception that occurs when there is an error in the runtime client. This can happen due to network issues, invalid configuration, or other client-side problems. Check the error message for specific details about the error.

ThrottlingException:

The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException:

The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

UpdateBrowserStream

$result = $client->updateBrowserStream([/* ... */]);
$promise = $client->updateBrowserStreamAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateBrowserStream([
    'browserIdentifier' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'sessionId' => '<string>', // REQUIRED
    'streamUpdate' => [ // REQUIRED
        'automationStreamUpdate' => [
            'streamStatus' => 'ENABLED|DISABLED',
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'browserIdentifier' => '<string>',
    'sessionId' => '<string>',
    'streams' => [
        'automationStream' => [
            'streamEndpoint' => '<string>',
            'streamStatus' => 'ENABLED|DISABLED',
        ],
        'liveViewStream' => [
            'streamEndpoint' => '<string>',
        ],
    ],
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ServiceQuotaExceededException:

The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException:

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException:

The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException:

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException:

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException:

The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException:

The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.