Creates multiple memory records in a single batch operation for the specified memory with custom content.
", "idempotent":true }, "BatchDeleteMemoryRecords":{ "name":"BatchDeleteMemoryRecords", "http":{ "method":"POST", "requestUri":"/memories/{memoryId}/memoryRecords/batchDelete", "responseCode":200 }, "input":{"shape":"BatchDeleteMemoryRecordsInput"}, "output":{"shape":"BatchDeleteMemoryRecordsOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottledException"}, {"shape":"ServiceException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Deletes multiple memory records in a single batch operation from the specified memory.
" }, "BatchUpdateMemoryRecords":{ "name":"BatchUpdateMemoryRecords", "http":{ "method":"POST", "requestUri":"/memories/{memoryId}/memoryRecords/batchUpdate", "responseCode":200 }, "input":{"shape":"BatchUpdateMemoryRecordsInput"}, "output":{"shape":"BatchUpdateMemoryRecordsOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottledException"}, {"shape":"ServiceException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Updates multiple memory records with custom content in a single batch operation within the specified memory.
" }, "CompleteResourceTokenAuth":{ "name":"CompleteResourceTokenAuth", "http":{ "method":"POST", "requestUri":"/identities/CompleteResourceTokenAuth", "responseCode":200 }, "input":{"shape":"CompleteResourceTokenAuthRequest"}, "output":{"shape":"CompleteResourceTokenAuthResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Confirms the user authentication session for obtaining OAuth2.0 tokens for a resource.
" }, "CreateABTest":{ "name":"CreateABTest", "http":{ "method":"POST", "requestUri":"/ab-tests", "responseCode":202 }, "input":{"shape":"CreateABTestRequest"}, "output":{"shape":"CreateABTestResponse"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"UnauthorizedException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Creates an A/B test for comparing agent configurations. A/B tests split traffic between a control variant and a treatment variant through a gateway, then evaluate performance using online evaluation configurations to determine which variant performs better.
" }, "CreateEvent":{ "name":"CreateEvent", "http":{ "method":"POST", "requestUri":"/memories/{memoryId}/events", "responseCode":201 }, "input":{"shape":"CreateEventInput"}, "output":{"shape":"CreateEventOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottledException"}, {"shape":"ServiceException"}, {"shape":"RetryableConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"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.
", "idempotent":true }, "DeleteABTest":{ "name":"DeleteABTest", "http":{ "method":"DELETE", "requestUri":"/ab-tests/{abTestId}", "responseCode":202 }, "input":{"shape":"DeleteABTestRequest"}, "output":{"shape":"DeleteABTestResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"Deletes an A/B test and its associated gateway rules.
", "idempotent":true }, "DeleteBatchEvaluation":{ "name":"DeleteBatchEvaluation", "http":{ "method":"DELETE", "requestUri":"/evaluations/batch-evaluate/{batchEvaluationId}", "responseCode":202 }, "input":{"shape":"DeleteBatchEvaluationRequest"}, "output":{"shape":"DeleteBatchEvaluationResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"Deletes a batch evaluation and its associated results.
", "idempotent":true }, "DeleteEvent":{ "name":"DeleteEvent", "http":{ "method":"DELETE", "requestUri":"/memories/{memoryId}/actor/{actorId}/sessions/{sessionId}/events/{eventId}", "responseCode":200 }, "input":{"shape":"DeleteEventInput"}, "output":{"shape":"DeleteEventOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottledException"}, {"shape":"ServiceException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"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.
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.
Deletes a recommendation and its associated results.
", "idempotent":true }, "Evaluate":{ "name":"Evaluate", "http":{ "method":"POST", "requestUri":"/evaluations/evaluate/{evaluatorId}", "responseCode":200 }, "input":{"shape":"EvaluateRequest"}, "output":{"shape":"EvaluateResponse"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"UnauthorizedException"}, {"shape":"DuplicateIdException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Performs on-demand evaluation of agent traces using a specified evaluator. This synchronous API accepts traces in OpenTelemetry format and returns immediate scoring results with detailed explanations.
" }, "GetABTest":{ "name":"GetABTest", "http":{ "method":"GET", "requestUri":"/ab-tests/{abTestId}", "responseCode":200 }, "input":{"shape":"GetABTestRequest"}, "output":{"shape":"GetABTestResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"Retrieves detailed information about an A/B test, including its configuration, status, and statistical results.
", "readonly":true }, "GetAgentCard":{ "name":"GetAgentCard", "http":{ "method":"GET", "requestUri":"/runtimes/{agentRuntimeArn}/invocations/.well-known/agent-card.json", "responseCode":200 }, "input":{"shape":"GetAgentCardRequest"}, "output":{"shape":"GetAgentCardResponse"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"RuntimeClientError"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"Retrieves the A2A agent card associated with an AgentCore Runtime agent.
" }, "GetBatchEvaluation":{ "name":"GetBatchEvaluation", "http":{ "method":"GET", "requestUri":"/evaluations/batch-evaluate/{batchEvaluationId}", "responseCode":200 }, "input":{"shape":"GetBatchEvaluationRequest"}, "output":{"shape":"GetBatchEvaluationResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"Retrieves detailed information about a batch evaluation, including its status, configuration, results, and any error details.
", "readonly":true }, "GetBrowserSession":{ "name":"GetBrowserSession", "http":{ "method":"GET", "requestUri":"/browsers/{browserIdentifier}/sessions/get", "responseCode":200 }, "input":{"shape":"GetBrowserSessionRequest"}, "output":{"shape":"GetBrowserSessionResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Retrieves detailed information about a specific browser session in Amazon Bedrock AgentCore. 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:
Retrieves detailed information about a specific code interpreter session in Amazon Bedrock AgentCore. 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:
Retrieves information about a specific event in an AgentCore Memory resource.
To use this operation, you must have the bedrock-agentcore:GetEvent permission.
Retrieves a specific memory record from an AgentCore Memory resource.
To use this operation, you must have the bedrock-agentcore:GetMemoryRecord permission.
Retrieves detailed information about a recommendation, including its configuration, status, and results.
", "readonly":true }, "GetResourceApiKey":{ "name":"GetResourceApiKey", "http":{ "method":"POST", "requestUri":"/identities/api-key", "responseCode":200 }, "input":{"shape":"GetResourceApiKeyRequest"}, "output":{"shape":"GetResourceApiKeyResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Retrieves the API key associated with an API key credential provider.
", "readonly":true }, "GetResourceOauth2Token":{ "name":"GetResourceOauth2Token", "http":{ "method":"POST", "requestUri":"/identities/oauth2/token", "responseCode":200 }, "input":{"shape":"GetResourceOauth2TokenRequest"}, "output":{"shape":"GetResourceOauth2TokenResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Returns the OAuth 2.0 token of the provided resource.
", "readonly":true }, "GetWorkloadAccessToken":{ "name":"GetWorkloadAccessToken", "http":{ "method":"POST", "requestUri":"/identities/GetWorkloadAccessToken", "responseCode":200 }, "input":{"shape":"GetWorkloadAccessTokenRequest"}, "output":{"shape":"GetWorkloadAccessTokenResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Obtains a workload access token for agentic workloads not acting on behalf of a user.
" }, "GetWorkloadAccessTokenForJWT":{ "name":"GetWorkloadAccessTokenForJWT", "http":{ "method":"POST", "requestUri":"/identities/GetWorkloadAccessTokenForJWT", "responseCode":200 }, "input":{"shape":"GetWorkloadAccessTokenForJWTRequest"}, "output":{"shape":"GetWorkloadAccessTokenForJWTResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Obtains a workload access token for agentic workloads acting on behalf of a user, using a JWT token.
" }, "GetWorkloadAccessTokenForUserId":{ "name":"GetWorkloadAccessTokenForUserId", "http":{ "method":"POST", "requestUri":"/identities/GetWorkloadAccessTokenForUserId", "responseCode":200 }, "input":{"shape":"GetWorkloadAccessTokenForUserIdRequest"}, "output":{"shape":"GetWorkloadAccessTokenForUserIdResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Obtains a workload access token for agentic workloads acting on behalf of a user, using the user's ID.
" }, "InvokeAgentRuntime":{ "name":"InvokeAgentRuntime", "http":{ "method":"POST", "requestUri":"/runtimes/{agentRuntimeArn}/invocations", "responseCode":200 }, "input":{"shape":"InvokeAgentRuntimeRequest"}, "output":{"shape":"InvokeAgentRuntimeResponse"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"RuntimeClientError"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"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 can specify either the AgentCore Runtime ARN or the agent ID with an account ID, and provide a payload containing your request. When you use the agent ID instead of the full ARN, you don't need to URL-encode the identifier. You can optionally specify a qualifier to target a specific 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. If you are making a call to InvokeAgentRuntime on behalf of a user ID with the X-Amzn-Bedrock-AgentCore-Runtime-User-Id header, You require permissions to both actions (bedrock-agentcore:InvokeAgentRuntime and bedrock-agentcore:InvokeAgentRuntimeForUser).
Executes a command in a runtime session container and streams the output back to the caller. This operation allows you to run shell commands within the agent runtime environment and receive real-time streaming responses including standard output and standard error.
To invoke a command, you must specify the agent runtime ARN and a runtime session ID. The command execution supports streaming responses, allowing you to receive output as it becomes available through contentStart, contentDelta, and contentStop events.
To use this operation, you must have the bedrock-agentcore:InvokeAgentRuntimeCommand permission.
Invokes an operating system-level action on a browser session in Amazon Bedrock AgentCore. This operation provides direct OS-level control over browser sessions, enabling mouse actions, keyboard input, and screenshots that the WebSocket-based Chrome DevTools Protocol (CDP) cannot handle — such as interacting with print dialogs, context menus, and JavaScript alerts.
You send a request with exactly one action in the BrowserAction union, and receive a corresponding result in the BrowserActionResult union.
The following operations are related to InvokeBrowser:
Executes code within an active code interpreter session in Amazon Bedrock AgentCore. 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:
Operation to invoke a Harness.
" }, "ListABTests":{ "name":"ListABTests", "http":{ "method":"GET", "requestUri":"/ab-tests", "responseCode":200 }, "input":{"shape":"ListABTestsRequest"}, "output":{"shape":"ListABTestsResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Lists all A/B tests in the account.
", "readonly":true }, "ListActors":{ "name":"ListActors", "http":{ "method":"POST", "requestUri":"/memories/{memoryId}/actors", "responseCode":200 }, "input":{"shape":"ListActorsInput"}, "output":{"shape":"ListActorsOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottledException"}, {"shape":"ServiceException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"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.
Lists all batch evaluations in the account, providing summary information about each evaluation's status and configuration.
", "readonly":true }, "ListBrowserSessions":{ "name":"ListBrowserSessions", "http":{ "method":"POST", "requestUri":"/browsers/{browserIdentifier}/sessions/list", "responseCode":200 }, "input":{"shape":"ListBrowserSessionsRequest"}, "output":{"shape":"ListBrowserSessionsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Retrieves a list of browser sessions in Amazon Bedrock AgentCore 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:
Retrieves a list of code interpreter sessions in Amazon Bedrock AgentCore 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:
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.
Lists all long-term memory extraction jobs that are eligible to be started with optional filtering.
To use this operation, you must have the bedrock-agentcore:ListMemoryExtractionJobs permission.
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.
Lists all recommendations in the account, with optional filtering by status.
", "readonly":true }, "ListSessions":{ "name":"ListSessions", "http":{ "method":"POST", "requestUri":"/memories/{memoryId}/actor/{actorId}/sessions", "responseCode":200 }, "input":{"shape":"ListSessionsInput"}, "output":{"shape":"ListSessionsOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottledException"}, {"shape":"ServiceException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Lists sessions in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.
Empty sessions are automatically deleted after one day.
To use this operation, you must have the bedrock-agentcore:ListSessions permission.
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.
Saves the current state of a browser session as a reusable profile in Amazon Bedrock AgentCore. A browser profile captures persistent browser data such as cookies and local storage from an active session, enabling you to reuse this data in future browser sessions.
To save a browser session profile, you must specify the profile identifier, browser identifier, and session ID. The session must be active when saving the profile. Once saved, the profile can be used with the StartBrowserSession operation to initialize new sessions with the stored browser state.
Browser profiles are useful for scenarios that require persistent authentication, maintaining user preferences across sessions, or continuing tasks that depend on previously stored browser data.
The following operations are related to SaveBrowserSessionProfile:
Searches for registry records using semantic, lexical, or hybrid queries. Returns metadata for matching records ordered by relevance within the specified registry.
" }, "StartBatchEvaluation":{ "name":"StartBatchEvaluation", "http":{ "method":"POST", "requestUri":"/evaluations/batch-evaluate", "responseCode":202 }, "input":{"shape":"StartBatchEvaluationRequest"}, "output":{"shape":"StartBatchEvaluationResponse"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"UnauthorizedException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Starts a batch evaluation job that evaluates agent performance across multiple sessions. Batch evaluations pull agent traces from CloudWatch Logs or an existing online evaluation configuration and run specified evaluators and insights against them.
", "idempotent":true }, "StartBrowserSession":{ "name":"StartBrowserSession", "http":{ "method":"PUT", "requestUri":"/browsers/{browserIdentifier}/sessions/start", "responseCode":200 }, "input":{"shape":"StartBrowserSessionRequest"}, "output":{"shape":"StartBrowserSessionResponse"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Creates and initializes a browser session in Amazon Bedrock AgentCore. 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:
Creates and initializes a code interpreter session in Amazon Bedrock AgentCore. 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:
Starts a memory extraction job that processes events that failed extraction previously in an AgentCore Memory resource and produces structured memory records. When earlier extraction attempts have left events unprocessed, this job will pick up and extract those as well.
To use this operation, you must have the bedrock-agentcore:StartMemoryExtractionJob permission.
Starts a recommendation job that analyzes agent traces and generates optimization suggestions for system prompts or tool descriptions to improve agent performance.
" }, "StopBatchEvaluation":{ "name":"StopBatchEvaluation", "http":{ "method":"POST", "requestUri":"/evaluations/batch-evaluate/{batchEvaluationId}/stop", "responseCode":202 }, "input":{"shape":"StopBatchEvaluationRequest"}, "output":{"shape":"StopBatchEvaluationResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"Stops a running batch evaluation. Sessions that have already been evaluated retain their results.
" }, "StopBrowserSession":{ "name":"StopBrowserSession", "http":{ "method":"PUT", "requestUri":"/browsers/{browserIdentifier}/sessions/stop", "responseCode":200 }, "input":{"shape":"StopBrowserSessionRequest"}, "output":{"shape":"StopBrowserSessionResponse"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Terminates an active browser session in Amazon Bedrock AgentCore. 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:
Terminates an active code interpreter session in Amazon Bedrock AgentCore. 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:
Stops a session that is running in an running AgentCore Runtime agent.
", "idempotent":true }, "UpdateABTest":{ "name":"UpdateABTest", "http":{ "method":"PUT", "requestUri":"/ab-tests/{abTestId}", "responseCode":202 }, "input":{"shape":"UpdateABTestRequest"}, "output":{"shape":"UpdateABTestResponse"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"UnauthorizedException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"Updates an A/B test's configuration, including variants, traffic allocation, evaluation settings, or execution status.
", "idempotent":true }, "UpdateBrowserStream":{ "name":"UpdateBrowserStream", "http":{ "method":"PUT", "requestUri":"/browsers/{browserIdentifier}/sessions/streams/update", "responseCode":200 }, "input":{"shape":"UpdateBrowserStreamRequest"}, "output":{"shape":"UpdateBrowserStreamResponse"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Updates a browser stream. To use this operation, you must have permissions to perform the bedrock:UpdateBrowserStream action.
", "idempotent":true } }, "shapes":{ "A2aDescriptor":{ "type":"structure", "required":["agentCard"], "members":{ "agentCard":{ "shape":"AgentCardDefinition", "documentation":"The agent card definition that describes the agent's capabilities and interface.
" } }, "documentation":"The A2A (Agent-to-Agent) descriptor configuration for a registry record.
" }, "ABTestArn":{ "type":"string", "pattern":"arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:ab-test/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}" }, "ABTestDescription":{ "type":"string", "max":200, "min":1 }, "ABTestEvaluationConfig":{ "type":"structure", "members":{ "onlineEvaluationConfigArn":{ "shape":"OnlineEvaluationConfigArn", "documentation":"The Amazon Resource Name (ARN) of a single online evaluation configuration to use for both variants.
" }, "perVariantOnlineEvaluationConfig":{ "shape":"PerVariantOnlineEvaluationConfigList", "documentation":"Per-variant online evaluation configurations, allowing different evaluation settings for each variant.
" } }, "documentation":"The evaluation configuration for an A/B test, specifying which online evaluation configurations to use for measuring variant performance.
", "union":true }, "ABTestExecutionStatus":{ "type":"string", "enum":[ "PAUSED", "RUNNING", "STOPPED", "NOT_STARTED" ] }, "ABTestId":{ "type":"string", "pattern":"[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}" }, "ABTestName":{ "type":"string", "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,47}" }, "ABTestResults":{ "type":"structure", "required":["evaluatorMetrics"], "members":{ "analysisTimestamp":{ "shape":"Timestamp", "documentation":"The timestamp when the analysis was performed.
" }, "evaluatorMetrics":{ "shape":"EvaluatorMetricList", "documentation":"The per-evaluator metrics comparing control and treatment variants.
" } }, "documentation":"The statistical results of an A/B test.
" }, "ABTestStatus":{ "type":"string", "enum":[ "CREATING", "ACTIVE", "CREATE_FAILED", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETE_FAILED", "FAILED" ] }, "ABTestSummary":{ "type":"structure", "required":[ "abTestId", "abTestArn", "name", "status", "executionStatus", "createdAt", "updatedAt" ], "members":{ "abTestId":{ "shape":"ABTestId", "documentation":"The unique identifier of the A/B test.
" }, "abTestArn":{ "shape":"ABTestArn", "documentation":"The Amazon Resource Name (ARN) of the A/B test.
" }, "name":{ "shape":"ABTestName", "documentation":"The name of the A/B test.
" }, "status":{ "shape":"ABTestStatus", "documentation":"The current status of the A/B test.
" }, "executionStatus":{ "shape":"ABTestExecutionStatus", "documentation":"The execution status of the A/B test.
" }, "description":{ "shape":"ABTestDescription", "documentation":"The description of the A/B test.
" }, "gatewayArn":{ "shape":"GatewayArn", "documentation":"The Amazon Resource Name (ARN) of the gateway used for traffic splitting.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The timestamp when the A/B test was created.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The timestamp when the A/B test was last updated.
" } }, "documentation":"Summary information about an A/B test.
" }, "ABTestSummaryList":{ "type":"list", "member":{"shape":"ABTestSummary"} }, "AccessDeniedException":{ "type":"structure", "members":{ "message":{"shape":"NonBlankString"} }, "documentation":"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.
", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "AccessTokenType":{ "type":"string", "max":131072, "min":1, "sensitive":true }, "ActorId":{ "type":"string", "max":255, "min":1, "pattern":"[a-zA-Z0-9][a-zA-Z0-9-_/]*(?::[a-zA-Z0-9-_/]+)*[a-zA-Z0-9-_/]*" }, "ActorSummary":{ "type":"structure", "required":["actorId"], "members":{ "actorId":{ "shape":"ActorId", "documentation":"The unique identifier of the actor.
" } }, "documentation":"Contains summary information about an actor in an AgentCore Memory resource.
" }, "ActorSummaryList":{ "type":"list", "member":{"shape":"ActorSummary"} }, "AgentCard":{ "type":"structure", "members":{}, "document":true }, "AgentCardDefinition":{ "type":"structure", "members":{ "schemaVersion":{ "shape":"SchemaVersion", "documentation":"The schema version of the agent card definition.
" }, "inlineContent":{ "shape":"InlineContent", "documentation":"The inline content of the agent card definition.
" } }, "documentation":"The agent card definition for A2A descriptors, including the schema version and inline content that describes the agent's capabilities.
" }, "AgentSkillsDescriptor":{ "type":"structure", "required":["skillMd"], "members":{ "skillMd":{ "shape":"SkillMdDefinition", "documentation":"The skill description in markdown format.
" }, "skillDefinition":{ "shape":"SkillDefinition", "documentation":"The structured skill definition with a schema version and content.
" } }, "documentation":"The agent skills descriptor configuration for a registry record.
" }, "AgentTracesConfig":{ "type":"structure", "members":{ "sessionSpans":{ "shape":"Spans", "documentation":"Agent traces provided as inline session spans in OpenTelemetry format.
" }, "cloudwatchLogs":{ "shape":"CloudWatchLogsTraceConfig", "documentation":"Agent traces read from CloudWatch Logs.
" } }, "documentation":"The configuration specifying where to read agent traces from for recommendation analysis.
", "union":true }, "ApiKeyArn":{ "type":"string", "pattern":"arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/apikeycredentialprovider/[a-zA-Z0-9-.]+" }, "ApiKeyType":{ "type":"string", "max":65536, "min":1, "sensitive":true }, "AudienceType":{ "type":"string", "max":2048, "min":1 }, "AudiencesListType":{ "type":"list", "member":{"shape":"AudienceType"} }, "AuthorizationUrlType":{ "type":"string", "min":1, "sensitive":true }, "AutomationStream":{ "type":"structure", "required":[ "streamEndpoint", "streamStatus" ], "members":{ "streamEndpoint":{ "shape":"BrowserStreamEndpoint", "documentation":"The endpoint URL for the automation stream. This URL is used to establish a WebSocket connection to the stream for sending commands and receiving responses.
" }, "streamStatus":{ "shape":"AutomationStreamStatus", "documentation":"The current status of the automation stream. This indicates whether the stream is available for use. Possible values include ACTIVE, CONNECTING, and DISCONNECTED.
" } }, "documentation":"The configuration for a stream that enables programmatic control of a browser session in Amazon Bedrock AgentCore. This stream provides a bidirectional communication channel for sending commands to the browser and receiving responses, allowing agents to automate web interactions such as navigation, form filling, and element clicking.
" }, "AutomationStreamStatus":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "AutomationStreamUpdate":{ "type":"structure", "members":{ "streamStatus":{ "shape":"AutomationStreamStatus", "documentation":"The status of the automation stream.
" } }, "documentation":"Contains information about an update to an automation stream.
" }, "BasicAuth":{ "type":"structure", "required":["secretArn"], "members":{ "secretArn":{ "shape":"SecretArn", "documentation":"The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing proxy credentials. The secret must be a JSON object with username and password string fields that meet validation requirements. The caller must have secretsmanager:GetSecretValue permission for this ARN. Example secret format: {\"username\": \"proxy_user\", \"password\": \"secure_password\"}
Configuration for HTTP Basic Authentication using credentials stored in Amazon Web Services Secrets Manager. The secret must contain a JSON object with username and password string fields. Username allows alphanumeric characters and @._+=- symbols (pattern: ^[a-zA-Z0-9@._+=\\-]+$). Password allows alphanumeric characters and @._+=-!#$%&* symbols (pattern: ^[a-zA-Z0-9@._+=\\-!#$%&*]+$). Both fields have a maximum length of 256 characters.
The unique ID of the memory resource where records will be created.
", "location":"uri", "locationName":"memoryId" }, "records":{ "shape":"MemoryRecordsCreateInputList", "documentation":"A list of memory record creation inputs to be processed in the batch operation.
" }, "clientToken":{ "shape":"String", "documentation":"A unique, case-sensitive identifier to ensure idempotent processing of the batch request.
", "idempotencyToken":true } } }, "BatchCreateMemoryRecordsOutput":{ "type":"structure", "required":[ "successfulRecords", "failedRecords" ], "members":{ "successfulRecords":{ "shape":"MemoryRecordsOutputList", "documentation":"A list of memory records that were successfully created during the batch operation.
" }, "failedRecords":{ "shape":"MemoryRecordsOutputList", "documentation":"A list of memory records that failed to be created, including error details for each failure.
" } } }, "BatchDeleteMemoryRecordsInput":{ "type":"structure", "required":[ "memoryId", "records" ], "members":{ "memoryId":{ "shape":"MemoryId", "documentation":"The unique ID of the memory resource where records will be deleted.
", "location":"uri", "locationName":"memoryId" }, "records":{ "shape":"MemoryRecordsDeleteInputList", "documentation":"A list of memory record deletion inputs to be processed in the batch operation.
" } } }, "BatchDeleteMemoryRecordsOutput":{ "type":"structure", "required":[ "successfulRecords", "failedRecords" ], "members":{ "successfulRecords":{ "shape":"MemoryRecordsOutputList", "documentation":"A list of memory records that were successfully deleted during the batch operation.
" }, "failedRecords":{ "shape":"MemoryRecordsOutputList", "documentation":"A list of memory records that failed to be deleted, including error details for each failure.
" } } }, "BatchEvaluationArn":{ "type":"string", "documentation":"ARN for a batch evaluation
" }, "BatchEvaluationDescription":{ "type":"string", "max":200, "min":0 }, "BatchEvaluationId":{ "type":"string", "documentation":"Unique identifier for a batch evaluation (name-prefixed format)
", "pattern":"[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}" }, "BatchEvaluationName":{ "type":"string", "documentation":"Human-readable name for a batch evaluation
", "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,47}" }, "BatchEvaluationStatus":{ "type":"string", "enum":[ "PENDING", "IN_PROGRESS", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "STOPPING", "STOPPED", "DELETING" ] }, "BatchEvaluationSummary":{ "type":"structure", "required":[ "batchEvaluationId", "batchEvaluationArn", "batchEvaluationName", "status", "createdAt" ], "members":{ "batchEvaluationId":{ "shape":"BatchEvaluationId", "documentation":"The unique identifier of the batch evaluation.
" }, "batchEvaluationArn":{ "shape":"BatchEvaluationArn", "documentation":"The Amazon Resource Name (ARN) of the batch evaluation.
" }, "batchEvaluationName":{ "shape":"BatchEvaluationName", "documentation":"The name of the batch evaluation.
" }, "status":{ "shape":"BatchEvaluationStatus", "documentation":"The current status of the batch evaluation.
" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The timestamp when the batch evaluation was created.
" }, "description":{ "shape":"BatchEvaluationDescription", "documentation":"The description of the batch evaluation.
" }, "evaluators":{ "shape":"EvaluatorList", "documentation":"The list of evaluators applied during the batch evaluation.
" }, "evaluationResults":{ "shape":"EvaluationJobResults", "documentation":"The aggregated evaluation results.
" }, "errorDetails":{ "shape":"ErrorDetailsList", "documentation":"The error details if the batch evaluation encountered failures.
" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The timestamp when the batch evaluation was last updated.
" } }, "documentation":"Summary representation for list responses
" }, "BatchEvaluationSummaryList":{ "type":"list", "member":{"shape":"BatchEvaluationSummary"} }, "BatchUpdateMemoryRecordsInput":{ "type":"structure", "required":[ "memoryId", "records" ], "members":{ "memoryId":{ "shape":"MemoryId", "documentation":"The unique ID of the memory resource where records will be updated.
", "location":"uri", "locationName":"memoryId" }, "records":{ "shape":"MemoryRecordsUpdateInputList", "documentation":"A list of memory record update inputs to be processed in the batch operation.
" } } }, "BatchUpdateMemoryRecordsOutput":{ "type":"structure", "required":[ "successfulRecords", "failedRecords" ], "members":{ "successfulRecords":{ "shape":"MemoryRecordsOutputList", "documentation":"A list of memory records that were successfully updated during the batch operation.
" }, "failedRecords":{ "shape":"MemoryRecordsOutputList", "documentation":"A list of memory records that failed to be updated, including error details for each failure.
" } } }, "Blob":{"type":"blob"}, "Body":{ "type":"blob", "max":100000000, "min":0, "sensitive":true }, "Boolean":{ "type":"boolean", "box":true }, "Branch":{ "type":"structure", "required":["name"], "members":{ "rootEventId":{ "shape":"EventId", "documentation":"The identifier of the root event for this branch.
" }, "name":{ "shape":"BranchName", "documentation":"The name of the branch.
" } }, "documentation":"Contains information about a branch in an AgentCore Memory resource. Branches allow for organizing events into different conversation threads or paths.
" }, "BranchFilter":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"BranchName", "documentation":"The name of the branch to filter by.
" }, "includeParentBranches":{ "shape":"Boolean", "documentation":"Specifies whether to include parent branches in the results. Set to true to include parent branches, or false to exclude them.
" } }, "documentation":"Contains filter criteria for branches when listing events.
" }, "BranchName":{ "type":"string", "max":100, "min":1, "pattern":"[a-zA-Z0-9][a-zA-Z0-9-_]*" }, "BrowserAction":{ "type":"structure", "members":{ "mouseClick":{ "shape":"MouseClickArguments", "documentation":"Click at the specified coordinates.
" }, "mouseMove":{ "shape":"MouseMoveArguments", "documentation":"Move the cursor to the specified coordinates.
" }, "mouseDrag":{ "shape":"MouseDragArguments", "documentation":"Drag from a start position to an end position.
" }, "mouseScroll":{ "shape":"MouseScrollArguments", "documentation":"Scroll at the specified position.
" }, "keyType":{ "shape":"KeyTypeArguments", "documentation":"Type a string of text.
" }, "keyPress":{ "shape":"KeyPressArguments", "documentation":"Press a key one or more times.
" }, "keyShortcut":{ "shape":"KeyShortcutArguments", "documentation":"Press a key combination.
" }, "screenshot":{ "shape":"ScreenshotArguments", "documentation":"Capture a full-screen screenshot.
" } }, "documentation":"The browser action to perform. Exactly one member must be set per request.
", "union":true }, "BrowserActionResult":{ "type":"structure", "members":{ "mouseClick":{ "shape":"MouseClickResult", "documentation":"The result of a mouse click action.
" }, "mouseMove":{ "shape":"MouseMoveResult", "documentation":"The result of a mouse move action.
" }, "mouseDrag":{ "shape":"MouseDragResult", "documentation":"The result of a mouse drag action.
" }, "mouseScroll":{ "shape":"MouseScrollResult", "documentation":"The result of a mouse scroll action.
" }, "keyType":{ "shape":"KeyTypeResult", "documentation":"The result of a key type action.
" }, "keyPress":{ "shape":"KeyPressResult", "documentation":"The result of a key press action.
" }, "keyShortcut":{ "shape":"KeyShortcutResult", "documentation":"The result of a key shortcut action.
" }, "screenshot":{ "shape":"ScreenshotResult", "documentation":"The result of a screenshot action.
" } }, "documentation":"The result of a browser action execution. Exactly one member is set, matching the action that was performed.
", "union":true }, "BrowserActionStatus":{ "type":"string", "documentation":"The status of a browser action execution.
", "enum":[ "SUCCESS", "FAILED" ] }, "BrowserArn":{ "type":"string", "pattern":"arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:(aws|[0-9]{12}):browser(-custom)?/(aws\\.browser\\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})" }, "BrowserEnterprisePolicies":{ "type":"list", "member":{"shape":"BrowserEnterprisePolicy"}, "max":100, "min":0 }, "BrowserEnterprisePolicy":{ "type":"structure", "required":["location"], "members":{ "location":{ "shape":"ResourceLocation", "documentation":"The location of the enterprise policy file.
" }, "type":{ "shape":"BrowserEnterprisePolicyType", "documentation":"The enterprise policy type. See BrowserEnterprisePolicyType.
" } }, "documentation":"Browser enterprise policy configuration.
" }, "BrowserEnterprisePolicyType":{ "type":"string", "documentation":"The type of browser enterprise policy. Available values are MANAGED and RECOMMENDED.
The location where the browser extension files are stored. This specifies the source from which the extension will be loaded and installed.
" } }, "documentation":"Browser extension configuration.
" }, "BrowserExtensions":{ "type":"list", "member":{"shape":"BrowserExtension"}, "max":10, "min":1 }, "BrowserProfileConfiguration":{ "type":"structure", "required":["profileIdentifier"], "members":{ "profileIdentifier":{ "shape":"BrowserProfileId", "documentation":"The unique identifier of the browser profile. This identifier is used to reference the profile when starting new browser sessions or saving session data to the profile.
" } }, "documentation":"The configuration for a browser profile in Amazon Bedrock AgentCore. A browser profile contains persistent browser data such as cookies and local storage that can be saved from one browser session and reused in subsequent sessions. Browser profiles enable continuity for tasks that require authentication, maintain user preferences, or depend on previously stored browser state.
" }, "BrowserProfileId":{ "type":"string", "pattern":"[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}" }, "BrowserSessionId":{ "type":"string", "pattern":"[0-9a-zA-Z]{1,40}" }, "BrowserSessionStatus":{ "type":"string", "enum":[ "READY", "TERMINATED" ] }, "BrowserSessionStream":{ "type":"structure", "required":["automationStream"], "members":{ "automationStream":{ "shape":"AutomationStream", "documentation":"The stream that enables programmatic control of the browser. This stream allows agents to perform actions such as navigating to URLs, clicking elements, and filling forms.
" }, "liveViewStream":{ "shape":"LiveViewStream", "documentation":"The stream that provides a visual representation of the browser content. This stream allows agents to observe the current state of the browser, including rendered web pages and visual elements.
" } }, "documentation":"The collection of streams associated with a browser session in Amazon Bedrock AgentCore. These streams provide different ways to interact with and observe the browser session, including programmatic control and visual representation of the browser content.
" }, "BrowserSessionSummaries":{ "type":"list", "member":{"shape":"BrowserSessionSummary"} }, "BrowserSessionSummary":{ "type":"structure", "required":[ "browserIdentifier", "sessionId", "status", "createdAt" ], "members":{ "browserIdentifier":{ "shape":"String", "documentation":"The unique identifier of the browser associated with the session. This identifier specifies which browser environment is used for the session.
" }, "sessionId":{ "shape":"BrowserSessionId", "documentation":"The unique identifier of the browser session. This identifier is used in operations that interact with the session.
" }, "name":{ "shape":"Name", "documentation":"The name of the browser session. This name helps identify and manage the session.
" }, "status":{ "shape":"BrowserSessionStatus", "documentation":"The current status of the browser session. Possible values include ACTIVE, STOPPING, and STOPPED.
" }, "createdAt":{ "shape":"DateTimestamp", "documentation":"The timestamp when the browser session was created. This value is in ISO 8601 format.
" }, "lastUpdatedAt":{ "shape":"DateTimestamp", "documentation":"The timestamp when the browser session was last updated. This value is in ISO 8601 format.
" } }, "documentation":"A condensed representation of a browser session in Amazon Bedrock AgentCore. This structure contains key information about a browser session, including identifiers, status, and timestamps, without the full details of the session configuration and streams.
" }, "BrowserSessionTimeout":{ "type":"integer", "box":true, "max":28800, "min":1 }, "BrowserStreamEndpoint":{ "type":"string", "max":512, "min":10 }, "Certificate":{ "type":"structure", "required":["location"], "members":{ "location":{ "shape":"CertificateLocation", "documentation":"The location of the certificate.
" } }, "documentation":"A certificate to install in the browser or code interpreter session.
" }, "CertificateLocation":{ "type":"structure", "members":{ "secretsManager":{ "shape":"SecretsManagerLocation", "documentation":"The Amazon Web Services Secrets Manager location of the certificate.
" } }, "documentation":"The location from which to retrieve a certificate.
", "union":true }, "Certificates":{ "type":"list", "member":{"shape":"Certificate"}, "max":200, "min":1 }, "ClientToken":{ "type":"string", "max":256, "min":33, "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}" }, "CloudWatchFilterConfig":{ "type":"structure", "members":{ "sessionIds":{ "shape":"CloudWatchFilterConfigSessionIdsList", "documentation":"A list of specific session IDs to evaluate. If specified, only these sessions are included in the evaluation.
" }, "timeRange":{ "shape":"SessionFilterConfig", "documentation":"The time range filter for selecting sessions to evaluate.
" } }, "documentation":"Filter configuration for narrowing down CloudWatch Logs sessions for evaluation.
" }, "CloudWatchFilterConfigSessionIdsList":{ "type":"list", "member":{"shape":"String"}, "max":500, "min":0 }, "CloudWatchLogsFilter":{ "type":"structure", "required":[ "key", "operator", "value" ], "members":{ "key":{ "shape":"CloudWatchLogsFilterKeyString", "documentation":"The key or field name to filter on within the agent trace data.
" }, "operator":{ "shape":"CloudWatchLogsFilterOperator", "documentation":"The comparison operator to use for filtering.
" }, "value":{ "shape":"FilterValue", "documentation":"The value to compare against using the specified operator.
" } }, "documentation":"A filter for narrowing down agent traces from CloudWatch Logs based on key-value comparisons.
" }, "CloudWatchLogsFilterKeyString":{ "type":"string", "max":256, "min":1, "pattern":"[a-zA-Z0-9._-]+" }, "CloudWatchLogsFilterList":{ "type":"list", "member":{"shape":"CloudWatchLogsFilter"} }, "CloudWatchLogsFilterOperator":{ "type":"string", "enum":[ "Equals", "NotEquals", "GreaterThan", "LessThan", "GreaterThanOrEqual", "LessThanOrEqual", "Contains", "NotContains" ] }, "CloudWatchLogsRule":{ "type":"structure", "members":{ "filters":{ "shape":"CloudWatchLogsFilterList", "documentation":"The list of filters to apply when reading agent traces.
" } }, "documentation":"A rule configuration for filtering agent traces from CloudWatch Logs.
" }, "CloudWatchLogsSource":{ "type":"structure", "required":[ "serviceNames", "logGroupNames" ], "members":{ "serviceNames":{ "shape":"CloudWatchLogsSourceServiceNamesList", "documentation":"The list of agent service names to filter traces within the specified log groups.
" }, "logGroupNames":{ "shape":"CloudWatchLogsSourceLogGroupNamesList", "documentation":"The list of CloudWatch log group names to read agent traces from. Maximum of 5 log groups.
" }, "filterConfig":{ "shape":"CloudWatchFilterConfig", "documentation":"Optional filter configuration to narrow down which sessions to evaluate.
" } }, "documentation":"The configuration for reading agent traces from CloudWatch Logs.
" }, "CloudWatchLogsSourceLogGroupNamesList":{ "type":"list", "member":{"shape":"String"}, "max":5, "min":1 }, "CloudWatchLogsSourceServiceNamesList":{ "type":"list", "member":{"shape":"String"}, "max":1, "min":1 }, "CloudWatchLogsTraceConfig":{ "type":"structure", "required":[ "logGroupArns", "serviceNames", "startTime", "endTime" ], "members":{ "logGroupArns":{ "shape":"CloudWatchLogsTraceConfigLogGroupArnsList", "documentation":"The list of CloudWatch log group ARNs to read agent traces from.
" }, "serviceNames":{ "shape":"ServiceNameList", "documentation":"The list of service names to filter traces within the specified log groups.
" }, "startTime":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The start time of the time range to read traces from.
" }, "endTime":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The end time of the time range to read traces from.
" }, "rule":{ "shape":"CloudWatchLogsRule", "documentation":"Optional rule configuration for filtering traces.
" } }, "documentation":"Configuration for reading agent traces from CloudWatch Logs for recommendation analysis.
" }, "CloudWatchLogsTraceConfigLogGroupArnsList":{ "type":"list", "member":{"shape":"String"}, "max":5, "min":1 }, "CloudWatchOutputConfig":{ "type":"structure", "required":[ "logGroupName", "logStreamName" ], "members":{ "logGroupName":{ "shape":"String", "documentation":"The name of the CloudWatch log group where evaluation results will be written.
" }, "logStreamName":{ "shape":"String", "documentation":"The name of the CloudWatch log stream where evaluation results will be written.
" } }, "documentation":"CloudWatch Logs destination for batch evaluation results
" }, "CodeInterpreterArn":{ "type":"string", "pattern":"arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:(aws|[0-9]{12}):code-interpreter(-custom)?/(aws\\.codeinterpreter\\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})" }, "CodeInterpreterResult":{ "type":"structure", "required":["content"], "members":{ "content":{ "shape":"ContentBlockList", "documentation":"The textual content of the execution result. This includes standard output from the code execution, such as print statements, console output, and text representations of results.
" }, "structuredContent":{ "shape":"ToolResultStructuredContent", "documentation":"The structured content of the execution result. This includes additional metadata about the execution, such as execution time, memory usage, and structured representations of output data. The format depends on the specific code interpreter and execution context.
" }, "isError":{ "shape":"Boolean", "documentation":"Indicates whether the result represents an error. If true, the content contains error messages or exception information. If false, the content contains successful execution results.
" } }, "documentation":"The output produced by executing code in a code interpreter session in Amazon Bedrock AgentCore. This structure contains the results of code execution, including textual output, structured data, and error information. Agents use these results to generate responses that incorporate computation, data analysis, and visualization.
", "event":true }, "CodeInterpreterSessionId":{ "type":"string", "pattern":"[0-9a-zA-Z]{1,40}" }, "CodeInterpreterSessionStatus":{ "type":"string", "enum":[ "READY", "TERMINATED" ] }, "CodeInterpreterSessionSummaries":{ "type":"list", "member":{"shape":"CodeInterpreterSessionSummary"} }, "CodeInterpreterSessionSummary":{ "type":"structure", "required":[ "codeInterpreterIdentifier", "sessionId", "status", "createdAt" ], "members":{ "codeInterpreterIdentifier":{ "shape":"String", "documentation":"The unique identifier of the code interpreter associated with the session. This identifier specifies which code interpreter environment is used for the session.
" }, "sessionId":{ "shape":"CodeInterpreterSessionId", "documentation":"The unique identifier of the code interpreter session. This identifier is used in operations that interact with the session.
" }, "name":{ "shape":"Name", "documentation":"The name of the code interpreter session. This name helps identify and manage the session.
" }, "status":{ "shape":"CodeInterpreterSessionStatus", "documentation":"The current status of the code interpreter session. Possible values include ACTIVE, STOPPING, and STOPPED.
" }, "createdAt":{ "shape":"DateTimestamp", "documentation":"The timestamp when the code interpreter session was created. This value is in ISO 8601 format.
" }, "lastUpdatedAt":{ "shape":"DateTimestamp", "documentation":"The timestamp when the code interpreter session was last updated. This value is in ISO 8601 format.
" } }, "documentation":"A condensed representation of a code interpreter session in Amazon Bedrock AgentCore. This structure contains key information about a code interpreter session, including identifiers, status, and timestamps, without the full details of the session configuration.
" }, "CodeInterpreterSessionTimeout":{ "type":"integer", "box":true, "max":28800, "min":1 }, "CodeInterpreterStreamOutput":{ "type":"structure", "members":{ "result":{"shape":"CodeInterpreterResult"}, "accessDeniedException":{"shape":"AccessDeniedException"}, "conflictException":{"shape":"ConflictException"}, "internalServerException":{"shape":"InternalServerException"}, "resourceNotFoundException":{"shape":"ResourceNotFoundException"}, "serviceQuotaExceededException":{"shape":"ServiceQuotaExceededException"}, "throttlingException":{"shape":"ThrottlingException"}, "validationException":{"shape":"ValidationException"} }, "documentation":"Contains output from a code interpreter stream.
", "eventstream":true }, "CommandExecutionStatus":{ "type":"string", "enum":[ "COMPLETED", "TIMED_OUT" ] }, "CompleteResourceTokenAuthRequest":{ "type":"structure", "required":[ "userIdentifier", "sessionUri" ], "members":{ "userIdentifier":{ "shape":"UserIdentifier", "documentation":"The OAuth2.0 token or user ID that was used to generate the workload access token used for initiating the user authorization flow to retrieve OAuth2.0 tokens.
" }, "sessionUri":{ "shape":"RequestUri", "documentation":"Unique identifier for the user's authentication session for retrieving OAuth2 tokens. This ID tracks the authorization flow state across multiple requests and responses during the OAuth2 authentication process.
" } } }, "CompleteResourceTokenAuthResponse":{ "type":"structure", "members":{} }, "ConfidenceInterval":{ "type":"structure", "members":{ "lower":{ "shape":"Double", "documentation":"The lower bound of the confidence interval.
" }, "upper":{ "shape":"Double", "documentation":"The upper bound of the confidence interval.
" } }, "documentation":"A confidence interval for a statistical measurement.
" }, "ConfigurationBundleArn":{ "type":"string", "pattern":"arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:configuration-bundle/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}" }, "ConfigurationBundleRef":{ "type":"structure", "required":[ "bundleArn", "bundleVersion" ], "members":{ "bundleArn":{ "shape":"ConfigurationBundleArn", "documentation":"The Amazon Resource Name (ARN) of the configuration bundle.
" }, "bundleVersion":{ "shape":"ConfigurationBundleVersion", "documentation":"The version of the configuration bundle.
" } }, "documentation":"A reference to a specific version of a configuration bundle.
" }, "ConfigurationBundleToolEntry":{ "type":"structure", "required":[ "toolName", "toolDescriptionJsonPath" ], "members":{ "toolName":{ "shape":"RecommendationToolName", "documentation":"The name of the tool.
" }, "toolDescriptionJsonPath":{ "shape":"String", "documentation":"The JSON path within the configuration bundle's components that contains the tool description.
" } }, "documentation":"Maps a tool name to its JSON path within a configuration bundle.
" }, "ConfigurationBundleToolEntryList":{ "type":"list", "member":{"shape":"ConfigurationBundleToolEntry"} }, "ConfigurationBundleVersion":{ "type":"string", "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" }, "ConfigurationBundleVersionId":{"type":"string"}, "ConflictException":{ "type":"structure", "members":{ "message":{"shape":"NonBlankString"} }, "documentation":"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.
", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "Content":{ "type":"structure", "members":{ "text":{ "shape":"ContentTextString", "documentation":"The text content of the memory item.
" } }, "documentation":"Contains the content of a memory item.
", "union":true }, "ContentBlock":{ "type":"structure", "required":["type"], "members":{ "type":{ "shape":"ContentBlockType", "documentation":"The type of content in the block.
" }, "text":{ "shape":"String", "documentation":"The text content of the block.
" }, "data":{ "shape":"Blob", "documentation":"The binary data content of the block.
" }, "mimeType":{ "shape":"String", "documentation":"The MIME type of the content.
" }, "uri":{ "shape":"String", "documentation":"The URI of the content.
" }, "name":{ "shape":"String", "documentation":"The name of the content block.
" }, "description":{ "shape":"String", "documentation":"The description of the content block.
" }, "size":{ "shape":"Long", "documentation":"The size of the content in bytes.
" }, "resource":{ "shape":"ResourceContent", "documentation":"The resource associated with the content block.
" } }, "documentation":"A block of content in a response.
" }, "ContentBlockList":{ "type":"list", "member":{"shape":"ContentBlock"} }, "ContentBlockType":{ "type":"string", "enum":[ "text", "image", "resource", "resource_link" ] }, "ContentDeltaEvent":{ "type":"structure", "members":{ "stdout":{ "shape":"String", "documentation":"The standard output content from the command execution. This field contains the incremental output written to stdout by the executing command.
" }, "stderr":{ "shape":"String", "documentation":"The standard error content from the command execution. This field contains the incremental output written to stderr by the executing command.
" } }, "documentation":"An event that contains incremental output from a command execution. This event streams standard output and standard error content as it becomes available during command execution.
" }, "ContentStartEvent":{ "type":"structure", "members":{}, "documentation":"An event that signals the start of content streaming from a command execution. This event is sent when the command begins producing output.
" }, "ContentStopEvent":{ "type":"structure", "required":[ "exitCode", "status" ], "members":{ "exitCode":{ "shape":"Integer", "documentation":"The exit code returned by the executed command. An exit code of 0 indicates successful execution, -1 indicates a platform error, and values greater than 0 indicate command-specific errors.
" }, "status":{ "shape":"CommandExecutionStatus", "documentation":"The final status of the command execution. Valid values are COMPLETED for successful completion or TIMED_OUT if the command exceeded the specified timeout.
An event that signals the completion of a command execution. This event contains the final status and exit code of the executed command.
" }, "ContentTextString":{ "type":"string", "max":100000, "min":1, "sensitive":true }, "Context":{ "type":"structure", "members":{ "spanContext":{ "shape":"SpanContext", "documentation":"The span context information that uniquely identifies the trace and span being evaluated, including session ID, trace ID, and span ID for precise targeting within the agent's execution flow.
" } }, "documentation":"The contextual information associated with an evaluation, including span context details that identify the specific traces and sessions being evaluated within the agent's execution flow.
", "union":true }, "ControlStats":{ "type":"structure", "required":[ "variantName", "sampleSize", "mean" ], "members":{ "variantName":{ "shape":"String", "documentation":"The name of the control variant.
" }, "sampleSize":{ "shape":"Integer", "documentation":"The number of sessions evaluated for the control variant.
" }, "mean":{ "shape":"Double", "documentation":"The mean evaluation score for the control variant.
" } }, "documentation":"Statistics for the control variant in an A/B test.
" }, "Conversational":{ "type":"structure", "required":[ "content", "role" ], "members":{ "content":{ "shape":"Content", "documentation":"The content of the conversation message.
" }, "role":{ "shape":"Role", "documentation":"The role of the participant in the conversation (for example, \"user\" or \"assistant\").
" } }, "documentation":"Contains conversational content for an event payload.
" }, "CreateABTestRequest":{ "type":"structure", "required":[ "name", "gatewayArn", "variants", "evaluationConfig", "roleArn" ], "members":{ "name":{ "shape":"ABTestName", "documentation":"The name of the A/B test. Must be unique within your account.
" }, "description":{ "shape":"ABTestDescription", "documentation":"The description of the A/B test.
" }, "gatewayArn":{ "shape":"GatewayArn", "documentation":"The Amazon Resource Name (ARN) of the gateway to use for traffic splitting.
" }, "variants":{ "shape":"VariantList", "documentation":"The list of variants for the A/B test. Must contain exactly two variants: a control (C) and a treatment (T1), each with a configuration bundle or target reference and a traffic weight.
" }, "gatewayFilter":{ "shape":"GatewayFilter", "documentation":"Optional filter to restrict which gateway target paths are included in the A/B test.
" }, "evaluationConfig":{ "shape":"ABTestEvaluationConfig", "documentation":"The evaluation configuration specifying which online evaluation configurations to use for measuring variant performance.
" }, "roleArn":{ "shape":"RoleArn", "documentation":"The IAM role ARN that grants permissions for the A/B test to access gateway and evaluation resources.
" }, "enableOnCreate":{ "shape":"Boolean", "documentation":"Whether to enable the A/B test immediately upon creation. If true, traffic splitting begins automatically.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.
", "idempotencyToken":true } } }, "CreateABTestResponse":{ "type":"structure", "required":[ "abTestId", "abTestArn", "status", "executionStatus", "createdAt" ], "members":{ "abTestId":{ "shape":"ABTestId", "documentation":"The unique identifier of the created A/B test.
" }, "abTestArn":{ "shape":"ABTestArn", "documentation":"The Amazon Resource Name (ARN) of the created A/B test.
" }, "name":{ "shape":"ABTestName", "documentation":"The name of the A/B test.
" }, "status":{ "shape":"ABTestStatus", "documentation":"The status of the A/B test.
" }, "executionStatus":{ "shape":"ABTestExecutionStatus", "documentation":"The execution status indicating whether the A/B test is currently running.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The timestamp when the A/B test was created.
" } } }, "CreateEventInput":{ "type":"structure", "required":[ "memoryId", "actorId", "eventTimestamp", "payload" ], "members":{ "memoryId":{ "shape":"MemoryId", "documentation":"The identifier of the AgentCore Memory resource in which to create the event.
", "location":"uri", "locationName":"memoryId" }, "actorId":{ "shape":"ActorId", "documentation":"The identifier of the actor associated with this event. An actor represents an entity that participates in sessions and generates events.
" }, "sessionId":{ "shape":"SessionId", "documentation":"The identifier of the session in which this event occurs. A session represents a sequence of related events.
" }, "eventTimestamp":{ "shape":"Timestamp", "documentation":"The timestamp when the event occurred. If not specified, the current time is used.
" }, "payload":{ "shape":"PayloadTypeList", "documentation":"The content payload of the event. This can include conversational data or binary content.
" }, "branch":{ "shape":"Branch", "documentation":"The branch information for this event. Branches allow for organizing events into different conversation threads or paths.
" }, "clientToken":{ "shape":"String", "documentation":"A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, AgentCore ignores the request, but does not return an error.
", "idempotencyToken":true }, "metadata":{ "shape":"MetadataMap", "documentation":"The key-value metadata to attach to the event.
" } } }, "CreateEventOutput":{ "type":"structure", "required":["event"], "members":{ "event":{ "shape":"Event", "documentation":"The event that was created.
" } } }, "CredentialProviderName":{ "type":"string", "max":128, "min":1, "pattern":"[a-zA-Z0-9\\-_]+" }, "CustomDescriptor":{ "type":"structure", "members":{ "inlineContent":{ "shape":"InlineContent", "documentation":"The inline content of the custom descriptor.
" } }, "documentation":"A custom descriptor configuration for a registry record.
" }, "CustomRequestKeyType":{ "type":"string", "max":256, "min":1, "pattern":"[a-zA-Z0-9\\-_\\.]+" }, "CustomRequestParametersType":{ "type":"map", "key":{"shape":"CustomRequestKeyType"}, "value":{"shape":"CustomRequestValueType"} }, "CustomRequestValueType":{ "type":"string", "max":2048, "min":1, "sensitive":true }, "DataSourceConfig":{ "type":"structure", "members":{ "cloudWatchLogs":{ "shape":"CloudWatchLogsSource", "documentation":"Pull session spans from CloudWatch
" } }, "documentation":"Where to pull session spans from
", "union":true }, "DateTimestamp":{ "type":"timestamp", "timestampFormat":"iso8601" }, "DeleteABTestRequest":{ "type":"structure", "required":["abTestId"], "members":{ "abTestId":{ "shape":"ABTestId", "documentation":"The unique identifier of the A/B test to delete.
", "location":"uri", "locationName":"abTestId" } } }, "DeleteABTestResponse":{ "type":"structure", "required":[ "abTestId", "abTestArn", "status" ], "members":{ "abTestId":{ "shape":"ABTestId", "documentation":"The unique identifier of the deleted A/B test.
" }, "abTestArn":{ "shape":"ABTestArn", "documentation":"The Amazon Resource Name (ARN) of the deleted A/B test.
" }, "status":{ "shape":"ABTestStatus", "documentation":"The status of the A/B test deletion operation.
" } } }, "DeleteBatchEvaluationRequest":{ "type":"structure", "required":["batchEvaluationId"], "members":{ "batchEvaluationId":{ "shape":"BatchEvaluationId", "documentation":"The unique identifier of the batch evaluation to delete.
", "location":"uri", "locationName":"batchEvaluationId" } } }, "DeleteBatchEvaluationResponse":{ "type":"structure", "required":[ "batchEvaluationId", "batchEvaluationArn", "status" ], "members":{ "batchEvaluationId":{ "shape":"BatchEvaluationId", "documentation":"The unique identifier of the deleted batch evaluation.
" }, "batchEvaluationArn":{ "shape":"BatchEvaluationArn", "documentation":"The Amazon Resource Name (ARN) of the deleted batch evaluation.
" }, "status":{ "shape":"BatchEvaluationStatus", "documentation":"The status of the batch evaluation deletion operation.
" } } }, "DeleteEventInput":{ "type":"structure", "required":[ "memoryId", "sessionId", "eventId", "actorId" ], "members":{ "memoryId":{ "shape":"MemoryId", "documentation":"The identifier of the AgentCore Memory resource from which to delete the event.
", "location":"uri", "locationName":"memoryId" }, "sessionId":{ "shape":"SessionId", "documentation":"The identifier of the session containing the event to delete.
", "location":"uri", "locationName":"sessionId" }, "eventId":{ "shape":"EventId", "documentation":"The identifier of the event to delete.
", "location":"uri", "locationName":"eventId" }, "actorId":{ "shape":"ActorId", "documentation":"The identifier of the actor associated with the event to delete.
", "location":"uri", "locationName":"actorId" } } }, "DeleteEventOutput":{ "type":"structure", "required":["eventId"], "members":{ "eventId":{ "shape":"EventId", "documentation":"The identifier of the event that was deleted.
" } } }, "DeleteMemoryRecordInput":{ "type":"structure", "required":[ "memoryId", "memoryRecordId" ], "members":{ "memoryId":{ "shape":"MemoryId", "documentation":"The identifier of the AgentCore Memory resource from which to delete the memory record.
", "location":"uri", "locationName":"memoryId" }, "memoryRecordId":{ "shape":"MemoryRecordId", "documentation":"The identifier of the memory record to delete.
", "location":"uri", "locationName":"memoryRecordId" } } }, "DeleteMemoryRecordOutput":{ "type":"structure", "required":["memoryRecordId"], "members":{ "memoryRecordId":{ "shape":"MemoryRecordId", "documentation":"The identifier of the memory record that was deleted.
" } } }, "DeleteRecommendationRequest":{ "type":"structure", "required":["recommendationId"], "members":{ "recommendationId":{ "shape":"RecommendationId", "documentation":"The unique identifier of the recommendation to delete.
", "location":"uri", "locationName":"recommendationId" } } }, "DeleteRecommendationResponse":{ "type":"structure", "required":[ "recommendationId", "status" ], "members":{ "recommendationId":{ "shape":"RecommendationId", "documentation":"The unique identifier of the deleted recommendation.
" }, "status":{ "shape":"RecommendationStatus", "documentation":"The status of the recommendation deletion operation.
" } } }, "Description":{ "type":"string", "max":4096, "min":1, "sensitive":true }, "DescriptorType":{ "type":"string", "documentation":"The type of descriptor associated with a registry record.
", "enum":[ "MCP", "A2A", "CUSTOM", "AGENT_SKILLS" ] }, "Descriptors":{ "type":"structure", "members":{ "mcp":{ "shape":"McpDescriptor", "documentation":" The MCP (Model Context Protocol) descriptor configuration. Populated when the record's descriptorType is MCP.
The A2A (Agent-to-Agent) descriptor configuration. Populated when the record's descriptorType is A2A.
The custom descriptor configuration. Populated when the record's descriptorType is CUSTOM.
The agent skills descriptor configuration. Populated when the record's descriptorType is AGENT_SKILLS.
Contains the descriptor configuration for a registry record. Only the field that matches the record's descriptorType is populated.
An exception thrown when attempting to create a resource with an identifier that already exists.
", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "ErrorDetailsList":{ "type":"list", "member":{"shape":"ErrorDetailsListMemberString"}, "max":1, "min":0 }, "ErrorDetailsListMemberString":{ "type":"string", "max":1000, "min":0 }, "EvaluateRequest":{ "type":"structure", "required":[ "evaluatorId", "evaluationInput" ], "members":{ "evaluatorId":{ "shape":"EvaluatorId", "documentation":" The unique identifier of the evaluator to use for scoring. Can be a built-in evaluator (e.g., Builtin.Helpfulness, Builtin.Correctness) or a custom evaluator Id created through the control plane API.
The input data containing agent session spans to be evaluated. Includes a list of spans in OpenTelemetry format from supported frameworks like Strands (AgentCore Runtime) or LangGraph with OpenInference instrumentation.
" }, "evaluationTarget":{ "shape":"EvaluationTarget", "documentation":"The specific trace or span IDs to evaluate within the provided input. Allows targeting evaluation at different levels: individual tool calls, single request-response interactions (traces), or entire conversation sessions.
" }, "evaluationReferenceInputs":{ "shape":"EvaluationReferenceInputs", "documentation":"Ground truth data to compare against agent responses during evaluation. Allows to provide expected responses, assertions, and expected tool trajectories at different evaluation levels. Session-level reference inputs apply to the entire conversation, while trace-level reference inputs target specific request-response interactions identified by trace ID.
" } } }, "EvaluateResponse":{ "type":"structure", "required":["evaluationResults"], "members":{ "evaluationResults":{ "shape":"EvaluationResults", "documentation":"The detailed evaluation results containing scores, explanations, and metadata. Includes the evaluator information, numerical or categorical ratings based on the evaluator's rating scale, and token usage statistics for the evaluation process.
" } } }, "EvaluationContent":{ "type":"structure", "members":{ "text":{ "shape":"EvaluationContentTextString", "documentation":"The text content of the ground truth data. Used for expected response text and assertion statements.
" } }, "documentation":"A content block for ground truth data in evaluation reference inputs. Supports text content for expected responses and assertions.
", "union":true }, "EvaluationContentList":{ "type":"list", "member":{"shape":"EvaluationContent"}, "max":100, "min":1 }, "EvaluationContentTextString":{ "type":"string", "max":100000, "min":1 }, "EvaluationErrorCode":{ "type":"string", "max":1024, "min":1 }, "EvaluationErrorMessage":{ "type":"string", "max":2048, "min":0 }, "EvaluationExpectedTrajectory":{ "type":"structure", "members":{ "toolNames":{ "shape":"EvaluationToolNames", "documentation":"The list of tool names representing the expected tool call sequence.
" } }, "documentation":"The expected tool call trajectory for trajectory-based evaluation.
" }, "EvaluationExplanation":{ "type":"string", "max":2048, "min":0, "sensitive":true }, "EvaluationInput":{ "type":"structure", "members":{ "sessionSpans":{ "shape":"Spans", "documentation":"The collection of spans representing agent execution traces within a session. Each span contains detailed information about tool calls, model interactions, and other agent activities that can be evaluated for quality and performance.
" } }, "documentation":"The input data structure containing agent session spans in OpenTelemetry format. Supports traces from frameworks like Strands (AgentCore Runtime) and LangGraph with OpenInference instrumentation for comprehensive evaluation.
", "union":true }, "EvaluationJobResults":{ "type":"structure", "members":{ "numberOfSessionsCompleted":{ "shape":"Integer", "documentation":"The number of sessions that have been successfully evaluated.
" }, "numberOfSessionsInProgress":{ "shape":"Integer", "documentation":"The number of sessions currently being evaluated.
" }, "numberOfSessionsFailed":{ "shape":"Integer", "documentation":"The number of sessions that failed evaluation.
" }, "totalNumberOfSessions":{ "shape":"Integer", "documentation":"The total number of sessions included in the batch evaluation.
" }, "numberOfSessionsIgnored":{ "shape":"Integer", "documentation":"The number of sessions that were ignored during evaluation.
" }, "evaluatorSummaries":{ "shape":"EvaluatorSummaryList", "documentation":"A list of per-evaluator summary statistics.
" } }, "documentation":"Aggregated results from a batch evaluation, including session completion counts and evaluator score summaries.
" }, "EvaluationMetadata":{ "type":"structure", "members":{ "sessionMetadata":{ "shape":"SessionMetadataList", "documentation":"A list of session metadata entries containing ground truth data and test scenario identifiers for specific sessions.
" } }, "documentation":"Metadata for the evaluation, including session-specific ground truth data.
", "union":true }, "EvaluationReferenceInput":{ "type":"structure", "required":["context"], "members":{ "context":{"shape":"Context"}, "expectedResponse":{ "shape":"EvaluationContent", "documentation":" The expected response for trace-level evaluation. Built-in evaluators that support this field compare the agent's actual response against this value for assessment. Custom evaluators can access it through the {expected_response} placeholder in their instructions.
A list of assertion statements for session-level evaluation. Each assertion describes an expected behavior or outcome the agent should demonstrate during the session.
" }, "expectedTrajectory":{ "shape":"EvaluationExpectedTrajectory", "documentation":"The expected tool call sequence for session-level trajectory evaluation. Contains a list of tool names representing the tools the agent is expected to invoke.
" } }, "documentation":"A reference input containing ground truth data for evaluation, scoped to a specific context level (session or trace) through its span context.
" }, "EvaluationReferenceInputs":{ "type":"list", "member":{"shape":"EvaluationReferenceInput"}, "max":1000, "min":1, "sensitive":true }, "EvaluationResultContent":{ "type":"structure", "required":[ "evaluatorArn", "evaluatorId", "evaluatorName", "context" ], "members":{ "evaluatorArn":{ "shape":"EvaluatorArn", "documentation":" The Amazon Resource Name (ARN) of the evaluator used to generate this result. For custom evaluators, this is the full ARN; for built-in evaluators, this follows the pattern Builtin.{EvaluatorName}.
The unique identifier of the evaluator that produced this result. This matches the evaluatorId provided in the evaluation request and can be used to identify which evaluator generated specific results.
The human-readable name of the evaluator used for this evaluation. For built-in evaluators, this is the descriptive name (e.g., \"Helpfulness\", \"Correctness\"); for custom evaluators, this is the user-defined name.
" }, "explanation":{ "shape":"EvaluationExplanation", "documentation":"The detailed explanation provided by the evaluator describing the reasoning behind the assigned score. This qualitative feedback helps understand why specific ratings were given and provides actionable insights for improvement.
" }, "context":{ "shape":"Context", "documentation":"The contextual information associated with this evaluation result, including span context details that identify the specific traces and sessions that were evaluated.
" }, "value":{ "shape":"Double", "documentation":"The numerical score assigned by the evaluator according to its configured rating scale. For numerical scales, this is a decimal value within the defined range. This field is not allowed for categorical scales.
" }, "label":{ "shape":"String", "documentation":"The categorical label assigned by the evaluator when using a categorical rating scale. This provides a human-readable description of the evaluation result (e.g., \"Excellent\", \"Good\", \"Poor\") corresponding to the numerical value. For numerical scales, this field is optional and provides a natural language explanation of what the value means (e.g., value 0.5 = \"Somewhat Helpful\").
" }, "tokenUsage":{ "shape":"TokenUsage", "documentation":"The token consumption statistics for this evaluation, including input tokens, output tokens, and total tokens used by the underlying language model during the evaluation process.
" }, "errorMessage":{ "shape":"EvaluationErrorMessage", "documentation":"The error message describing what went wrong if the evaluation failed. Provides detailed information about evaluation failures to help diagnose and resolve issues with evaluator configuration or input data.
" }, "errorCode":{ "shape":"EvaluationErrorCode", "documentation":"The error code indicating the type of failure that occurred during evaluation. Used to programmatically identify and handle different categories of evaluation errors.
" }, "ignoredReferenceInputFields":{ "shape":"IgnoredReferenceInputFields", "documentation":"The list of reference input field names that were provided but not used by the evaluator. Helps identify which ground truth data was not consumed during evaluation.
" } }, "documentation":"The comprehensive result of an evaluation containing the score, explanation, evaluator metadata, and execution details. Provides both quantitative ratings and qualitative insights about agent performance.
" }, "EvaluationResults":{ "type":"list", "member":{"shape":"EvaluationResultContent"} }, "EvaluationTarget":{ "type":"structure", "members":{ "spanIds":{ "shape":"SpanIds", "documentation":"The list of specific span IDs to evaluate within the provided traces. Used to target evaluation at individual tool calls or specific operations within the agent's execution flow.
" }, "traceIds":{ "shape":"TraceIds", "documentation":"The list of trace IDs to evaluate, representing complete request-response interactions. Used to evaluate entire conversation turns or specific agent interactions within a session.
" } }, "documentation":"The specification of which trace or span IDs to evaluate within the provided input data. Allows precise targeting of evaluation at different levels: tool calls, traces, or sessions.
", "union":true }, "EvaluationToolName":{ "type":"string", "max":500, "min":1 }, "EvaluationToolNames":{ "type":"list", "member":{"shape":"EvaluationToolName"}, "max":1000, "min":0 }, "Evaluator":{ "type":"structure", "required":["evaluatorId"], "members":{ "evaluatorId":{ "shape":"EvaluatorId", "documentation":"The unique identifier of the evaluator. Can reference built-in evaluators (e.g., Builtin.Helpfulness) or custom evaluators.
An evaluator to run against sessions
" }, "EvaluatorArn":{ "type":"string", "pattern":"arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:evaluator\\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$|^arn:aws:bedrock-agentcore:::evaluator/Builtin.[a-zA-Z0-9_-]+" }, "EvaluatorId":{ "type":"string", "pattern":"(Builtin.[a-zA-Z0-9_-]+|[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10})" }, "EvaluatorList":{ "type":"list", "member":{"shape":"Evaluator"} }, "EvaluatorMetric":{ "type":"structure", "required":[ "evaluatorArn", "controlStats", "variantResults" ], "members":{ "evaluatorArn":{ "shape":"String", "documentation":"The Amazon Resource Name (ARN) of the evaluator.
" }, "controlStats":{ "shape":"ControlStats", "documentation":"The statistics for the control variant.
" }, "variantResults":{ "shape":"VariantResultList", "documentation":"The results for each treatment variant compared against the control.
" } }, "documentation":"Statistical metrics for a single evaluator comparing control and treatment variants.
" }, "EvaluatorMetricList":{ "type":"list", "member":{"shape":"EvaluatorMetric"} }, "EvaluatorName":{ "type":"string", "pattern":"(Builtin.[a-zA-Z0-9_-]+|[a-zA-Z][a-zA-Z0-9_]{0,47})" }, "EvaluatorStatistics":{ "type":"structure", "members":{ "averageScore":{ "shape":"Double", "documentation":"The average score across all evaluated sessions for this evaluator.
" } }, "documentation":"Aggregated statistics for an evaluator.
" }, "EvaluatorSummary":{ "type":"structure", "members":{ "evaluatorId":{ "shape":"String", "documentation":"The unique identifier of the evaluator.
" }, "statistics":{ "shape":"EvaluatorStatistics", "documentation":"The aggregated statistics for this evaluator.
" }, "totalEvaluated":{ "shape":"Integer", "documentation":"The total number of sessions evaluated by this evaluator.
" }, "totalFailed":{ "shape":"Integer", "documentation":"The total number of sessions that failed evaluation by this evaluator.
" } }, "documentation":"Summary statistics for a single evaluator within a batch evaluation.
" }, "EvaluatorSummaryList":{ "type":"list", "member":{"shape":"EvaluatorSummary"} }, "Event":{ "type":"structure", "required":[ "memoryId", "actorId", "sessionId", "eventId", "eventTimestamp", "payload" ], "members":{ "memoryId":{ "shape":"MemoryId", "documentation":"The identifier of the AgentCore Memory resource containing the event.
" }, "actorId":{ "shape":"ActorId", "documentation":"The identifier of the actor associated with the event.
" }, "sessionId":{ "shape":"SessionId", "documentation":"The identifier of the session containing the event.
" }, "eventId":{ "shape":"EventId", "documentation":"The unique identifier of the event.
" }, "eventTimestamp":{ "shape":"Timestamp", "documentation":"The timestamp when the event occurred.
" }, "payload":{ "shape":"PayloadTypeList", "documentation":"The content payload of the event.
" }, "branch":{ "shape":"Branch", "documentation":"The branch information for the event.
" }, "metadata":{ "shape":"MetadataMap", "documentation":"Metadata associated with an event.
" } }, "documentation":"Contains information about an event in an AgentCore Memory resource.
" }, "EventFilterCondition":{ "type":"string", "documentation":"The condition to use for filtering sessions by events.
", "enum":["HAS_EVENTS"] }, "EventId":{ "type":"string", "pattern":"[0-9]+#[a-fA-F0-9]+" }, "EventList":{ "type":"list", "member":{"shape":"Event"} }, "EventMetadataFilterExpression":{ "type":"structure", "required":[ "left", "operator" ], "members":{ "left":{ "shape":"LeftExpression", "documentation":"Left operand of the event metadata filter expression.
" }, "operator":{ "shape":"OperatorType", "documentation":"Operator applied to the event metadata filter expression.
" }, "right":{ "shape":"RightExpression", "documentation":"Right operand of the event metadata filter expression.
" } }, "documentation":"Filter expression for retrieving events based on metadata associated with an event.
" }, "EventMetadataFilterList":{ "type":"list", "member":{"shape":"EventMetadataFilterExpression"}, "max":5, "min":1 }, "ExternalProxy":{ "type":"structure", "required":[ "server", "port" ], "members":{ "server":{ "shape":"HostName", "documentation":"The hostname of the proxy server. Must be a valid DNS hostname (maximum 253 characters).
" }, "port":{ "shape":"ExternalProxyPortInteger", "documentation":"The port number of the proxy server. Valid range: 1-65535.
" }, "domainPatterns":{ "shape":"DomainPatterns", "documentation":"Optional array of domain patterns that should route through this specific proxy. Supports .example.com for subdomain matching (matches any subdomain of example.com) or example.com for exact domain matching. If omitted, this proxy acts as a catch-all for domains not matched by other proxies. Maximum 100 patterns per proxy, each up to 253 characters.
Optional authentication credentials for the proxy server. If omitted, the proxy is accessed without authentication (useful for IP-allowlisted proxies).
" } }, "documentation":"Configuration for a customer-managed external proxy server. Includes server location, optional domain-based routing patterns, and authentication credentials.
" }, "ExternalProxyPortInteger":{ "type":"integer", "box":true, "max":65535, "min":1 }, "ExtractionJob":{ "type":"structure", "required":["jobId"], "members":{ "jobId":{ "shape":"String", "documentation":"The unique identifier of the extraction job.
" } }, "documentation":"Represents the metadata of a memory extraction job such as the message identifiers that compose this job.
" }, "ExtractionJobFilterInput":{ "type":"structure", "members":{ "strategyId":{ "shape":"String", "documentation":"The memory strategy identifier to filter extraction jobs by. If specified, only extraction jobs with this strategy ID are returned.
" }, "sessionId":{ "shape":"String", "documentation":"The unique identifier of the session. If specified, only extraction jobs with this session ID are returned.
" }, "actorId":{ "shape":"String", "documentation":"The identifier of the actor. If specified, only extraction jobs with this actor ID are returned.
" }, "status":{ "shape":"ExtractionJobStatus", "documentation":"The status of the extraction job. If specified, only extraction jobs with this status are returned.
" } }, "documentation":"Filters for querying memory extraction jobs based on various criteria.
" }, "ExtractionJobMessages":{ "type":"structure", "members":{ "messagesList":{ "shape":"MessagesList", "documentation":"The list of messages that compose this extraction job.
" } }, "documentation":"The list of messages that compose this extraction job.
", "union":true }, "ExtractionJobMetadata":{ "type":"structure", "required":[ "jobID", "messages" ], "members":{ "jobID":{ "shape":"String", "documentation":"The unique identifier for the extraction job.
" }, "messages":{ "shape":"ExtractionJobMessages", "documentation":"The messages associated with the extraction job.
" }, "status":{ "shape":"ExtractionJobStatus", "documentation":"The current status of the extraction job.
" }, "failureReason":{ "shape":"String", "documentation":"The cause of failure, if the job did not complete successfully.
" }, "strategyId":{ "shape":"String", "documentation":"The identifier of the memory strategy for this extraction job.
" }, "sessionId":{ "shape":"String", "documentation":"The identifier of the session for this extraction job.
" }, "actorId":{ "shape":"String", "documentation":"The identifier of the actor for this extraction job.
" } }, "documentation":"Metadata information associated with this extraction job.
" }, "ExtractionJobMetadataList":{ "type":"list", "member":{"shape":"ExtractionJobMetadata"} }, "ExtractionJobStatus":{ "type":"string", "enum":["FAILED"] }, "FilterInput":{ "type":"structure", "members":{ "branch":{ "shape":"BranchFilter", "documentation":"The branch filter criteria to apply when listing events.
" }, "eventMetadata":{ "shape":"EventMetadataFilterList", "documentation":"Event metadata filter criteria to apply when retrieving events.
" } }, "documentation":"Contains filter criteria for listing events.
" }, "FilterStringValue":{ "type":"string", "max":1024, "min":0 }, "FilterValue":{ "type":"structure", "members":{ "stringValue":{ "shape":"FilterStringValue", "documentation":"A string value for text-based filtering.
" }, "doubleValue":{ "shape":"Double", "documentation":"A numeric value for numerical filtering and comparisons.
" }, "booleanValue":{ "shape":"Boolean", "documentation":"A boolean value for true/false filtering conditions.
" } }, "documentation":"A value used in filter comparisons, supporting different data types.
", "union":true }, "GatewayArn":{ "type":"string", "pattern":"arn:aws(|-cn|-us-gov):bedrock-agentcore:[a-z0-9-]{1,20}:[0-9]{12}:gateway/([0-9a-z][-]?){1,48}-[a-z0-9]{10}" }, "GatewayFilter":{ "type":"structure", "members":{ "targetPaths":{ "shape":"TargetPathList", "documentation":"A list of target path patterns to include in the A/B test.
" } }, "documentation":"A filter to restrict which gateway target paths are included in the A/B test.
" }, "GetABTestRequest":{ "type":"structure", "required":["abTestId"], "members":{ "abTestId":{ "shape":"ABTestId", "documentation":"The unique identifier of the A/B test to retrieve.
", "location":"uri", "locationName":"abTestId" } } }, "GetABTestResponse":{ "type":"structure", "required":[ "abTestId", "abTestArn", "name", "status", "executionStatus", "gatewayArn", "variants", "evaluationConfig", "createdAt", "updatedAt" ], "members":{ "abTestId":{ "shape":"ABTestId", "documentation":"The unique identifier of the A/B test.
" }, "abTestArn":{ "shape":"ABTestArn", "documentation":"The Amazon Resource Name (ARN) of the A/B test.
" }, "name":{ "shape":"ABTestName", "documentation":"The name of the A/B test.
" }, "description":{ "shape":"ABTestDescription", "documentation":"The description of the A/B test.
" }, "status":{ "shape":"ABTestStatus", "documentation":"The current status of the A/B test.
" }, "executionStatus":{ "shape":"ABTestExecutionStatus", "documentation":"The execution status indicating whether the A/B test is currently running.
" }, "gatewayArn":{ "shape":"GatewayArn", "documentation":"The Amazon Resource Name (ARN) of the gateway used for traffic splitting.
" }, "variants":{ "shape":"VariantList", "documentation":"The list of variants in the A/B test.
" }, "gatewayFilter":{ "shape":"GatewayFilter", "documentation":"The gateway filter restricting which target paths are included.
" }, "evaluationConfig":{ "shape":"ABTestEvaluationConfig", "documentation":"The evaluation configuration for measuring variant performance.
" }, "roleArn":{ "shape":"RoleArn", "documentation":"The IAM role ARN used by the A/B test.
" }, "currentRunId":{ "shape":"String", "documentation":"The identifier of the current run of the A/B test.
" }, "errorDetails":{ "shape":"ErrorDetailsList", "documentation":"The error details if the A/B test encountered failures.
" }, "startedAt":{ "shape":"Timestamp", "documentation":"The timestamp when the A/B test was started.
" }, "stoppedAt":{ "shape":"Timestamp", "documentation":"The timestamp when the A/B test was stopped.
" }, "maxDurationExpiresAt":{ "shape":"Timestamp", "documentation":"The timestamp when the A/B test will automatically expire.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The timestamp when the A/B test was created.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The timestamp when the A/B test was last updated.
" }, "results":{ "shape":"ABTestResults", "documentation":"The statistical results of the A/B test, including per-evaluator metrics and significance analysis.
" } } }, "GetAgentCardRequest":{ "type":"structure", "required":["agentRuntimeArn"], "members":{ "runtimeSessionId":{ "shape":"SessionType", "documentation":"The session ID that the AgentCore Runtime agent is using.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amzn-Bedrock-AgentCore-Runtime-Session-Id" }, "agentRuntimeArn":{ "shape":"String", "documentation":"The ARN of the AgentCore Runtime agent for which you want to get the A2A agent card.
", "location":"uri", "locationName":"agentRuntimeArn" }, "qualifier":{ "shape":"String", "documentation":"Optional qualifier to specify an agent alias, such as prodcode> or dev. If you don't provide a value, the DEFAULT alias is used.
The ID of the session associated with the AgentCore Runtime agent.
", "location":"header", "locationName":"X-Amzn-Bedrock-AgentCore-Runtime-Session-Id" }, "agentCard":{ "shape":"AgentCard", "documentation":"An agent card document that contains metadata and capabilities for an AgentCore Runtime agent.
" }, "statusCode":{ "shape":"HttpResponseCode", "documentation":"The status code of the request.
", "location":"statusCode" } }, "payload":"agentCard" }, "GetBatchEvaluationRequest":{ "type":"structure", "required":["batchEvaluationId"], "members":{ "batchEvaluationId":{ "shape":"BatchEvaluationId", "documentation":"The unique identifier of the batch evaluation to retrieve.
", "location":"uri", "locationName":"batchEvaluationId" } } }, "GetBatchEvaluationResponse":{ "type":"structure", "required":[ "batchEvaluationId", "batchEvaluationArn", "batchEvaluationName", "status", "createdAt" ], "members":{ "batchEvaluationId":{ "shape":"BatchEvaluationId", "documentation":"The unique identifier of the batch evaluation.
" }, "batchEvaluationArn":{ "shape":"BatchEvaluationArn", "documentation":"The Amazon Resource Name (ARN) of the batch evaluation.
" }, "batchEvaluationName":{ "shape":"BatchEvaluationName", "documentation":"The name of the batch evaluation.
" }, "status":{ "shape":"BatchEvaluationStatus", "documentation":"The current status of the batch evaluation.
" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The timestamp when the batch evaluation was created.
" }, "evaluators":{ "shape":"EvaluatorList", "documentation":"The list of evaluators applied during the batch evaluation.
" }, "dataSourceConfig":{ "shape":"DataSourceConfig", "documentation":"The data source configuration specifying where agent traces are pulled from.
" }, "outputConfig":{ "shape":"OutputConfig", "documentation":"The output configuration specifying where evaluation results are written.
" }, "evaluationResults":{ "shape":"EvaluationJobResults", "documentation":"The aggregated evaluation results, including session completion counts and evaluator score summaries.
" }, "errorDetails":{ "shape":"ErrorDetailsList", "documentation":"The error details if the batch evaluation encountered failures.
" }, "description":{ "shape":"BatchEvaluationDescription", "documentation":"The description of the batch evaluation.
" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The timestamp when the batch evaluation was last updated.
" } } }, "GetBrowserSessionRequest":{ "type":"structure", "required":[ "browserIdentifier", "sessionId" ], "members":{ "browserIdentifier":{ "shape":"String", "documentation":"The unique identifier of the browser associated with the session.
", "location":"uri", "locationName":"browserIdentifier" }, "sessionId":{ "shape":"BrowserSessionId", "documentation":"The unique identifier of the browser session to retrieve.
", "location":"querystring", "locationName":"sessionId" } } }, "GetBrowserSessionResponse":{ "type":"structure", "required":[ "browserIdentifier", "sessionId", "createdAt" ], "members":{ "browserIdentifier":{ "shape":"String", "documentation":"The identifier of the browser.
" }, "sessionId":{ "shape":"BrowserSessionId", "documentation":"The identifier of the browser session.
" }, "name":{ "shape":"Name", "documentation":"The name of the browser session.
" }, "createdAt":{ "shape":"DateTimestamp", "documentation":"The time at which the browser session was created.
" }, "viewPort":{"shape":"ViewPort"}, "extensions":{ "shape":"BrowserExtensions", "documentation":"The list of browser extensions that are configured in the browser session.
" }, "enterprisePolicies":{ "shape":"BrowserEnterprisePolicies", "documentation":"A list of files containing enterprise policies for the browser session.
" }, "profileConfiguration":{ "shape":"BrowserProfileConfiguration", "documentation":"The browser profile configuration associated with this session. Contains the profile identifier that links to persistent browser data such as cookies and local storage.
" }, "sessionTimeoutSeconds":{ "shape":"BrowserSessionTimeout", "documentation":"The timeout period for the browser session in seconds.
" }, "status":{ "shape":"BrowserSessionStatus", "documentation":"The current status of the browser session. Possible values include ACTIVE, STOPPING, and STOPPED.
" }, "streams":{ "shape":"BrowserSessionStream", "documentation":"The streams associated with this browser session. These include the automation stream and live view stream.
" }, "proxyConfiguration":{ "shape":"ProxyConfiguration", "documentation":"The active proxy configuration for this browser session. This field is only present if proxy configuration was provided when the session was started using StartBrowserSession. The configuration includes proxy servers, domain bypass rules and the proxy authentication credentials.
The list of certificates installed in the browser session.
" }, "sessionReplayArtifact":{ "shape":"String", "documentation":"The artifact containing the session replay information.
" }, "lastUpdatedAt":{ "shape":"DateTimestamp", "documentation":"The time at which the browser session was last updated.
" } } }, "GetCodeInterpreterSessionRequest":{ "type":"structure", "required":[ "codeInterpreterIdentifier", "sessionId" ], "members":{ "codeInterpreterIdentifier":{ "shape":"String", "documentation":"The unique identifier of the code interpreter associated with the session.
", "location":"uri", "locationName":"codeInterpreterIdentifier" }, "sessionId":{ "shape":"CodeInterpreterSessionId", "documentation":"The unique identifier of the code interpreter session to retrieve.
", "location":"querystring", "locationName":"sessionId" } } }, "GetCodeInterpreterSessionResponse":{ "type":"structure", "required":[ "codeInterpreterIdentifier", "sessionId", "createdAt" ], "members":{ "codeInterpreterIdentifier":{ "shape":"String", "documentation":"The identifier of the code interpreter.
" }, "sessionId":{ "shape":"CodeInterpreterSessionId", "documentation":"The identifier of the code interpreter session.
" }, "name":{ "shape":"Name", "documentation":"The name of the code interpreter session.
" }, "createdAt":{ "shape":"DateTimestamp", "documentation":"The time at which the code interpreter session was created.
" }, "sessionTimeoutSeconds":{ "shape":"CodeInterpreterSessionTimeout", "documentation":"The timeout period for the code interpreter session in seconds.
" }, "status":{ "shape":"CodeInterpreterSessionStatus", "documentation":"The current status of the code interpreter session. Possible values include ACTIVE, STOPPING, and STOPPED.
" }, "certificates":{ "shape":"Certificates", "documentation":"The list of certificates installed in the code interpreter session.
" } } }, "GetEventInput":{ "type":"structure", "required":[ "memoryId", "sessionId", "actorId", "eventId" ], "members":{ "memoryId":{ "shape":"MemoryId", "documentation":"The identifier of the AgentCore Memory resource containing the event.
", "location":"uri", "locationName":"memoryId" }, "sessionId":{ "shape":"SessionId", "documentation":"The identifier of the session containing the event.
", "location":"uri", "locationName":"sessionId" }, "actorId":{ "shape":"ActorId", "documentation":"The identifier of the actor associated with the event.
", "location":"uri", "locationName":"actorId" }, "eventId":{ "shape":"EventId", "documentation":"The identifier of the event to retrieve.
", "location":"uri", "locationName":"eventId" } } }, "GetEventOutput":{ "type":"structure", "required":["event"], "members":{ "event":{ "shape":"Event", "documentation":"The requested event information.
" } } }, "GetMemoryRecordInput":{ "type":"structure", "required":[ "memoryId", "memoryRecordId" ], "members":{ "memoryId":{ "shape":"MemoryId", "documentation":"The identifier of the AgentCore Memory resource containing the memory record.
", "location":"uri", "locationName":"memoryId" }, "memoryRecordId":{ "shape":"MemoryRecordId", "documentation":"The identifier of the memory record to retrieve.
", "location":"uri", "locationName":"memoryRecordId" } } }, "GetMemoryRecordOutput":{ "type":"structure", "required":["memoryRecord"], "members":{ "memoryRecord":{ "shape":"MemoryRecord", "documentation":"The requested memory record.
" } } }, "GetRecommendationRequest":{ "type":"structure", "required":["recommendationId"], "members":{ "recommendationId":{ "shape":"RecommendationId", "documentation":"The unique identifier of the recommendation to retrieve.
", "location":"uri", "locationName":"recommendationId" } } }, "GetRecommendationResponse":{ "type":"structure", "required":[ "recommendationId", "recommendationArn", "name", "type", "recommendationConfig", "status", "createdAt", "updatedAt" ], "members":{ "recommendationId":{ "shape":"RecommendationId", "documentation":"The unique identifier of the recommendation.
" }, "recommendationArn":{ "shape":"RecommendationArn", "documentation":"The Amazon Resource Name (ARN) of the recommendation.
" }, "name":{ "shape":"RecommendationName", "documentation":"The name of the recommendation.
" }, "description":{ "shape":"RecommendationDescription", "documentation":"The description of the recommendation.
" }, "type":{ "shape":"RecommendationType", "documentation":"The type of recommendation.
" }, "recommendationConfig":{ "shape":"RecommendationConfig", "documentation":"The configuration for the recommendation.
" }, "status":{ "shape":"RecommendationStatus", "documentation":"The current status of the recommendation.
" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The timestamp when the recommendation was created.
" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The timestamp when the recommendation was last updated.
" }, "recommendationResult":{ "shape":"RecommendationResult", "documentation":"The result of the recommendation, containing the optimized system prompt or tool descriptions. Only present when the recommendation status is COMPLETED.
The identity token of the workload from which you want to retrieve the API key.
" }, "resourceCredentialProviderName":{ "shape":"CredentialProviderName", "documentation":"The credential provider name for the resource from which you are retrieving the API key.
" } } }, "GetResourceApiKeyResponse":{ "type":"structure", "required":["apiKey"], "members":{ "apiKey":{ "shape":"ApiKeyType", "documentation":"The API key associated with the resource requested.
" } } }, "GetResourceOauth2TokenRequest":{ "type":"structure", "required":[ "workloadIdentityToken", "resourceCredentialProviderName", "scopes", "oauth2Flow" ], "members":{ "workloadIdentityToken":{ "shape":"WorkloadIdentityTokenType", "documentation":"The identity token of the workload from which you want to retrieve the OAuth2 token.
" }, "resourceCredentialProviderName":{ "shape":"CredentialProviderName", "documentation":"The name of the resource's credential provider.
" }, "scopes":{ "shape":"ScopesListType", "documentation":"The OAuth scopes being requested.
" }, "oauth2Flow":{ "shape":"Oauth2FlowType", "documentation":"The type of flow to be performed.
" }, "sessionUri":{ "shape":"RequestUri", "documentation":"Unique identifier for the user's authentication session for retrieving OAuth2 tokens. This ID tracks the authorization flow state across multiple requests and responses during the OAuth2 authentication process.
" }, "resourceOauth2ReturnUrl":{ "shape":"ResourceOauth2ReturnUrlType", "documentation":"The callback URL to redirect to after the OAuth 2.0 token retrieval is complete. This URL must be one of the provided URLs configured for the workload identity.
" }, "forceAuthentication":{ "shape":"Boolean", "documentation":"Indicates whether to always initiate a new three-legged OAuth (3LO) flow, regardless of any existing session.
" }, "customParameters":{ "shape":"CustomRequestParametersType", "documentation":"A map of custom parameters to include in the authorization request to the resource credential provider. These parameters are in addition to the standard OAuth 2.0 flow parameters, and will not override them.
" }, "customState":{ "shape":"State", "documentation":"An opaque string that will be sent back to the callback URL provided in resourceOauth2ReturnUrl. This state should be used to protect the callback URL of your application against CSRF attacks by ensuring the response corresponds to the original request.
" }, "resources":{ "shape":"ResourcesListType", "documentation":"The resources to include in the token request. These are used to specify the target resources for which the OAuth2 token is being requested.
" }, "audiences":{ "shape":"AudiencesListType", "documentation":"The audiences to include in the token request. These are used to specify the intended recipients of the OAuth2 token.
" } } }, "GetResourceOauth2TokenResponse":{ "type":"structure", "members":{ "authorizationUrl":{ "shape":"AuthorizationUrlType", "documentation":"The URL to initiate the authorization process, provided when the access token requires user authorization.
" }, "accessToken":{ "shape":"AccessTokenType", "documentation":"The OAuth 2.0 access token to use.
" }, "sessionUri":{ "shape":"RequestUri", "documentation":"Unique identifier for the user's authorization session for retrieving OAuth2 tokens. This matches the sessionId from the request and can be used to track the session state.
" }, "sessionStatus":{ "shape":"SessionStatus", "documentation":"Status indicating whether the user's authorization session is in progress or has failed. This helps determine the next steps in the OAuth2 authentication flow.
" } } }, "GetWorkloadAccessTokenForJWTRequest":{ "type":"structure", "required":[ "workloadName", "userToken" ], "members":{ "workloadName":{ "shape":"WorkloadIdentityNameType", "documentation":"The unique identifier for the registered workload.
" }, "userToken":{ "shape":"UserTokenType", "documentation":"The OAuth 2.0 token issued by the user's identity provider.
" } } }, "GetWorkloadAccessTokenForJWTResponse":{ "type":"structure", "required":["workloadAccessToken"], "members":{ "workloadAccessToken":{ "shape":"WorkloadIdentityTokenType", "documentation":"An opaque token representing the identity of both the workload and the user.
" } } }, "GetWorkloadAccessTokenForUserIdRequest":{ "type":"structure", "required":[ "workloadName", "userId" ], "members":{ "workloadName":{ "shape":"WorkloadIdentityNameType", "documentation":"The name of the workload from which you want to retrieve the access token.
" }, "userId":{ "shape":"UserIdType", "documentation":"The ID of the user for whom you are retrieving the access token.
" } } }, "GetWorkloadAccessTokenForUserIdResponse":{ "type":"structure", "required":["workloadAccessToken"], "members":{ "workloadAccessToken":{ "shape":"WorkloadIdentityTokenType", "documentation":"The access token for the specified workload.
" } } }, "GetWorkloadAccessTokenRequest":{ "type":"structure", "required":["workloadName"], "members":{ "workloadName":{ "shape":"WorkloadIdentityNameType", "documentation":"The unique identifier for the registered workload.
" } } }, "GetWorkloadAccessTokenResponse":{ "type":"structure", "required":["workloadAccessToken"], "members":{ "workloadAccessToken":{ "shape":"WorkloadIdentityTokenType", "documentation":"An opaque token representing the identity of both the workload and the user.
" } } }, "GroundTruthSource":{ "type":"structure", "members":{ "inline":{ "shape":"InlineGroundTruth", "documentation":"Provide ground truth inline
" } }, "documentation":"Where to pull ground truth from
", "union":true }, "GroundTruthTurn":{ "type":"structure", "members":{ "input":{ "shape":"GroundTruthTurnInput", "documentation":"The input for this conversation turn.
" }, "expectedResponse":{ "shape":"EvaluationContent", "documentation":"The expected response for this conversation turn.
" } }, "documentation":"Ground truth data for a single conversation turn.
" }, "GroundTruthTurnInput":{ "type":"structure", "members":{ "prompt":{ "shape":"GroundTruthTurnInputPromptString", "documentation":"The text prompt for this conversation turn.
" } }, "documentation":"The input for a ground truth conversation turn.
", "union":true }, "GroundTruthTurnInputPromptString":{ "type":"string", "max":4000, "min":0 }, "HarnessAgentCoreBrowserConfig":{ "type":"structure", "members":{ "browserArn":{ "shape":"BrowserArn", "documentation":"If not populated, the built-in Browser ARN is used.
" } }, "documentation":"Configuration for AgentCore Browser.
" }, "HarnessAgentCoreCodeInterpreterConfig":{ "type":"structure", "members":{ "codeInterpreterArn":{ "shape":"CodeInterpreterArn", "documentation":"If not populated, the built-in Code Interpreter ARN is used.
" } }, "documentation":"Configuration for AgentCore Code Interpreter.
" }, "HarnessAgentCoreGatewayConfig":{ "type":"structure", "required":["gatewayArn"], "members":{ "gatewayArn":{ "shape":"GatewayArn", "documentation":"The ARN of the desired AgentCore Gateway.
" }, "outboundAuth":{ "shape":"HarnessGatewayOutboundAuth", "documentation":"How harness authenticates to this Gateway. Defaults to AWS_IAM (SigV4) if omitted.
" } }, "documentation":"Configuration for AgentCore Gateway.
" }, "HarnessAllowedTool":{ "type":"string", "max":64, "min":1, "pattern":"(\\*|@?[^/]+(/[^/]+)?)" }, "HarnessAllowedTools":{ "type":"list", "member":{"shape":"HarnessAllowedTool"} }, "HarnessArn":{ "type":"string", "pattern":"arn:([^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:harness/[a-zA-Z][a-zA-Z0-9_]{0,39}-[a-zA-Z0-9]{10}" }, "HarnessBedrockModelConfig":{ "type":"structure", "required":["modelId"], "members":{ "modelId":{ "shape":"ModelId", "documentation":"The Bedrock model ID.
" }, "maxTokens":{ "shape":"MaxTokens", "documentation":"The maximum number of tokens to allow in the generated response per iteration.
" }, "temperature":{ "shape":"Temperature", "documentation":"The temperature to set when calling the model.
" }, "topP":{ "shape":"TopP", "documentation":"The topP set when calling the model.
" } }, "documentation":"Configuration for an Amazon Bedrock model provider.
" }, "HarnessContentBlock":{ "type":"structure", "members":{ "text":{ "shape":"SensitiveText", "documentation":"Text content.
" }, "toolUse":{ "shape":"HarnessToolUseBlock", "documentation":"A tool use request from the model.
" }, "toolResult":{ "shape":"HarnessToolResultBlock", "documentation":"A tool execution result.
" }, "reasoningContent":{ "shape":"HarnessReasoningContentBlock", "documentation":"Model reasoning content.
" } }, "documentation":"A content block within a message.
", "union":true }, "HarnessContentBlockDelta":{ "type":"structure", "members":{ "text":{ "shape":"SensitiveText", "documentation":"A text delta.
" }, "toolUse":{ "shape":"HarnessToolUseBlockDelta", "documentation":"A tool use input delta.
" }, "toolResult":{ "shape":"HarnessToolResultBlocksDelta", "documentation":"A tool result delta.
" }, "reasoningContent":{ "shape":"HarnessReasoningContentBlockDelta", "documentation":"A reasoning content delta.
" } }, "documentation":"A delta update to a content block.
", "union":true }, "HarnessContentBlockDeltaEvent":{ "type":"structure", "required":[ "contentBlockIndex", "delta" ], "members":{ "contentBlockIndex":{ "shape":"Integer", "documentation":"The index of the content block being updated.
" }, "delta":{ "shape":"HarnessContentBlockDelta", "documentation":"The delta payload.
" } }, "documentation":"Event containing a delta update to a content block.
", "event":true }, "HarnessContentBlockStart":{ "type":"structure", "members":{ "toolUse":{ "shape":"HarnessToolUseBlockStart", "documentation":"Start of a tool use content block.
" }, "toolResult":{ "shape":"HarnessToolResultBlockStart", "documentation":"Start of a tool result content block.
" } }, "documentation":"The start payload for a content block.
", "union":true }, "HarnessContentBlockStartEvent":{ "type":"structure", "required":[ "contentBlockIndex", "start" ], "members":{ "contentBlockIndex":{ "shape":"Integer", "documentation":"The index of the content block within the message.
" }, "start":{ "shape":"HarnessContentBlockStart", "documentation":"The content block start payload.
" } }, "documentation":"Event indicating the start of a content block.
", "event":true }, "HarnessContentBlockStopEvent":{ "type":"structure", "required":["contentBlockIndex"], "members":{ "contentBlockIndex":{ "shape":"Integer", "documentation":"The index of the content block that ended.
" } }, "documentation":"Event indicating the end of a content block.
", "event":true }, "HarnessContentBlocks":{ "type":"list", "member":{"shape":"HarnessContentBlock"} }, "HarnessConversationRole":{ "type":"string", "enum":[ "user", "assistant" ] }, "HarnessGatewayOutboundAuth":{ "type":"structure", "members":{ "awsIam":{ "shape":"Unit", "documentation":"SigV4-sign requests using the agent's execution role.
" }, "none":{ "shape":"Unit", "documentation":"No authentication.
" }, "oauth":{ "shape":"OAuthCredentialProvider", "documentation":"OAuth 2.0 authentication via AgentCore Identity.
" } }, "documentation":"Authentication method for calling a Gateway.
", "union":true }, "HarnessGeminiModelConfig":{ "type":"structure", "required":[ "modelId", "apiKeyArn" ], "members":{ "modelId":{ "shape":"ModelId", "documentation":"The Gemini model ID.
" }, "apiKeyArn":{ "shape":"ApiKeyArn", "documentation":"The ARN of your Gemini API key on AgentCore Identity.
" }, "maxTokens":{ "shape":"MaxTokens", "documentation":"The maximum number of tokens to allow in the generated response per iteration.
" }, "temperature":{ "shape":"Temperature", "documentation":"The temperature to set when calling the model.
" }, "topP":{ "shape":"TopP", "documentation":"The topP set when calling the model.
" }, "topK":{ "shape":"TopK", "documentation":"The topK set when calling the model.
" } }, "documentation":"Configuration for a Google Gemini model provider. Requires an API key stored in AgentCore Identity.
" }, "HarnessInlineFunctionConfig":{ "type":"structure", "required":[ "description", "inputSchema" ], "members":{ "description":{ "shape":"HarnessInlineFunctionDescription", "documentation":"Description of what the tool does, provided to the model.
" }, "inputSchema":{ "shape":"SensitiveJson", "documentation":"JSON Schema describing the tool's input parameters.
" } }, "documentation":"Configuration for an inline function tool. When the agent calls this tool, the tool call is returned to the caller for external execution.
" }, "HarnessInlineFunctionDescription":{ "type":"string", "max":4096, "min":1, "sensitive":true }, "HarnessMessage":{ "type":"structure", "required":[ "role", "content" ], "members":{ "role":{ "shape":"HarnessConversationRole", "documentation":"The role of the message sender.
" }, "content":{ "shape":"HarnessContentBlocks", "documentation":"The content blocks of the message.
" } }, "documentation":"A message in the conversation.
" }, "HarnessMessageStartEvent":{ "type":"structure", "required":["role"], "members":{ "role":{ "shape":"HarnessConversationRole", "documentation":"The role of the message sender.
" } }, "documentation":"Event indicating the start of a message.
", "event":true }, "HarnessMessageStopEvent":{ "type":"structure", "required":["stopReason"], "members":{ "stopReason":{ "shape":"HarnessStopReason", "documentation":"The reason the agent stopped generating.
" } }, "documentation":"Event indicating the end of a message.
", "event":true }, "HarnessMessages":{ "type":"list", "member":{"shape":"HarnessMessage"} }, "HarnessMetadataEvent":{ "type":"structure", "required":[ "usage", "metrics" ], "members":{ "usage":{ "shape":"HarnessTokenUsage", "documentation":"Token usage counts.
" }, "metrics":{ "shape":"HarnessStreamMetrics", "documentation":"Latency metrics.
" } }, "documentation":"Token usage and latency metrics for the invocation.
", "event":true }, "HarnessModelConfiguration":{ "type":"structure", "members":{ "bedrockModelConfig":{ "shape":"HarnessBedrockModelConfig", "documentation":"Configuration for an Amazon Bedrock model.
" }, "openAiModelConfig":{ "shape":"HarnessOpenAiModelConfig", "documentation":"Configuration for an OpenAI model.
" }, "geminiModelConfig":{ "shape":"HarnessGeminiModelConfig", "documentation":"Configuration for a Google Gemini model.
" } }, "documentation":"Specification of which model to use.
", "union":true }, "HarnessOpenAiModelConfig":{ "type":"structure", "required":[ "modelId", "apiKeyArn" ], "members":{ "modelId":{ "shape":"ModelId", "documentation":"The OpenAI model ID.
" }, "apiKeyArn":{ "shape":"ApiKeyArn", "documentation":"The ARN of your OpenAI API key on AgentCore Identity.
" }, "maxTokens":{ "shape":"MaxTokens", "documentation":"The maximum number of tokens to allow in the generated response per iteration.
" }, "temperature":{ "shape":"Temperature", "documentation":"The temperature to set when calling the model.
" }, "topP":{ "shape":"TopP", "documentation":"The topP set when calling the model.
" } }, "documentation":"Configuration for an OpenAI model provider. Requires an API key stored in AgentCore Identity.
" }, "HarnessReasoningContentBlock":{ "type":"structure", "members":{ "reasoningText":{ "shape":"HarnessReasoningTextBlock", "documentation":"The reasoning text.
" }, "redactedContent":{ "shape":"Blob", "documentation":"Redacted reasoning content.
" } }, "documentation":"Reasoning content from the model.
", "sensitive":true, "union":true }, "HarnessReasoningContentBlockDelta":{ "type":"structure", "members":{ "text":{ "shape":"String", "documentation":"Reasoning text delta.
" }, "redactedContent":{ "shape":"Body", "documentation":"Redacted reasoning content.
" }, "signature":{ "shape":"String", "documentation":"Signature for the reasoning content.
" } }, "documentation":"A delta update to a reasoning content block.
", "sensitive":true, "union":true }, "HarnessReasoningTextBlock":{ "type":"structure", "required":["text"], "members":{ "text":{ "shape":"String", "documentation":"The reasoning text.
" }, "signature":{ "shape":"String", "documentation":"Signature for verifying the reasoning content.
" } }, "documentation":"A block of reasoning text from the model.
", "sensitive":true }, "HarnessRemoteMcpConfig":{ "type":"structure", "required":["url"], "members":{ "url":{ "shape":"HarnessRemoteMcpUrl", "documentation":"URL of the MCP endpoint.
" }, "headers":{ "shape":"HttpHeadersMap", "documentation":"Custom headers to include when connecting to the remote MCP server.
" } }, "documentation":"Configuration for connecting to a remote MCP server.
" }, "HarnessRemoteMcpUrl":{ "type":"string", "max":16383, "min":1, "sensitive":true }, "HarnessSkill":{ "type":"structure", "members":{ "path":{ "shape":"HarnessSkillPath", "documentation":"The filesystem path to the skill definition.
" } }, "documentation":"A skill available to the agent.
", "union":true }, "HarnessSkillPath":{ "type":"string", "min":1 }, "HarnessSkills":{ "type":"list", "member":{"shape":"HarnessSkill"} }, "HarnessStopReason":{ "type":"string", "enum":[ "end_turn", "tool_use", "tool_result", "max_tokens", "stop_sequence", "content_filtered", "malformed_model_output", "malformed_tool_use", "interrupted", "partial_turn", "model_context_window_exceeded", "max_iterations_exceeded", "max_output_tokens_exceeded", "timeout_exceeded" ] }, "HarnessStreamMetrics":{ "type":"structure", "required":["latencyMs"], "members":{ "latencyMs":{ "shape":"Long", "documentation":"The end-to-end latency of the invocation in milliseconds.
" } }, "documentation":"Latency metrics for the invocation.
" }, "HarnessSystemContentBlock":{ "type":"structure", "members":{ "text":{ "shape":"SensitiveText", "documentation":"The text content of the system prompt block.
" } }, "documentation":"A content block in the system prompt.
", "union":true }, "HarnessSystemPrompt":{ "type":"list", "member":{"shape":"HarnessSystemContentBlock"} }, "HarnessTokenUsage":{ "type":"structure", "required":[ "inputTokens", "outputTokens", "totalTokens" ], "members":{ "inputTokens":{ "shape":"HarnessTokenUsageInputTokensInteger", "documentation":"The number of input tokens consumed.
" }, "outputTokens":{ "shape":"HarnessTokenUsageOutputTokensInteger", "documentation":"The number of output tokens generated.
" }, "totalTokens":{ "shape":"HarnessTokenUsageTotalTokensInteger", "documentation":"The total number of tokens consumed.
" }, "cacheReadInputTokens":{ "shape":"HarnessTokenUsageCacheReadInputTokensInteger", "documentation":"The number of input tokens read from cache.
" }, "cacheWriteInputTokens":{ "shape":"HarnessTokenUsageCacheWriteInputTokensInteger", "documentation":"The number of input tokens written to cache.
" } }, "documentation":"Token usage counts for the invocation.
" }, "HarnessTokenUsageCacheReadInputTokensInteger":{ "type":"integer", "box":true, "min":0 }, "HarnessTokenUsageCacheWriteInputTokensInteger":{ "type":"integer", "box":true, "min":0 }, "HarnessTokenUsageInputTokensInteger":{ "type":"integer", "box":true, "min":0 }, "HarnessTokenUsageOutputTokensInteger":{ "type":"integer", "box":true, "min":0 }, "HarnessTokenUsageTotalTokensInteger":{ "type":"integer", "box":true, "min":0 }, "HarnessTool":{ "type":"structure", "required":["type"], "members":{ "type":{ "shape":"HarnessToolType", "documentation":"The type of tool.
" }, "name":{ "shape":"HarnessToolName", "documentation":"Unique name for the tool. If not provided, a name will be inferred or generated.
" }, "config":{ "shape":"HarnessToolConfiguration", "documentation":"Tool-specific configuration.
" } }, "documentation":"A tool available to the agent loop.
" }, "HarnessToolConfiguration":{ "type":"structure", "members":{ "remoteMcp":{ "shape":"HarnessRemoteMcpConfig", "documentation":"Configuration for remote MCP server.
" }, "agentCoreBrowser":{ "shape":"HarnessAgentCoreBrowserConfig", "documentation":"Configuration for AgentCore Browser.
" }, "agentCoreGateway":{ "shape":"HarnessAgentCoreGatewayConfig", "documentation":"Configuration for AgentCore Gateway.
" }, "inlineFunction":{ "shape":"HarnessInlineFunctionConfig", "documentation":"Configuration for an inline function tool.
" }, "agentCoreCodeInterpreter":{ "shape":"HarnessAgentCoreCodeInterpreterConfig", "documentation":"Configuration for AgentCore Code Interpreter.
" } }, "documentation":"Configuration union for different tool types.
", "union":true }, "HarnessToolName":{ "type":"string", "max":64, "min":1, "pattern":"[a-zA-Z0-9_-]+" }, "HarnessToolResultBlock":{ "type":"structure", "required":[ "toolUseId", "content" ], "members":{ "toolUseId":{ "shape":"HarnessToolUseId", "documentation":"The tool use ID that this result corresponds to.
" }, "content":{ "shape":"HarnessToolResultContentBlocks", "documentation":"The content of the tool result.
" }, "status":{ "shape":"HarnessToolUseStatus", "documentation":"The status of the tool execution.
" }, "type":{ "shape":"HarnessToolUseType", "documentation":"The type of tool use that produced this result.
" } }, "documentation":"The result of a tool execution.
" }, "HarnessToolResultBlockDelta":{ "type":"structure", "members":{ "text":{ "shape":"SensitiveText", "documentation":"A text tool result delta.
" }, "json":{ "shape":"SensitiveJson", "documentation":"A JSON tool result delta.
" } }, "documentation":"A delta update to a tool result content block.
", "union":true }, "HarnessToolResultBlockStart":{ "type":"structure", "required":["toolUseId"], "members":{ "toolUseId":{ "shape":"HarnessToolUseId", "documentation":"The tool use ID that this result corresponds to.
" }, "status":{ "shape":"HarnessToolUseStatus", "documentation":"The status of the tool execution.
" } }, "documentation":"Start payload for a tool result content block.
" }, "HarnessToolResultBlocksDelta":{ "type":"list", "member":{"shape":"HarnessToolResultBlockDelta"} }, "HarnessToolResultContentBlock":{ "type":"structure", "members":{ "text":{ "shape":"SensitiveText", "documentation":"Text content.
" }, "json":{ "shape":"SensitiveJson", "documentation":"JSON content.
" } }, "documentation":"A content block within a tool result.
", "union":true }, "HarnessToolResultContentBlocks":{ "type":"list", "member":{"shape":"HarnessToolResultContentBlock"} }, "HarnessToolType":{ "type":"string", "enum":[ "remote_mcp", "agentcore_browser", "agentcore_gateway", "inline_function", "agentcore_code_interpreter" ] }, "HarnessToolUseBlock":{ "type":"structure", "required":[ "name", "toolUseId", "input" ], "members":{ "name":{ "shape":"HarnessToolName", "documentation":"The name of the tool to call.
" }, "toolUseId":{ "shape":"HarnessToolUseId", "documentation":"The unique ID of this tool use.
" }, "input":{ "shape":"SensitiveJson", "documentation":"The JSON input to pass to the tool.
" }, "type":{ "shape":"HarnessToolUseType", "documentation":"The type of tool use.
" }, "serverName":{ "shape":"String", "documentation":"The name of the MCP server providing this tool.
" } }, "documentation":"A tool use request from the model.
" }, "HarnessToolUseBlockDelta":{ "type":"structure", "required":["input"], "members":{ "input":{ "shape":"SensitiveText", "documentation":"The partial JSON input for the tool call.
" } }, "documentation":"Delta payload for tool use input.
" }, "HarnessToolUseBlockStart":{ "type":"structure", "required":[ "toolUseId", "name" ], "members":{ "toolUseId":{ "shape":"HarnessToolUseId", "documentation":"The unique ID of this tool use.
" }, "name":{ "shape":"HarnessToolName", "documentation":"The name of the tool being called.
" }, "type":{ "shape":"HarnessToolUseType", "documentation":"The type of tool use.
" }, "serverName":{ "shape":"String", "documentation":"The name of the MCP server providing this tool.
" } }, "documentation":"Start payload for a tool use content block.
" }, "HarnessToolUseId":{ "type":"string", "max":64, "min":1, "pattern":"[a-zA-Z0-9_-]+" }, "HarnessToolUseStatus":{ "type":"string", "enum":[ "success", "error" ] }, "HarnessToolUseType":{ "type":"string", "enum":[ "tool_use", "server_tool_use", "mcp_tool_use" ] }, "HarnessTools":{ "type":"list", "member":{"shape":"HarnessTool"} }, "HostName":{ "type":"string", "max":253, "min":1, "pattern":"[a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?(\\.[a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?)*" }, "HttpHeaderKey":{ "type":"string", "documentation":"The key of an HTTP header.
", "max":16383, "min":1 }, "HttpHeaderValue":{ "type":"string", "documentation":"The value of an HTTP header.
", "max":16383, "min":1 }, "HttpHeadersMap":{ "type":"map", "key":{"shape":"HttpHeaderKey"}, "value":{"shape":"HttpHeaderValue"}, "documentation":"Map of key/value pairs for HTTP headers.
", "sensitive":true }, "HttpResponseCode":{ "type":"integer", "box":true }, "IgnoredReferenceInputField":{ "type":"string", "max":1000, "min":1 }, "IgnoredReferenceInputFields":{ "type":"list", "member":{"shape":"IgnoredReferenceInputField"}, "max":100, "min":0 }, "InlineContent":{ "type":"string", "max":409600, "min":1 }, "InlineGroundTruth":{ "type":"structure", "members":{ "assertions":{ "shape":"EvaluationContentList", "documentation":"assertions for evaluation, reuses common model EvaluationContentList
" }, "expectedTrajectory":{ "shape":"EvaluationExpectedTrajectory", "documentation":"expectedTrajectory for evaluation, reuses common model EvaluationExpectedTrajectory
" }, "turns":{ "shape":"InlineGroundTruthTurnsList", "documentation":"A list of per-turn ground truth data, each containing an input prompt and expected response.
" } }, "documentation":"Inline ground truth data containing assertions, expected trajectories, and per-turn expected responses.
" }, "InlineGroundTruthTurnsList":{ "type":"list", "member":{"shape":"GroundTruthTurn"}, "min":1 }, "InputContentBlock":{ "type":"structure", "required":["path"], "members":{ "path":{ "shape":"MaxLenString", "documentation":"The path to the input content.
" }, "text":{ "shape":"MaxLenString", "documentation":"The text input content.
" }, "blob":{ "shape":"Body", "documentation":"The binary input content.
" } }, "documentation":"A block of input content.
" }, "InputContentBlockList":{ "type":"list", "member":{"shape":"InputContentBlock"} }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "members":{ "message":{"shape":"NonBlankString"} }, "documentation":"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.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "InvalidInputException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvokeAgentRuntimeCommandRequest":{ "type":"structure", "required":[ "agentRuntimeArn", "body" ], "members":{ "contentType":{ "shape":"MimeType", "documentation":"The MIME type of the input data in the request payload. This tells the agent runtime how to interpret the payload data. Common values include application/json for JSON data.
", "location":"header", "locationName":"Content-Type" }, "accept":{ "shape":"MimeType", "documentation":"The desired MIME type for the response from the agent runtime command. This tells the agent runtime what format to use for the response data. Common values include application/json for JSON data.
", "location":"header", "locationName":"Accept" }, "runtimeSessionId":{ "shape":"SessionType", "documentation":"The unique identifier of the runtime session in which to execute the command. This session ID is used to maintain state and context across multiple command invocations.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amzn-Bedrock-AgentCore-Runtime-Session-Id" }, "traceId":{ "shape":"InvokeAgentRuntimeCommandRequestTraceIdString", "documentation":"The trace identifier for request tracking.
", "location":"header", "locationName":"X-Amzn-Trace-Id" }, "traceParent":{ "shape":"InvokeAgentRuntimeCommandRequestTraceParentString", "documentation":"The parent trace information for distributed tracing.
", "location":"header", "locationName":"traceparent" }, "traceState":{ "shape":"InvokeAgentRuntimeCommandRequestTraceStateString", "documentation":"The trace state information for distributed tracing.
", "location":"header", "locationName":"tracestate" }, "baggage":{ "shape":"InvokeAgentRuntimeCommandRequestBaggageString", "documentation":"Additional context information for distributed tracing.
", "location":"header", "locationName":"baggage" }, "agentRuntimeArn":{ "shape":"String", "documentation":"The Amazon Resource Name (ARN) of the agent runtime on which to execute the command. This identifies the specific agent runtime environment where the command will run.
", "location":"uri", "locationName":"agentRuntimeArn" }, "qualifier":{ "shape":"String", "documentation":"The qualifier to use for the agent runtime. This is an endpoint name that points to a specific version. If not specified, Amazon Bedrock AgentCore uses the default endpoint of the agent runtime.
", "location":"querystring", "locationName":"qualifier" }, "accountId":{ "shape":"InvokeAgentRuntimeCommandRequestAccountIdString", "documentation":"The identifier of the Amazon Web Services account for the agent runtime resource. This parameter is required when you specify an agent ID instead of the full ARN for agentRuntimeArn.
The request body containing the command to execute and optional configuration parameters such as timeout settings.
" } }, "documentation":"Request for InvokeAgentRuntimeCommand operation.
", "payload":"body" }, "InvokeAgentRuntimeCommandRequestAccountIdString":{ "type":"string", "pattern":"[0-9]{12}" }, "InvokeAgentRuntimeCommandRequestBaggageString":{ "type":"string", "max":8192, "min":0 }, "InvokeAgentRuntimeCommandRequestBody":{ "type":"structure", "required":["command"], "members":{ "command":{ "shape":"InvokeAgentRuntimeCommandRequestBodyCommandString", "documentation":"The shell command to execute on the agent runtime. This command is executed in the runtime environment and its output is streamed back to the caller.
" }, "timeout":{ "shape":"Integer", "documentation":"The maximum duration in seconds to wait for the command to complete. If the command execution exceeds this timeout, it will be terminated. Default is 300 seconds. Minimum is 1 second. Maximum is 3600 seconds.
" } }, "documentation":"The request body structure for the InvokeAgentRuntimeCommand operation, containing the command to execute and optional configuration parameters.
The unique identifier of the runtime session in which the command was executed.
", "location":"header", "locationName":"X-Amzn-Bedrock-AgentCore-Runtime-Session-Id" }, "traceId":{ "shape":"String", "documentation":"The trace identifier for request tracking.
", "location":"header", "locationName":"X-Amzn-Trace-Id" }, "traceParent":{ "shape":"String", "documentation":"The parent trace information for distributed tracing.
", "location":"header", "locationName":"traceparent" }, "traceState":{ "shape":"String", "documentation":"The trace state information for distributed tracing.
", "location":"header", "locationName":"tracestate" }, "baggage":{ "shape":"String", "documentation":"Additional context information for distributed tracing.
", "location":"header", "locationName":"baggage" }, "contentType":{ "shape":"String", "documentation":"The MIME type of the response data. This indicates how to interpret the response data. Common values include application/json for JSON data.
", "location":"header", "locationName":"Content-Type" }, "statusCode":{ "shape":"HttpResponseCode", "documentation":"The HTTP status code of the response. A status code of 200 indicates a successful operation. Other status codes indicate various error conditions.
", "location":"statusCode" }, "stream":{ "shape":"InvokeAgentRuntimeCommandStreamOutput", "documentation":"The streaming output from the command execution. This stream contains events that provide real-time updates including standard output, standard error, and completion status.
" } }, "documentation":"Response for InvokeAgentRuntimeCommand operation.
", "payload":"stream" }, "InvokeAgentRuntimeCommandStreamOutput":{ "type":"structure", "members":{ "chunk":{ "shape":"ResponseChunk", "documentation":"A response chunk containing command execution events such as content start, content delta, or content stop events.
" }, "accessDeniedException":{ "shape":"AccessDeniedException", "documentation":"Exception events for error streaming.
" }, "internalServerException":{"shape":"InternalServerException"}, "resourceNotFoundException":{"shape":"ResourceNotFoundException"}, "serviceQuotaExceededException":{"shape":"ServiceQuotaExceededException"}, "throttlingException":{"shape":"ThrottlingException"}, "validationException":{"shape":"ValidationException"}, "runtimeClientError":{"shape":"RuntimeClientError"} }, "documentation":"The streaming output union for the InvokeAgentRuntimeCommand operation. This union delivers typed events: contentStart (first), contentDelta (middle), and contentStop (last).
The MIME type of the input data in the payload. This tells the agent runtime how to interpret the payload data. Common values include application/json for JSON data.
", "location":"header", "locationName":"Content-Type" }, "accept":{ "shape":"MimeType", "documentation":"The desired MIME type for the response from the agent runtime. This tells the agent runtime what format to use for the response data. Common values include application/json for JSON data.
", "location":"header", "locationName":"Accept" }, "mcpSessionId":{ "shape":"StringType", "documentation":"The identifier of the MCP session.
", "location":"header", "locationName":"Mcp-Session-Id" }, "runtimeSessionId":{ "shape":"SessionType", "documentation":"The identifier of the runtime session.
", "idempotencyToken":true, "location":"header", "locationName":"X-Amzn-Bedrock-AgentCore-Runtime-Session-Id" }, "mcpProtocolVersion":{ "shape":"StringType", "documentation":"The version of the MCP protocol being used.
", "location":"header", "locationName":"Mcp-Protocol-Version" }, "runtimeUserId":{ "shape":"StringType", "documentation":"The identifier of the runtime user.
", "location":"header", "locationName":"X-Amzn-Bedrock-AgentCore-Runtime-User-Id" }, "traceId":{ "shape":"InvokeAgentRuntimeRequestTraceIdString", "documentation":"The trace identifier for request tracking.
", "location":"header", "locationName":"X-Amzn-Trace-Id" }, "traceParent":{ "shape":"InvokeAgentRuntimeRequestTraceParentString", "documentation":"The parent trace information for distributed tracing.
", "location":"header", "locationName":"traceparent" }, "traceState":{ "shape":"InvokeAgentRuntimeRequestTraceStateString", "documentation":"The trace state information for distributed tracing.
", "location":"header", "locationName":"tracestate" }, "baggage":{ "shape":"InvokeAgentRuntimeRequestBaggageString", "documentation":"Additional context information for distributed tracing.
", "location":"header", "locationName":"baggage" }, "agentRuntimeArn":{ "shape":"String", "documentation":"The identifier of the agent runtime to invoke. You can specify either the full Amazon Web Services Resource Name (ARN) or the agent ID. If you use the agent ID, you must also provide the accountId query parameter.
The qualifier to use for the agent runtime. This is an endpoint name that points to a specific version. If not specified, Amazon Bedrock AgentCore uses the default endpoint of the agent runtime.
", "location":"querystring", "locationName":"qualifier" }, "accountId":{ "shape":"InvokeAgentRuntimeRequestAccountIdString", "documentation":"The identifier of the Amazon Web Services account for the agent runtime resource. This parameter is required when you specify an agent ID instead of the full ARN for agentRuntimeArn.
The input data to send to the agent runtime. The format of this data depends on the specific agent configuration and must match the specified content type. For most agents, this is a JSON object containing the user's request.
" } }, "payload":"payload" }, "InvokeAgentRuntimeRequestAccountIdString":{ "type":"string", "pattern":"[0-9]{12}" }, "InvokeAgentRuntimeRequestBaggageString":{ "type":"string", "max":8192, "min":0 }, "InvokeAgentRuntimeRequestTraceIdString":{ "type":"string", "max":128, "min":0 }, "InvokeAgentRuntimeRequestTraceParentString":{ "type":"string", "max":128, "min":0 }, "InvokeAgentRuntimeRequestTraceStateString":{ "type":"string", "max":512, "min":0 }, "InvokeAgentRuntimeResponse":{ "type":"structure", "required":["contentType"], "members":{ "runtimeSessionId":{ "shape":"SessionId", "documentation":"The identifier of the runtime session.
", "location":"header", "locationName":"X-Amzn-Bedrock-AgentCore-Runtime-Session-Id" }, "mcpSessionId":{ "shape":"SessionId", "documentation":"The identifier of the MCP session.
", "location":"header", "locationName":"Mcp-Session-Id" }, "mcpProtocolVersion":{ "shape":"String", "documentation":"The version of the MCP protocol being used.
", "location":"header", "locationName":"Mcp-Protocol-Version" }, "traceId":{ "shape":"String", "documentation":"The trace identifier for request tracking.
", "location":"header", "locationName":"X-Amzn-Trace-Id" }, "traceParent":{ "shape":"String", "documentation":"The parent trace information for distributed tracing.
", "location":"header", "locationName":"traceparent" }, "traceState":{ "shape":"String", "documentation":"The trace state information for distributed tracing.
", "location":"header", "locationName":"tracestate" }, "baggage":{ "shape":"String", "documentation":"Additional context information for distributed tracing.
", "location":"header", "locationName":"baggage" }, "contentType":{ "shape":"String", "documentation":"The MIME type of the response data. This indicates how to interpret the response data. Common values include application/json for JSON data.
", "location":"header", "locationName":"Content-Type" }, "response":{ "shape":"ResponseStream", "documentation":"The response data from the agent runtime. The format of this data depends on the specific agent configuration and the requested accept type. For most agents, this is a JSON object containing the agent's response to the user's request.
" }, "statusCode":{ "shape":"HttpResponseCode", "documentation":"The HTTP status code of the response. A status code of 200 indicates a successful operation. Other status codes indicate various error conditions.
", "location":"statusCode" } }, "payload":"response" }, "InvokeBrowserRequest":{ "type":"structure", "required":[ "browserIdentifier", "sessionId", "action" ], "members":{ "browserIdentifier":{ "shape":"String", "documentation":"The unique identifier of the browser associated with the session. This must match the identifier used when creating the session with StartBrowserSession.
The unique identifier of the browser session on which to perform the action. This must be an active session created with StartBrowserSession.
The browser action to perform. Exactly one member of the BrowserAction union must be set per request.
Request for the InvokeBrowser operation.
" }, "InvokeBrowserResponse":{ "type":"structure", "required":[ "result", "sessionId" ], "members":{ "result":{ "shape":"BrowserActionResult", "documentation":"The result of the browser action. The member set in the result corresponds to the action that was performed.
" }, "sessionId":{ "shape":"BrowserSessionId", "documentation":"The unique identifier of the browser session on which the action was performed.
", "location":"header", "locationName":"x-amzn-browser-session-id" } }, "documentation":"Response for the InvokeBrowser operation.
" }, "InvokeCodeInterpreterRequest":{ "type":"structure", "required":[ "codeInterpreterIdentifier", "name" ], "members":{ "codeInterpreterIdentifier":{ "shape":"String", "documentation":"The unique identifier of the code interpreter associated with the session. This must match the identifier used when creating the session with StartCodeInterpreterSession.
The unique identifier of the code interpreter session to use. This must be an active session created with StartCodeInterpreterSession. If the session has expired or been stopped, the request will fail.
The trace identifier for request tracking.
", "location":"header", "locationName":"X-Amzn-Trace-Id" }, "traceParent":{ "shape":"InvokeCodeInterpreterRequestTraceParentString", "documentation":"The parent trace information for distributed tracing.
", "location":"header", "locationName":"traceparent" }, "name":{ "shape":"ToolName", "documentation":"The name of the code interpreter to invoke.
" }, "arguments":{ "shape":"ToolArguments", "documentation":"The arguments for the code interpreter. This includes the code to execute and any additional parameters such as the programming language, whether to clear the execution context, and other execution options. The structure of this parameter depends on the specific code interpreter being used.
" } } }, "InvokeCodeInterpreterRequestTraceIdString":{ "type":"string", "max":1024, "min":0 }, "InvokeCodeInterpreterRequestTraceParentString":{ "type":"string", "max":1024, "min":0 }, "InvokeCodeInterpreterResponse":{ "type":"structure", "required":["stream"], "members":{ "sessionId":{ "shape":"CodeInterpreterSessionId", "documentation":"The identifier of the code interpreter session.
", "location":"header", "locationName":"x-amzn-code-interpreter-session-id" }, "stream":{ "shape":"CodeInterpreterStreamOutput", "documentation":"The stream containing the results of the code execution. This includes output, errors, and execution status.
" } }, "payload":"stream" }, "InvokeHarnessRequest":{ "type":"structure", "required":[ "harnessArn", "runtimeSessionId", "messages" ], "members":{ "harnessArn":{ "shape":"HarnessArn", "documentation":"The ARN of the harness to invoke.
", "location":"querystring", "locationName":"harnessArn" }, "runtimeSessionId":{ "shape":"SessionId", "documentation":"The session ID for the invocation. Use the same session ID across requests to continue a conversation.
", "location":"header", "locationName":"X-Amzn-Bedrock-AgentCore-Runtime-Session-Id" }, "messages":{ "shape":"HarnessMessages", "documentation":"The messages to send to the agent.
" }, "model":{ "shape":"HarnessModelConfiguration", "documentation":"The model configuration to use for this invocation. If specified, overrides the harness default.
" }, "systemPrompt":{ "shape":"HarnessSystemPrompt", "documentation":"The system prompt to use for this invocation. If specified, overrides the harness default.
" }, "tools":{ "shape":"HarnessTools", "documentation":"The tools available to the agent for this invocation. If specified, overrides the harness default.
" }, "skills":{ "shape":"HarnessSkills", "documentation":"The skills available to the agent for this invocation. If specified, overrides the harness default.
" }, "allowedTools":{ "shape":"HarnessAllowedTools", "documentation":"The tools that the agent is allowed to use for this invocation. If specified, overrides the harness default.
" }, "maxIterations":{ "shape":"Integer", "documentation":"The maximum number of iterations the agent loop can execute. If specified, overrides the harness default.
" }, "maxTokens":{ "shape":"Integer", "documentation":"The maximum number of tokens the agent can generate per iteration. If specified, overrides the harness default.
" }, "timeoutSeconds":{ "shape":"Integer", "documentation":"The maximum duration in seconds for the agent loop execution. If specified, overrides the harness default.
" }, "actorId":{ "shape":"String", "documentation":"The actor ID for memory operations. Overrides the actor ID configured on the harness.
" } } }, "InvokeHarnessResponse":{ "type":"structure", "required":["stream"], "members":{ "stream":{ "shape":"InvokeHarnessStreamOutput", "documentation":"The streaming output from the harness invocation.
" } }, "payload":"stream" }, "InvokeHarnessStreamOutput":{ "type":"structure", "members":{ "messageStart":{ "shape":"HarnessMessageStartEvent", "documentation":"Indicates the start of a new message from the agent.
" }, "contentBlockStart":{ "shape":"HarnessContentBlockStartEvent", "documentation":"Indicates the start of a new content block.
" }, "contentBlockDelta":{ "shape":"HarnessContentBlockDeltaEvent", "documentation":"A delta update to the current content block.
" }, "contentBlockStop":{ "shape":"HarnessContentBlockStopEvent", "documentation":"Indicates the end of the current content block.
" }, "messageStop":{ "shape":"HarnessMessageStopEvent", "documentation":"Indicates the end of the current message.
" }, "metadata":{ "shape":"HarnessMetadataEvent", "documentation":"Token usage and latency metrics for the invocation.
" }, "internalServerException":{"shape":"InternalServerException"}, "validationException":{"shape":"ValidationException"}, "runtimeClientError":{"shape":"RuntimeClientError"} }, "documentation":"The streaming events returned by a harness invocation.
", "eventstream":true }, "KeyList":{ "type":"list", "member":{"shape":"String"}, "documentation":"A list of key names for keyboard shortcuts.
", "max":5, "min":1 }, "KeyPressArguments":{ "type":"structure", "required":["key"], "members":{ "key":{ "shape":"String", "documentation":"The key name to press (for example, enter, tab, escape).
The number of times to press the key. Valid range: 1–100. Defaults to 1.
" } }, "documentation":"Arguments for a key press action.
" }, "KeyPressArgumentsPressesInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "KeyPressResult":{ "type":"structure", "required":["status"], "members":{ "status":{ "shape":"BrowserActionStatus", "documentation":"The status of the action execution.
" }, "error":{ "shape":"String", "documentation":"The error message. Present only when the action failed.
" } }, "documentation":"The result of a key press action.
" }, "KeyShortcutArguments":{ "type":"structure", "required":["keys"], "members":{ "keys":{ "shape":"KeyList", "documentation":"The key combination to press (for example, [\"ctrl\", \"s\"]). Maximum 5 keys.
Arguments for a key shortcut action.
" }, "KeyShortcutResult":{ "type":"structure", "required":["status"], "members":{ "status":{ "shape":"BrowserActionStatus", "documentation":"The status of the action execution.
" }, "error":{ "shape":"String", "documentation":"The error message. Present only when the action failed.
" } }, "documentation":"The result of a key shortcut action.
" }, "KeyTypeArguments":{ "type":"structure", "required":["text"], "members":{ "text":{ "shape":"KeyTypeArgumentsTextString", "documentation":"The text string to type. Maximum length: 10,000 characters.
" } }, "documentation":"Arguments for a key type action.
" }, "KeyTypeArgumentsTextString":{ "type":"string", "max":10000, "min":0 }, "KeyTypeResult":{ "type":"structure", "required":["status"], "members":{ "status":{ "shape":"BrowserActionStatus", "documentation":"The status of the action execution.
" }, "error":{ "shape":"String", "documentation":"The error message. Present only when the action failed.
" } }, "documentation":"The result of a key type action.
" }, "LanguageRuntime":{ "type":"string", "enum":[ "nodejs", "deno", "python" ] }, "LeftExpression":{ "type":"structure", "members":{ "metadataKey":{ "shape":"MetadataKey", "documentation":"Key associated with the metadata in an event.
" } }, "documentation":"Left expression of the event metadata filter.
", "union":true }, "ListABTestsRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"ListABTestsRequestMaxResultsInteger", "documentation":"The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The list of A/B test summaries.
" }, "nextToken":{ "shape":"String", "documentation":"If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
The identifier of the AgentCore Memory resource for which to list actors.
", "location":"uri", "locationName":"memoryId" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return in a single call. The default value is 20.
" }, "nextToken":{ "shape":"PaginationToken", "documentation":"The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
" } } }, "ListActorsOutput":{ "type":"structure", "required":["actorSummaries"], "members":{ "actorSummaries":{ "shape":"ActorSummaryList", "documentation":"The list of actor summaries.
" }, "nextToken":{ "shape":"PaginationToken", "documentation":"The token to use in a subsequent request to get the next set of results. This value is null when there are no more results to return.
" } } }, "ListBatchEvaluationsRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"ListBatchEvaluationsRequestMaxResultsInteger", "documentation":"The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The list of batch evaluation summaries.
" }, "nextToken":{ "shape":"String", "documentation":"If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
The unique identifier of the browser to list sessions for. If specified, only sessions for this browser are returned. If not specified, sessions for all browsers are returned.
", "location":"uri", "locationName":"browserIdentifier" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return in a single call. The default value is 10. Valid values range from 1 to 100. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. If not specified, Amazon Bedrock AgentCore returns the first page of results.
" }, "status":{ "shape":"BrowserSessionStatus", "documentation":"The status of the browser sessions to list. Valid values include ACTIVE, STOPPING, and STOPPED. If not specified, sessions with any status are returned.
" } } }, "ListBrowserSessionsResponse":{ "type":"structure", "required":["items"], "members":{ "items":{ "shape":"BrowserSessionSummaries", "documentation":"The list of browser sessions that match the specified criteria.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token to use in a subsequent ListBrowserSessions request to get the next set of results.
The unique identifier of the code interpreter to list sessions for. If specified, only sessions for this code interpreter are returned. If not specified, sessions for all code interpreters are returned.
", "location":"uri", "locationName":"codeInterpreterIdentifier" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return in a single call. The default value is 10. Valid values range from 1 to 100. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. If not specified, Amazon Bedrock AgentCore returns the first page of results.
" }, "status":{ "shape":"CodeInterpreterSessionStatus", "documentation":"The status of the code interpreter sessions to list. Valid values include ACTIVE, STOPPING, and STOPPED. If not specified, sessions with any status are returned.
" } } }, "ListCodeInterpreterSessionsResponse":{ "type":"structure", "required":["items"], "members":{ "items":{ "shape":"CodeInterpreterSessionSummaries", "documentation":"The list of code interpreter sessions that match the specified criteria.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token to use in a subsequent ListCodeInterpreterSessions request to get the next set of results.
The identifier of the AgentCore Memory resource for which to list events.
", "location":"uri", "locationName":"memoryId" }, "sessionId":{ "shape":"SessionId", "documentation":"The identifier of the session for which to list events.
", "location":"uri", "locationName":"sessionId" }, "actorId":{ "shape":"ActorId", "documentation":"The identifier of the actor for which to list events.
", "location":"uri", "locationName":"actorId" }, "includePayloads":{ "shape":"Boolean", "documentation":"Specifies whether to include event payloads in the response. Set to true to include payloads, or false to exclude them.
" }, "filter":{ "shape":"FilterInput", "documentation":"Filter criteria to apply when listing events.
" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return in a single call. The default value is 20.
" }, "nextToken":{ "shape":"PaginationToken", "documentation":"The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
" } } }, "ListEventsOutput":{ "type":"structure", "required":["events"], "members":{ "events":{ "shape":"EventList", "documentation":"The list of events that match the specified criteria.
" }, "nextToken":{ "shape":"PaginationToken", "documentation":"The token to use in a subsequent request to get the next set of results. This value is null when there are no more results to return.
" } } }, "ListMemoryExtractionJobsInput":{ "type":"structure", "required":["memoryId"], "members":{ "memoryId":{ "shape":"MemoryId", "documentation":"The unique identifier of the memory to list extraction jobs for.
", "location":"uri", "locationName":"memoryId" }, "maxResults":{ "shape":"ListMemoryExtractionJobsInputMaxResultsInteger", "documentation":"The maximum number of results to return in a single call. The default value is 20.
" }, "filter":{ "shape":"ExtractionJobFilterInput", "documentation":"Filter criteria to apply when listing extraction jobs.
" }, "nextToken":{ "shape":"PaginationToken", "documentation":"The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
" } } }, "ListMemoryExtractionJobsInputMaxResultsInteger":{ "type":"integer", "box":true, "max":50, "min":1 }, "ListMemoryExtractionJobsOutput":{ "type":"structure", "required":["jobs"], "members":{ "jobs":{ "shape":"ExtractionJobMetadataList", "documentation":"List of extraction job metadata matching the specified criteria.
" }, "nextToken":{ "shape":"PaginationToken", "documentation":"Token to retrieve the next page of results, if available.
" } } }, "ListMemoryRecordsInput":{ "type":"structure", "required":["memoryId"], "members":{ "memoryId":{ "shape":"MemoryId", "documentation":"The identifier of the AgentCore Memory resource for which to list memory records.
", "location":"uri", "locationName":"memoryId" }, "namespace":{ "shape":"Namespace", "documentation":"The namespace prefix to filter memory records by. Returns all memory records in namespaces that start with the provided prefix.
" }, "namespacePath":{ "shape":"Namespace", "documentation":"Use namespacePath for hierarchical retrievals. Return all memory records where namespace falls under the same parent hierarchy.
" }, "memoryStrategyId":{ "shape":"MemoryStrategyId", "documentation":"The memory strategy identifier to filter memory records by. If specified, only memory records with this strategy ID are returned.
" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return in a single call. The default value is 20.
" }, "nextToken":{ "shape":"PaginationToken", "documentation":"The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
" }, "metadataFilters":{ "shape":"MemoryMetadataFilterList", "documentation":"A list of metadata filter expressions to scope the returned memory records.
" } } }, "ListMemoryRecordsOutput":{ "type":"structure", "required":["memoryRecordSummaries"], "members":{ "memoryRecordSummaries":{ "shape":"MemoryRecordSummaryList", "documentation":"The list of memory record summaries that match the specified criteria.
" }, "nextToken":{ "shape":"PaginationToken", "documentation":"The token to use in a subsequent request to get the next set of results. This value is null when there are no more results to return.
" } } }, "ListRecommendationsRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"ListRecommendationsRequestMaxResultsInteger", "documentation":"The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
Optional filter to return only recommendations with the specified status.
", "location":"querystring", "locationName":"status" } } }, "ListRecommendationsRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListRecommendationsResponse":{ "type":"structure", "required":["recommendationSummaries"], "members":{ "recommendationSummaries":{ "shape":"RecommendationSummaryList", "documentation":"The list of recommendation summaries.
" }, "nextToken":{ "shape":"NextToken", "documentation":"If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
The identifier of the AgentCore Memory resource for which to list sessions.
", "location":"uri", "locationName":"memoryId" }, "actorId":{ "shape":"ActorId", "documentation":"The identifier of the actor for which to list sessions.
", "location":"uri", "locationName":"actorId" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return in a single call. The default value is 20.
" }, "nextToken":{ "shape":"PaginationToken", "documentation":"The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
" }, "filter":{ "shape":"SessionFilter", "documentation":"Filter criteria to apply when listing sessions.
" } } }, "ListSessionsOutput":{ "type":"structure", "required":["sessionSummaries"], "members":{ "sessionSummaries":{ "shape":"SessionSummaryList", "documentation":"The list of session summaries that match the specified criteria.
" }, "nextToken":{ "shape":"PaginationToken", "documentation":"The token to use in a subsequent request to get the next set of results. This value is null when there are no more results to return.
" } } }, "LiveViewStream":{ "type":"structure", "members":{ "streamEndpoint":{ "shape":"BrowserStreamEndpoint", "documentation":"The endpoint URL for the live view stream. This URL is used to establish a connection to receive visual updates from the browser session.
" } }, "documentation":"The configuration for a stream that provides a visual representation of a browser session in Amazon Bedrock AgentCore. This stream enables agents to observe the current state of the browser, including rendered web pages, visual elements, and the results of interactions.
" }, "Long":{ "type":"long", "box":true }, "MaxLenString":{ "type":"string", "max":100000000, "min":0 }, "MaxResults":{ "type":"integer", "box":true, "max":100, "min":1 }, "MaxTokens":{ "type":"integer", "box":true, "min":1 }, "McpDescriptor":{ "type":"structure", "required":[ "server", "tools" ], "members":{ "server":{ "shape":"ServerDefinition", "documentation":"The MCP server definition that describes the server configuration.
" }, "tools":{ "shape":"ToolsDefinition", "documentation":"The MCP tools definition that describes the available tools.
" } }, "documentation":"The MCP (Model Context Protocol) descriptor configuration for a registry record. Contains the server definition and tools definition.
" }, "MemoryContent":{ "type":"structure", "members":{ "text":{ "shape":"MemoryContentTextString", "documentation":"The text content of the memory record.
" } }, "documentation":"Contains the content of a memory record.
", "union":true }, "MemoryContentTextString":{ "type":"string", "max":16000, "min":1, "sensitive":true }, "MemoryId":{ "type":"string", "min":12, "pattern":"[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}" }, "MemoryMetadataFilterExpression":{ "type":"structure", "required":[ "left", "operator" ], "members":{ "left":{ "shape":"MemoryRecordLeftExpression", "documentation":"The metadata key to evaluate.
" }, "operator":{ "shape":"MemoryRecordOperatorType", "documentation":"The relationship between the metadata key and value to match when applying the metadata filter.
" }, "right":{ "shape":"MemoryRecordRightExpression", "documentation":"The value to compare against. Required for all operators except EXISTS and NOT_EXISTS.
" } }, "documentation":"Filters to apply to metadata associated with a memory. Specify the metadata key and value in the left and right fields and use the operator field to define the relationship to match.
The unique identifier of the memory record.
" }, "content":{ "shape":"MemoryContent", "documentation":"The content of the memory record.
" }, "memoryStrategyId":{ "shape":"MemoryStrategyId", "documentation":"The identifier of the memory strategy associated with this record.
" }, "namespaces":{ "shape":"NamespacesList", "documentation":"The namespaces associated with this memory record. Namespaces help organize and categorize memory records.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The timestamp when the memory record was created.
" }, "metadata":{ "shape":"MemoryRecordMetadataMap", "documentation":"A map of metadata key-value pairs associated with a memory record.
" } }, "documentation":"Contains information about a memory record in an AgentCore Memory resource.
" }, "MemoryRecordCreateInput":{ "type":"structure", "required":[ "requestIdentifier", "namespaces", "content", "timestamp" ], "members":{ "requestIdentifier":{ "shape":"RequestIdentifier", "documentation":"A client-provided identifier for tracking this specific record creation request.
" }, "namespaces":{ "shape":"NamespacesList", "documentation":"A list of namespace identifiers that categorize or group the memory record.
" }, "content":{ "shape":"MemoryContent", "documentation":"The content to be stored within the memory record.
" }, "timestamp":{ "shape":"Timestamp", "documentation":"Time at which the memory record was created.
" }, "memoryStrategyId":{ "shape":"MemoryStrategyId", "documentation":"The ID of the memory strategy that defines how this memory record is grouped.
" }, "metadata":{ "shape":"MemoryRecordMetadataMap", "documentation":"Metadata key-value pairs to be stored with the memory record.
" } }, "documentation":"Input structure to create a new memory record.
" }, "MemoryRecordDeleteInput":{ "type":"structure", "required":["memoryRecordId"], "members":{ "memoryRecordId":{ "shape":"MemoryRecordId", "documentation":"The unique ID of the memory record to be deleted.
" } }, "documentation":"Input structure to delete an existing memory record.
" }, "MemoryRecordId":{ "type":"string", "max":50, "min":40, "pattern":"mem-[a-zA-Z0-9-_]*" }, "MemoryRecordLeftExpression":{ "type":"structure", "members":{ "metadataKey":{ "shape":"MetadataKey", "documentation":"The metadata key to filter on.
" } }, "documentation":"The left-hand side of a memory record metadata filter expression.
", "union":true }, "MemoryRecordMetadataMap":{ "type":"map", "key":{"shape":"MetadataKey"}, "value":{"shape":"MemoryRecordMetadataValue"}, "max":20, "min":1 }, "MemoryRecordMetadataValue":{ "type":"structure", "members":{ "stringValue":{ "shape":"StringValue", "documentation":"A string value.
" }, "stringListValue":{ "shape":"StringValueList", "documentation":"A list of string values.
" }, "numberValue":{ "shape":"Double", "documentation":"A numeric value.
" }, "dateTimeValue":{ "shape":"Timestamp", "documentation":"A timestamp value in ISO 8601 UTC format.
" } }, "documentation":"The value of a memory record metadata entry.
", "union":true }, "MemoryRecordOperatorType":{ "type":"string", "enum":[ "EQUALS_TO", "EXISTS", "NOT_EXISTS", "BEFORE", "AFTER", "CONTAINS", "GREATER_THAN", "GREATER_THAN_OR_EQUALS", "LESS_THAN", "LESS_THAN_OR_EQUALS" ] }, "MemoryRecordOutput":{ "type":"structure", "required":[ "memoryRecordId", "status" ], "members":{ "memoryRecordId":{ "shape":"MemoryRecordId", "documentation":"The unique ID associated to the memory record.
" }, "status":{ "shape":"MemoryRecordStatus", "documentation":"The status of the memory record operation (e.g., SUCCEEDED, FAILED).
" }, "requestIdentifier":{ "shape":"RequestIdentifier", "documentation":"The client-provided identifier that was used to track this record operation.
" }, "errorCode":{ "shape":"Integer", "documentation":"The error code returned when the memory record operation fails.
" }, "errorMessage":{ "shape":"String", "documentation":"A human-readable error message describing why the memory record operation failed.
" } }, "documentation":"Output information returned after processing a memory record operation.
" }, "MemoryRecordRightExpression":{ "type":"structure", "members":{ "metadataValue":{ "shape":"MemoryRecordMetadataValue", "documentation":"The metadata value to compare against.
" } }, "documentation":"The right-hand side of a memory record metadata filter expression.
", "union":true }, "MemoryRecordStatus":{ "type":"string", "enum":[ "SUCCEEDED", "FAILED" ] }, "MemoryRecordSummary":{ "type":"structure", "required":[ "memoryRecordId", "content", "memoryStrategyId", "namespaces", "createdAt" ], "members":{ "memoryRecordId":{ "shape":"MemoryRecordId", "documentation":"The unique identifier of the memory record.
" }, "content":{ "shape":"MemoryContent", "documentation":"The content of the memory record.
" }, "memoryStrategyId":{ "shape":"MemoryStrategyId", "documentation":"The identifier of the memory strategy associated with this record.
" }, "namespaces":{ "shape":"NamespacesList", "documentation":"The namespaces associated with this memory record.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The timestamp when the memory record was created.
" }, "score":{ "shape":"Double", "documentation":"The relevance score of the memory record when returned as part of a search result. Higher values indicate greater relevance to the search query.
" }, "metadata":{ "shape":"MemoryRecordMetadataMap", "documentation":"A map of metadata key-value pairs associated with a memory record.
" } }, "documentation":"Contains summary information about a memory record.
" }, "MemoryRecordSummaryList":{ "type":"list", "member":{"shape":"MemoryRecordSummary"} }, "MemoryRecordUpdateInput":{ "type":"structure", "required":[ "memoryRecordId", "timestamp" ], "members":{ "memoryRecordId":{ "shape":"MemoryRecordId", "documentation":"The unique ID of the memory record to be updated.
" }, "timestamp":{ "shape":"Timestamp", "documentation":"Time at which the memory record was updated
" }, "content":{ "shape":"MemoryContent", "documentation":"The content to be stored within the memory record.
" }, "namespaces":{ "shape":"NamespacesList", "documentation":"The updated list of namespace identifiers for categorizing the memory record.
" }, "memoryStrategyId":{ "shape":"MemoryStrategyId", "documentation":"The updated ID of the memory strategy that defines how this memory record is grouped.
" }, "metadata":{ "shape":"MemoryRecordMetadataMap", "documentation":"Metadata key-value pairs to be stored with the memory record.
" } }, "documentation":"Input structure to update an existing memory record.
" }, "MemoryRecordsCreateInputList":{ "type":"list", "member":{"shape":"MemoryRecordCreateInput"}, "max":100, "min":0 }, "MemoryRecordsDeleteInputList":{ "type":"list", "member":{"shape":"MemoryRecordDeleteInput"}, "max":100, "min":0 }, "MemoryRecordsOutputList":{ "type":"list", "member":{"shape":"MemoryRecordOutput"} }, "MemoryRecordsUpdateInputList":{ "type":"list", "member":{"shape":"MemoryRecordUpdateInput"}, "max":100, "min":0 }, "MemoryStrategyId":{ "type":"string", "max":100, "min":1, "pattern":"[a-zA-Z0-9][a-zA-Z0-9-_]*" }, "MessageMetadata":{ "type":"structure", "required":[ "eventId", "messageIndex" ], "members":{ "eventId":{ "shape":"String", "documentation":"The identifier of the event associated with this message.
" }, "messageIndex":{ "shape":"Integer", "documentation":"The position of this message within that event’s ordered list of messages.
" } }, "documentation":"Metadata information associated with this message.
" }, "MessagesList":{ "type":"list", "member":{"shape":"MessageMetadata"} }, "MetadataFilterExpression":{ "type":"structure", "members":{}, "documentation":" A JSON document that represents a structured metadata filter expression. Supports field-level operators ($eq, $ne, $in) and logical operators ($and, $or) on filterable fields (name, descriptorType, version).
Value associated with the eventMetadata key.
Value associated with the eventMetadata key.
The mouse button to use for a browser mouse action.
", "enum":[ "LEFT", "RIGHT", "MIDDLE" ] }, "MouseClickArguments":{ "type":"structure", "required":[ "x", "y" ], "members":{ "x":{ "shape":"Integer", "documentation":"The X coordinate on screen where the click occurs.
" }, "y":{ "shape":"Integer", "documentation":"The Y coordinate on screen where the click occurs.
" }, "button":{ "shape":"MouseButton", "documentation":"The mouse button to use. Defaults to LEFT.
The number of clicks to perform. Valid range: 1–10. Defaults to 1.
" } }, "documentation":"Arguments for a mouse click action.
" }, "MouseClickArgumentsClickCountInteger":{ "type":"integer", "box":true, "max":10, "min":1 }, "MouseClickResult":{ "type":"structure", "required":["status"], "members":{ "status":{ "shape":"BrowserActionStatus", "documentation":"The status of the action execution.
" }, "error":{ "shape":"String", "documentation":"The error message. Present only when the action failed.
" } }, "documentation":"The result of a mouse click action.
" }, "MouseDragArguments":{ "type":"structure", "required":[ "endX", "endY", "startX", "startY" ], "members":{ "endX":{ "shape":"Integer", "documentation":"The ending X coordinate for the drag.
" }, "endY":{ "shape":"Integer", "documentation":"The ending Y coordinate for the drag.
" }, "startX":{ "shape":"Integer", "documentation":"The starting X coordinate for the drag.
" }, "startY":{ "shape":"Integer", "documentation":"The starting Y coordinate for the drag.
" }, "button":{ "shape":"MouseButton", "documentation":"The mouse button to use for the drag. Defaults to LEFT.
Arguments for a mouse drag action.
" }, "MouseDragResult":{ "type":"structure", "required":["status"], "members":{ "status":{ "shape":"BrowserActionStatus", "documentation":"The status of the action execution.
" }, "error":{ "shape":"String", "documentation":"The error message. Present only when the action failed.
" } }, "documentation":"The result of a mouse drag action.
" }, "MouseMoveArguments":{ "type":"structure", "required":[ "x", "y" ], "members":{ "x":{ "shape":"Integer", "documentation":"The target X coordinate on screen.
" }, "y":{ "shape":"Integer", "documentation":"The target Y coordinate on screen.
" } }, "documentation":"Arguments for a mouse move action.
" }, "MouseMoveResult":{ "type":"structure", "required":["status"], "members":{ "status":{ "shape":"BrowserActionStatus", "documentation":"The status of the action execution.
" }, "error":{ "shape":"String", "documentation":"The error message. Present only when the action failed.
" } }, "documentation":"The result of a mouse move action.
" }, "MouseScrollArguments":{ "type":"structure", "required":[ "x", "y" ], "members":{ "x":{ "shape":"Integer", "documentation":"The X coordinate on screen where the scroll occurs.
" }, "y":{ "shape":"Integer", "documentation":"The Y coordinate on screen where the scroll occurs.
" }, "deltaX":{ "shape":"MouseScrollArgumentsDeltaXInteger", "documentation":"The horizontal scroll delta. Valid range: -1000 to 1000.
" }, "deltaY":{ "shape":"MouseScrollArgumentsDeltaYInteger", "documentation":"The vertical scroll delta. Valid range: -1000 to 1000. Negative values scroll down.
" } }, "documentation":"Arguments for a mouse scroll action.
" }, "MouseScrollArgumentsDeltaXInteger":{ "type":"integer", "box":true, "max":1000, "min":-1000 }, "MouseScrollArgumentsDeltaYInteger":{ "type":"integer", "box":true, "max":1000, "min":-1000 }, "MouseScrollResult":{ "type":"structure", "required":["status"], "members":{ "status":{ "shape":"BrowserActionStatus", "documentation":"The status of the action execution.
" }, "error":{ "shape":"String", "documentation":"The error message. Present only when the action failed.
" } }, "documentation":"The result of a mouse scroll action.
" }, "Name":{ "type":"string", "max":100, "min":1 }, "Namespace":{ "type":"string", "max":1024, "min":1, "pattern":"[a-zA-Z0-9/*][a-zA-Z0-9-_/*]*(?::[a-zA-Z0-9-_/*]+)*[a-zA-Z0-9-_/*]*" }, "NamespacesList":{ "type":"list", "member":{"shape":"Namespace"}, "max":1, "min":0 }, "NextToken":{ "type":"string", "max":2048, "min":1, "pattern":"\\S*" }, "NonBlankString":{ "type":"string", "pattern":"[\\s\\S]+" }, "OAuthCredentialProvider":{ "type":"structure", "required":[ "providerArn", "scopes" ], "members":{ "providerArn":{ "shape":"OAuthCredentialProviderArn", "documentation":"The ARN of the OAuth 2.0 credential provider in AgentCore Identity.
" }, "scopes":{ "shape":"OAuthScopes", "documentation":"The OAuth 2.0 scopes to request when obtaining an access token.
" }, "customParameters":{ "shape":"OAuthCustomParameters", "documentation":"Additional custom parameters to include in the OAuth 2.0 token request.
" }, "grantType":{ "shape":"OAuthGrantType", "documentation":"The OAuth 2.0 grant type to use for authentication.
" }, "defaultReturnUrl":{ "shape":"OAuthDefaultReturnUrl", "documentation":"The default return URL for the OAuth 2.0 authorization flow.
" } }, "documentation":"Configuration for an OAuth 2.0 credential provider used to authenticate tool calls.
" }, "OAuthCredentialProviderArn":{ "type":"string", "pattern":"arn:([^:]*):([^:]*):([^:]*):([0-9]{12})?:(.+)" }, "OAuthCustomParameters":{ "type":"map", "key":{"shape":"OAuthCustomParametersKey"}, "value":{"shape":"OAuthCustomParametersValue"}, "max":10, "min":1 }, "OAuthCustomParametersKey":{ "type":"string", "max":256, "min":1 }, "OAuthCustomParametersValue":{ "type":"string", "max":2048, "min":1, "sensitive":true }, "OAuthDefaultReturnUrl":{ "type":"string", "max":2048, "min":1, "pattern":"\\w+:(\\/?\\/?)[^\\s]+" }, "OAuthGrantType":{ "type":"string", "enum":[ "CLIENT_CREDENTIALS", "AUTHORIZATION_CODE" ] }, "OAuthScope":{ "type":"string", "max":64, "min":1 }, "OAuthScopes":{ "type":"list", "member":{"shape":"OAuthScope"}, "max":100, "min":0 }, "Oauth2FlowType":{ "type":"string", "enum":[ "USER_FEDERATION", "M2M", "ON_BEHALF_OF_TOKEN_EXCHANGE" ] }, "OnlineEvaluationConfigArn":{ "type":"string", "pattern":"arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:online-evaluation-config\\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}" }, "OperatorType":{ "type":"string", "enum":[ "EQUALS_TO", "EXISTS", "NOT_EXISTS" ] }, "OutputConfig":{ "type":"structure", "members":{ "cloudWatchConfig":{ "shape":"CloudWatchOutputConfig", "documentation":"The CloudWatch Logs configuration for writing evaluation results.
" } }, "documentation":"Output destination configuration
", "union":true }, "PaginationToken":{"type":"string"}, "PathPattern":{ "type":"string", "max":500, "min":1 }, "PayloadType":{ "type":"structure", "members":{ "conversational":{ "shape":"Conversational", "documentation":"The conversational content of the payload.
" }, "blob":{ "shape":"Document", "documentation":"The binary content of the payload.
" } }, "documentation":"Contains the payload content for an event.
", "union":true }, "PayloadTypeList":{ "type":"list", "member":{"shape":"PayloadType"}, "max":100, "min":0 }, "PerVariantOnlineEvaluationConfig":{ "type":"structure", "required":[ "name", "onlineEvaluationConfigArn" ], "members":{ "name":{ "shape":"VariantName", "documentation":"The name of the variant this evaluation configuration applies to.
" }, "onlineEvaluationConfigArn":{ "shape":"OnlineEvaluationConfigArn", "documentation":"The Amazon Resource Name (ARN) of the online evaluation configuration for this variant.
" } }, "documentation":"An online evaluation configuration associated with a specific A/B test variant.
" }, "PerVariantOnlineEvaluationConfigList":{ "type":"list", "member":{"shape":"PerVariantOnlineEvaluationConfig"}, "max":2, "min":2 }, "ProgrammingLanguage":{ "type":"string", "enum":[ "python", "javascript", "typescript" ] }, "Proxy":{ "type":"structure", "members":{ "externalProxy":{ "shape":"ExternalProxy", "documentation":"Configuration for an external customer-managed proxy server.
" } }, "documentation":"Union type representing different proxy configurations. Currently supports external customer-managed proxies.
", "union":true }, "ProxyBypass":{ "type":"structure", "members":{ "domainPatterns":{ "shape":"DomainPatterns", "documentation":"Array of domain patterns that should bypass the proxy. Supports .amazonaws.com for subdomain matching or amazonaws.com for exact domain matching. Requests to these domains connect directly without using any proxy. Maximum 253 characters per pattern.
Configuration for domains that should bypass all proxies and connect directly to the internet. These bypass rules take precedence over all proxy routing rules.
" }, "ProxyConfiguration":{ "type":"structure", "required":["proxies"], "members":{ "proxies":{ "shape":"ProxyConfigurationProxiesList", "documentation":"An array of 1-5 proxy server configurations for domain-based routing. Each proxy can specify which domains it handles via domainPatterns, enabling flexible routing of different traffic through different proxies based on destination domain.
Optional configuration for domains that should bypass all proxies and connect directly to their destination, like the internet. Takes precedence over all proxy routing rules.
" } }, "documentation":"Configuration for routing browser traffic through customer-managed proxy servers. Supports 1-5 proxy servers for domain-based routing and proxy bypass rules.
" }, "ProxyConfigurationProxiesList":{ "type":"list", "member":{"shape":"Proxy"}, "max":5, "min":1 }, "ProxyCredentials":{ "type":"structure", "members":{ "basicAuth":{ "shape":"BasicAuth", "documentation":"HTTP Basic Authentication credentials (username and password) stored in Amazon Web Services Secrets Manager.
" } }, "documentation":"Union type representing different proxy authentication methods. Currently supports HTTP Basic Authentication (username and password).
", "union":true }, "RecommendationArn":{ "type":"string", "pattern":"arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:recommendation/[0-9a-zA-Z_-]{1,48}-[0-9A-Z]{10}" }, "RecommendationConfig":{ "type":"structure", "members":{ "systemPromptRecommendationConfig":{ "shape":"SystemPromptRecommendationConfig", "documentation":"The configuration for a system prompt recommendation.
" }, "toolDescriptionRecommendationConfig":{ "shape":"ToolDescriptionRecommendationConfig", "documentation":"The configuration for a tool description recommendation.
" } }, "documentation":"The configuration for a recommendation, varying by recommendation type.
", "union":true }, "RecommendationDescription":{ "type":"string", "max":4096, "min":0 }, "RecommendationErrorCode":{ "type":"string", "max":1024, "min":0 }, "RecommendationErrorMessage":{ "type":"string", "max":2048, "min":0 }, "RecommendationEvaluationConfig":{ "type":"structure", "required":["evaluators"], "members":{ "evaluators":{ "shape":"RecommendationEvaluationConfigEvaluatorsList", "documentation":"The list of evaluators to use for assessing recommendation quality.
" } }, "documentation":"The evaluation configuration for assessing recommendation quality.
" }, "RecommendationEvaluationConfigEvaluatorsList":{ "type":"list", "member":{"shape":"RecommendationEvaluatorReference"}, "max":1, "min":1 }, "RecommendationEvaluatorReference":{ "type":"structure", "required":["evaluatorArn"], "members":{ "evaluatorArn":{ "shape":"EvaluatorArn", "documentation":"The Amazon Resource Name (ARN) of the evaluator.
" } }, "documentation":"A reference to an evaluator used for recommendation assessment.
" }, "RecommendationId":{ "type":"string", "pattern":"[0-9a-zA-Z_-]{1,48}-[0-9A-Z]{10}" }, "RecommendationName":{ "type":"string", "max":100, "min":0, "pattern":"[a-zA-Z][a-zA-Z0-9_-]{0,47}" }, "RecommendationResult":{ "type":"structure", "members":{ "systemPromptRecommendationResult":{ "shape":"SystemPromptRecommendationResult", "documentation":"The result of a system prompt recommendation.
" }, "toolDescriptionRecommendationResult":{ "shape":"ToolDescriptionRecommendationResult", "documentation":"The result of a tool description recommendation.
" } }, "documentation":"The result of a recommendation, containing the optimized output.
", "union":true }, "RecommendationResultConfigurationBundle":{ "type":"structure", "required":[ "bundleArn", "versionId" ], "members":{ "bundleArn":{ "shape":"ConfigurationBundleArn", "documentation":"The Amazon Resource Name (ARN) of the configuration bundle.
" }, "versionId":{ "shape":"ConfigurationBundleVersionId", "documentation":"The version identifier of the configuration bundle containing the recommendation.
" } }, "documentation":"A configuration bundle reference in a recommendation result.
" }, "RecommendationStatus":{ "type":"string", "enum":[ "PENDING", "IN_PROGRESS", "COMPLETED", "FAILED", "DELETING" ] }, "RecommendationSummary":{ "type":"structure", "required":[ "recommendationId", "recommendationArn", "name", "type", "status", "createdAt", "updatedAt" ], "members":{ "recommendationId":{ "shape":"RecommendationId", "documentation":"The unique identifier of the recommendation.
" }, "recommendationArn":{ "shape":"RecommendationArn", "documentation":"The Amazon Resource Name (ARN) of the recommendation.
" }, "name":{ "shape":"RecommendationName", "documentation":"The name of the recommendation.
" }, "description":{ "shape":"RecommendationDescription", "documentation":"The description of the recommendation.
" }, "type":{ "shape":"RecommendationType", "documentation":"The type of recommendation.
" }, "status":{ "shape":"RecommendationStatus", "documentation":"The current status of the recommendation.
" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The timestamp when the recommendation was created.
" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The timestamp when the recommendation was last updated.
" } }, "documentation":"Summary information about a recommendation.
" }, "RecommendationSummaryList":{ "type":"list", "member":{"shape":"RecommendationSummary"} }, "RecommendationToolName":{ "type":"string", "max":256, "min":1, "pattern":"[a-zA-Z0-9_\\-\\.]+" }, "RecommendationType":{ "type":"string", "enum":[ "SYSTEM_PROMPT_RECOMMENDATION", "TOOL_DESCRIPTION_RECOMMENDATION" ] }, "RegistryArn":{ "type":"string", "max":2048, "min":1, "pattern":"arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}" }, "RegistryIdentifier":{ "type":"string", "max":2048, "min":1, "pattern":"(arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:registry/)?[a-zA-Z0-9]{12,16}" }, "RegistryRecordArn":{ "type":"string", "max":2048, "min":1, "pattern":"arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}/record/[a-zA-Z0-9]{12}" }, "RegistryRecordId":{ "type":"string", "max":12, "min":12, "pattern":"[a-zA-Z0-9]{12}" }, "RegistryRecordName":{ "type":"string", "max":255, "min":1, "pattern":"[a-zA-Z0-9][a-zA-Z0-9_\\-\\.\\/]*" }, "RegistryRecordStatus":{ "type":"string", "documentation":"The status of a registry record in its lifecycle.
", "enum":[ "DRAFT", "PENDING_APPROVAL", "APPROVED", "REJECTED", "DEPRECATED" ] }, "RegistryRecordSummary":{ "type":"structure", "required":[ "registryArn", "recordArn", "recordId", "name", "descriptorType", "descriptors", "version", "status", "createdAt", "updatedAt" ], "members":{ "registryArn":{ "shape":"RegistryArn", "documentation":"The Amazon Resource Name (ARN) of the registry that this record belongs to.
" }, "recordArn":{ "shape":"RegistryRecordArn", "documentation":"The Amazon Resource Name (ARN) of the registry record.
" }, "recordId":{ "shape":"RegistryRecordId", "documentation":"The unique identifier of the registry record.
" }, "name":{ "shape":"RegistryRecordName", "documentation":"The name of the registry record.
" }, "description":{ "shape":"Description", "documentation":"A description of the registry record.
" }, "descriptorType":{ "shape":"DescriptorType", "documentation":"The type of descriptor associated with this registry record.
" }, "descriptors":{ "shape":"Descriptors", "documentation":"The descriptor configurations for this registry record.
" }, "version":{ "shape":"RegistryRecordVersion", "documentation":"The version of the registry record.
" }, "status":{ "shape":"RegistryRecordStatus", "documentation":"The current status of the registry record.
" }, "createdAt":{ "shape":"DateTimestamp", "documentation":"The date and time when the registry record was created.
" }, "updatedAt":{ "shape":"DateTimestamp", "documentation":"The date and time when the registry record was last updated.
" } }, "documentation":"Summary information about a registry record.
" }, "RegistryRecordSummaryList":{ "type":"list", "member":{"shape":"RegistryRecordSummary"} }, "RegistryRecordVersion":{ "type":"string", "max":255, "min":1, "pattern":"[a-zA-Z0-9.-]+" }, "RequestIdentifier":{ "type":"string", "max":80, "min":1, "pattern":"[a-zA-Z0-9_-]+" }, "RequestUri":{ "type":"string", "max":1024, "min":1, "pattern":"urn:ietf:params:oauth:request_uri:[a-zA-Z0-9-._~]+" }, "ResourceContent":{ "type":"structure", "required":["type"], "members":{ "type":{ "shape":"ResourceContentType", "documentation":"The type of resource content.
" }, "uri":{ "shape":"String", "documentation":"The URI of the resource content.
" }, "mimeType":{ "shape":"String", "documentation":"The MIME type of the resource content.
" }, "text":{ "shape":"String", "documentation":"The text resource content.
" }, "blob":{ "shape":"Blob", "documentation":"The binary resource content.
" } }, "documentation":"Contains information about resource content.
" }, "ResourceContentType":{ "type":"string", "enum":[ "text", "blob" ] }, "ResourceLocation":{ "type":"structure", "members":{ "s3":{ "shape":"S3Location", "documentation":"The Amazon S3 location of the resource. Use this when the resource is stored in an Amazon S3 bucket.
" } }, "documentation":"The location of the browser extension.
", "union":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"NonBlankString"} }, "documentation":"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.
", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "ResourceOauth2ReturnUrlType":{ "type":"string", "max":2048, "min":1, "pattern":"\\w+:(\\/?\\/?)[^\\s]+" }, "ResourceType":{ "type":"string", "max":2048, "min":1 }, "ResourcesListType":{ "type":"list", "member":{"shape":"ResourceType"} }, "ResponseChunk":{ "type":"structure", "members":{ "contentStart":{ "shape":"ContentStartEvent", "documentation":"An event indicating the start of content streaming from the command execution. This is the first chunk received.
" }, "contentDelta":{ "shape":"ContentDeltaEvent", "documentation":"An event containing incremental output (stdout or stderr) from the command execution. These are the middle chunks.
" }, "contentStop":{ "shape":"ContentStopEvent", "documentation":"An event indicating the completion of the command execution, including the exit code and final status. This is the last chunk received.
" } }, "documentation":"A structure representing a response chunk that contains exactly one of the possible event types: contentStart, contentDelta, or contentStop.
The identifier of the AgentCore Memory resource from which to retrieve memory records.
", "location":"uri", "locationName":"memoryId" }, "namespace":{ "shape":"Namespace", "documentation":"The namespace prefix to filter memory records by. Searches for memory records in namespaces that start with the provided prefix.
" }, "namespacePath":{ "shape":"Namespace", "documentation":"Use namespacePath for hierarchical retrievals. Return all memory records where namespace falls under the same parent hierarchy.
" }, "searchCriteria":{ "shape":"SearchCriteria", "documentation":"The search criteria to use for finding relevant memory records. This includes the search query, memory strategy ID, and other search parameters.
" }, "nextToken":{ "shape":"PaginationToken", "documentation":"The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return in a single call. The default value is 20.
" } } }, "RetrieveMemoryRecordsOutput":{ "type":"structure", "required":["memoryRecordSummaries"], "members":{ "memoryRecordSummaries":{ "shape":"MemoryRecordSummaryList", "documentation":"The list of memory record summaries that match the search criteria, ordered by relevance.
" }, "nextToken":{ "shape":"PaginationToken", "documentation":"The token to use in a subsequent request to get the next set of results. This value is null when there are no more results to return.
" } } }, "RetryableConflictException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"The exception that occurs when there is a retryable conflict performing an operation. This is a temporary condition that may resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.
", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true, "retryable":{"throttling":false} }, "RightExpression":{ "type":"structure", "members":{ "metadataValue":{ "shape":"MetadataValue", "documentation":"Value associated with the key in eventMetadata.
Right expression of the eventMetadatafilter.
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.
", "error":{ "httpStatusCode":424, "senderFault":true }, "exception":true }, "S3Location":{ "type":"structure", "required":[ "bucket", "prefix" ], "members":{ "bucket":{ "shape":"S3LocationBucketString", "documentation":"The name of the Amazon S3 bucket where the resource is stored.
" }, "prefix":{ "shape":"S3LocationPrefixString", "documentation":"The name of the Amazon S3 prefix/key where the resource is stored.
" }, "versionId":{ "shape":"S3LocationVersionIdString", "documentation":"The name of the Amazon S3 version ID where the resource is stored (Optional).
" } }, "documentation":"The Amazon S3 location configuration of a resource.
" }, "S3LocationBucketString":{ "type":"string", "max":63, "min":3, "pattern":"[a-z0-9][a-z0-9.-]*[a-z0-9]" }, "S3LocationPrefixString":{ "type":"string", "max":1024, "min":1 }, "S3LocationVersionIdString":{ "type":"string", "max":1024, "min":1 }, "SaveBrowserSessionProfileRequest":{ "type":"structure", "required":[ "profileIdentifier", "browserIdentifier", "sessionId" ], "members":{ "traceId":{ "shape":"SaveBrowserSessionProfileRequestTraceIdString", "documentation":"The trace identifier for request tracking.
", "location":"header", "locationName":"X-Amzn-Trace-Id" }, "traceParent":{ "shape":"SaveBrowserSessionProfileRequestTraceParentString", "documentation":"The parent trace information for distributed tracing.
", "location":"header", "locationName":"traceparent" }, "profileIdentifier":{ "shape":"BrowserProfileId", "documentation":"The unique identifier for the browser profile. This identifier is used to reference the profile when starting new browser sessions. The identifier must follow the pattern of an alphanumeric name (up to 48 characters) followed by a hyphen and a 10-character alphanumeric suffix.
", "location":"uri", "locationName":"profileIdentifier" }, "browserIdentifier":{ "shape":"String", "documentation":"The unique identifier of the browser associated with the session from which to save the profile.
" }, "sessionId":{ "shape":"BrowserSessionId", "documentation":"The unique identifier of the browser session from which to save the profile. The session must be active when saving the profile.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request, but does not return an error.
", "idempotencyToken":true } } }, "SaveBrowserSessionProfileRequestTraceIdString":{ "type":"string", "max":1024, "min":0 }, "SaveBrowserSessionProfileRequestTraceParentString":{ "type":"string", "max":1024, "min":0 }, "SaveBrowserSessionProfileResponse":{ "type":"structure", "required":[ "profileIdentifier", "browserIdentifier", "sessionId", "lastUpdatedAt" ], "members":{ "profileIdentifier":{ "shape":"BrowserProfileId", "documentation":"The unique identifier of the saved browser profile.
" }, "browserIdentifier":{ "shape":"String", "documentation":"The unique identifier of the browser associated with the session from which the profile was saved.
" }, "sessionId":{ "shape":"BrowserSessionId", "documentation":"The unique identifier of the browser session from which the profile was saved.
" }, "lastUpdatedAt":{ "shape":"DateTimestamp", "documentation":"The timestamp when the browser profile was last updated. This value is in ISO 8601 format.
" } } }, "SchemaVersion":{ "type":"string", "max":255, "min":1 }, "ScopeType":{ "type":"string", "max":128, "min":1 }, "ScopesListType":{ "type":"list", "member":{"shape":"ScopeType"} }, "ScreenshotArguments":{ "type":"structure", "members":{ "format":{ "shape":"ScreenshotFormat", "documentation":"The image format for the screenshot. Defaults to PNG.
Arguments for a screenshot action.
" }, "ScreenshotFormat":{ "type":"string", "documentation":"The image format for a browser screenshot.
", "enum":["PNG"] }, "ScreenshotResult":{ "type":"structure", "required":["status"], "members":{ "status":{ "shape":"BrowserActionStatus", "documentation":"The status of the action execution.
" }, "error":{ "shape":"String", "documentation":"The error message. Present only when the action failed.
" }, "data":{ "shape":"Blob", "documentation":"The base64-encoded image data. Present only when the action succeeded.
" } }, "documentation":"The result of a screenshot action.
" }, "SearchCriteria":{ "type":"structure", "required":["searchQuery"], "members":{ "searchQuery":{ "shape":"SearchCriteriaSearchQueryString", "documentation":"The search query to use for finding relevant memory records.
" }, "memoryStrategyId":{ "shape":"MemoryStrategyId", "documentation":"The memory strategy identifier to filter memory records by.
" }, "topK":{ "shape":"SearchCriteriaTopKInteger", "documentation":"The maximum number of top-scoring memory records to return. This value is used for semantic search ranking.
" }, "metadataFilters":{ "shape":"MemoryMetadataFilterList", "documentation":"Filters to apply to metadata associated with a memory.
" } }, "documentation":"Contains search criteria for retrieving memory records.
" }, "SearchCriteriaSearchQueryString":{ "type":"string", "max":10000, "min":1, "sensitive":true }, "SearchCriteriaTopKInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "SearchRegistryRecordsRequest":{ "type":"structure", "required":[ "searchQuery", "registryIds" ], "members":{ "searchQuery":{ "shape":"SearchRegistryRecordsRequestSearchQueryString", "documentation":"The search query to find matching registry records.
" }, "registryIds":{ "shape":"SearchRegistryRecordsRequestRegistryIdsList", "documentation":"The list of registry identifiers to search within. Currently, you can specify exactly one registry identifier. You can provide either the full Amazon Web Services Resource Name (ARN) or the 12-character alphanumeric registry ID.
" }, "maxResults":{ "shape":"SearchRegistryRecordsRequestMaxResultsInteger", "documentation":"The maximum number of records to return in a single call. Valid values are 1 through 20. The default value is 10.
" }, "filters":{ "shape":"MetadataFilterExpression", "documentation":" A metadata filter expression to narrow search results. Uses structured JSON operators including field-level operators ($eq, $ne, $in) and logical operators ($and, $or) on filterable fields (name, descriptorType, version). For example, to filter by descriptor type: {\"descriptorType\": {\"$eq\": \"MCP\"}}. To combine filters: {\"$and\": [{\"descriptorType\": {\"$eq\": \"MCP\"}}, {\"name\": {\"$eq\": \"my-tool\"}}]}.
The list of registry records that match the search query, ordered by relevance.
" } } }, "SecretArn":{ "type":"string", "pattern":"arn:aws(-[a-z-]+)?:secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+" }, "SecretsManagerLocation":{ "type":"structure", "required":["secretArn"], "members":{ "secretArn":{ "shape":"SecretArn", "documentation":"The ARN of the Amazon Web Services Secrets Manager secret containing the certificate.
" } }, "documentation":"The Amazon Web Services Secrets Manager location configuration.
" }, "SensitiveJson":{ "type":"structure", "members":{}, "document":true, "sensitive":true }, "SensitiveText":{ "type":"string", "min":1, "sensitive":true }, "ServerDefinition":{ "type":"structure", "members":{ "schemaVersion":{ "shape":"SchemaVersion", "documentation":"The schema version of the MCP server configuration. The schema version identifies the format of the server definition content.
" }, "inlineContent":{ "shape":"InlineContent", "documentation":"The inline content of the server definition.
" } }, "documentation":" The MCP server definition with a schema version and inline content. The schemaVersion identifies the version of the MCP server configuration schema.
The service encountered an internal error. Try your request again later.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "ServiceName":{ "type":"string", "pattern":"[a-zA-Z0-9._-]+" }, "ServiceNameList":{ "type":"list", "member":{"shape":"ServiceName"}, "max":1, "min":1 }, "ServiceQuotaExceededException":{ "type":"structure", "members":{ "message":{"shape":"NonBlankString"} }, "documentation":"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.
", "error":{ "httpStatusCode":402, "senderFault":true }, "exception":true }, "SessionFilter":{ "type":"structure", "members":{ "eventFilter":{ "shape":"EventFilterCondition", "documentation":"The event filter condition to apply. Use this to filter sessions based on event presence.
" } }, "documentation":"Contains filter criteria for listing sessions.
" }, "SessionFilterConfig":{ "type":"structure", "members":{ "startTime":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The start time of the time range. Only sessions with activity at or after this timestamp are included.
" }, "endTime":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The end time of the time range. Only sessions with activity before this timestamp are included.
" } }, "documentation":"A time range filter for selecting sessions. Specifies the start and end times to narrow down which sessions are included.
" }, "SessionId":{ "type":"string", "max":100, "min":1, "pattern":"[a-zA-Z0-9][a-zA-Z0-9-_]*" }, "SessionMetadataList":{ "type":"list", "member":{"shape":"SessionMetadataShape"}, "max":500, "min":0 }, "SessionMetadataShape":{ "type":"structure", "required":["sessionId"], "members":{ "sessionId":{ "shape":"String", "documentation":"The unique identifier of the session this metadata applies to.
" }, "testScenarioId":{ "shape":"String", "documentation":"An optional test scenario identifier for categorizing and tracking evaluation results.
" }, "groundTruth":{ "shape":"GroundTruthSource", "documentation":"The ground truth data for this session, including expected responses and assertions.
" }, "metadata":{ "shape":"StringMap", "documentation":"Additional key-value metadata associated with this session.
" } }, "documentation":"Metadata for a specific session in a batch evaluation, including ground truth data and test scenario identifiers.
" }, "SessionStatus":{ "type":"string", "enum":[ "IN_PROGRESS", "FAILED" ] }, "SessionSummary":{ "type":"structure", "required":[ "sessionId", "actorId", "createdAt" ], "members":{ "sessionId":{ "shape":"SessionId", "documentation":"The unique identifier of the session.
" }, "actorId":{ "shape":"ActorId", "documentation":"The identifier of the actor associated with the session.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The timestamp when the session was created.
" } }, "documentation":"Contains summary information about a session in an AgentCore Memory resource.
" }, "SessionSummaryList":{ "type":"list", "member":{"shape":"SessionSummary"} }, "SessionType":{ "type":"string", "max":256, "min":33 }, "SkillDefinition":{ "type":"structure", "members":{ "schemaVersion":{ "shape":"SchemaVersion", "documentation":"The schema version of the skill definition. If you don't specify a version, the service detects it automatically.
" }, "inlineContent":{ "shape":"InlineContent", "documentation":"The inline content of the skill definition.
" } }, "documentation":"The structured skill definition with a schema version and inline content.
" }, "SkillMdDefinition":{ "type":"structure", "members":{ "inlineContent":{ "shape":"InlineContent", "documentation":"The inline markdown content of the skill definition.
" } }, "documentation":"The skill markdown definition for agent skills descriptors.
" }, "Span":{ "type":"structure", "members":{}, "document":true }, "SpanContext":{ "type":"structure", "required":["sessionId"], "members":{ "sessionId":{ "shape":"String", "documentation":" The unique identifier of the session containing this span. Sessions represent complete conversation flows and are detected using configurable SessionTimeoutMinutes (default 15 minutes).
The unique identifier of the trace containing this span. Traces represent individual request-response interactions within a session and group related spans together.
" }, "spanId":{ "shape":"String", "documentation":"The unique identifier of the specific span being referenced. Spans represent individual operations like tool calls, model invocations, or other discrete actions within the agent's execution.
" } }, "documentation":"The contextual information that uniquely identifies a span within the distributed tracing system. Contains session, trace, and span identifiers used to correlate evaluation results with specific agent execution points.
" }, "SpanId":{ "type":"string", "max":16, "min":16 }, "SpanIds":{ "type":"list", "member":{"shape":"SpanId"}, "max":10, "min":1 }, "Spans":{ "type":"list", "member":{"shape":"Span"}, "max":1000, "min":1, "sensitive":true }, "StartBatchEvaluationRequest":{ "type":"structure", "required":[ "batchEvaluationName", "dataSourceConfig" ], "members":{ "batchEvaluationName":{ "shape":"BatchEvaluationName", "documentation":"The name of the batch evaluation. Must be unique within your account.
" }, "evaluators":{ "shape":"StartBatchEvaluationRequestEvaluatorsList", "documentation":"The list of evaluators to apply during the batch evaluation. Can include both built-in evaluators and custom evaluators. Maximum of 10 evaluators.
" }, "dataSourceConfig":{ "shape":"DataSourceConfig", "documentation":"The data source configuration that specifies where to pull agent session traces from for evaluation.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.
", "idempotencyToken":true }, "evaluationMetadata":{ "shape":"EvaluationMetadata", "documentation":"Optional metadata for the evaluation, including session-specific ground truth data and test scenario identifiers.
" }, "description":{ "shape":"BatchEvaluationDescription", "documentation":"The description of the batch evaluation.
" } } }, "StartBatchEvaluationRequestEvaluatorsList":{ "type":"list", "member":{"shape":"Evaluator"}, "max":10, "min":0 }, "StartBatchEvaluationResponse":{ "type":"structure", "required":[ "batchEvaluationId", "batchEvaluationArn", "batchEvaluationName", "status", "createdAt" ], "members":{ "batchEvaluationId":{ "shape":"BatchEvaluationId", "documentation":"The unique identifier of the created batch evaluation.
" }, "batchEvaluationArn":{ "shape":"BatchEvaluationArn", "documentation":"The Amazon Resource Name (ARN) of the created batch evaluation.
" }, "batchEvaluationName":{ "shape":"BatchEvaluationName", "documentation":"The name of the batch evaluation.
" }, "evaluators":{ "shape":"EvaluatorList", "documentation":"The list of evaluators applied during the batch evaluation.
" }, "status":{ "shape":"BatchEvaluationStatus", "documentation":"The status of the batch evaluation.
" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The timestamp when the batch evaluation was created.
" }, "outputConfig":{ "shape":"OutputConfig", "documentation":"The output configuration specifying where evaluation results are written.
" }, "description":{ "shape":"BatchEvaluationDescription", "documentation":"The description of the batch evaluation.
" } } }, "StartBrowserSessionRequest":{ "type":"structure", "required":["browserIdentifier"], "members":{ "traceId":{ "shape":"StartBrowserSessionRequestTraceIdString", "documentation":"The trace identifier for request tracking.
", "location":"header", "locationName":"X-Amzn-Trace-Id" }, "traceParent":{ "shape":"StartBrowserSessionRequestTraceParentString", "documentation":"The parent trace information for distributed tracing.
", "location":"header", "locationName":"traceparent" }, "browserIdentifier":{ "shape":"String", "documentation":"The unique identifier of the browser to use for this session. This identifier specifies which browser environment to initialize for the session.
", "location":"uri", "locationName":"browserIdentifier" }, "name":{ "shape":"Name", "documentation":"The name of the browser session. This name helps you identify and manage the session. The name does not need to be unique.
" }, "sessionTimeoutSeconds":{ "shape":"BrowserSessionTimeout", "documentation":"The duration in seconds (time-to-live) after which the session automatically terminates, regardless of ongoing activity. Defaults to 3600 seconds (1 hour). Recommended minimum: 60 seconds. Maximum allowed: 28,800 seconds (8 hours).
" }, "viewPort":{ "shape":"ViewPort", "documentation":"The dimensions of the browser viewport for this session. This determines the visible area of the web content and affects how web pages are rendered. If not specified, Amazon Bedrock AgentCore uses a default viewport size.
" }, "extensions":{ "shape":"BrowserExtensions", "documentation":"A list of browser extensions to load into the browser session.
" }, "profileConfiguration":{ "shape":"BrowserProfileConfiguration", "documentation":"The browser profile configuration to use for this session. A browser profile contains persistent data such as cookies and local storage that can be reused across multiple browser sessions. If specified, the session initializes with the profile's stored data, enabling continuity for tasks that require authentication or personalized settings.
" }, "proxyConfiguration":{ "shape":"ProxyConfiguration", "documentation":"Optional proxy configuration for routing browser traffic through customer-specified proxy servers. When provided, enables HTTP Basic authentication via Amazon Web Services Secrets Manager and domain-based routing rules. Requires secretsmanager:GetSecretValue IAM permission for the specified secret ARNs.
A list of files containing enterprise policies for the browser.
" }, "certificates":{ "shape":"Certificates", "documentation":"A list of certificates to install in the browser session.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request, but does not return an error. This parameter helps prevent the creation of duplicate sessions if there are temporary network issues.
", "idempotencyToken":true } } }, "StartBrowserSessionRequestTraceIdString":{ "type":"string", "max":1024, "min":0 }, "StartBrowserSessionRequestTraceParentString":{ "type":"string", "max":1024, "min":0 }, "StartBrowserSessionResponse":{ "type":"structure", "required":[ "browserIdentifier", "sessionId", "createdAt" ], "members":{ "browserIdentifier":{ "shape":"String", "documentation":"The identifier of the browser.
" }, "sessionId":{ "shape":"BrowserSessionId", "documentation":"The unique identifier of the created browser session.
" }, "createdAt":{ "shape":"DateTimestamp", "documentation":"The timestamp when the browser session was created.
" }, "streams":{ "shape":"BrowserSessionStream", "documentation":"The streams associated with this browser session. These include the automation stream and live view stream.
" } } }, "StartCodeInterpreterSessionRequest":{ "type":"structure", "required":["codeInterpreterIdentifier"], "members":{ "traceId":{ "shape":"StartCodeInterpreterSessionRequestTraceIdString", "documentation":"The trace identifier for request tracking.
", "location":"header", "locationName":"X-Amzn-Trace-Id" }, "traceParent":{ "shape":"StartCodeInterpreterSessionRequestTraceParentString", "documentation":"The parent trace information for distributed tracing.
", "location":"header", "locationName":"traceparent" }, "codeInterpreterIdentifier":{ "shape":"String", "documentation":"The unique identifier of the code interpreter to use for this session. This identifier specifies which code interpreter environment to initialize for the session.
", "location":"uri", "locationName":"codeInterpreterIdentifier" }, "name":{ "shape":"Name", "documentation":"The name of the code interpreter session. This name helps you identify and manage the session. The name does not need to be unique.
" }, "sessionTimeoutSeconds":{ "shape":"CodeInterpreterSessionTimeout", "documentation":"The duration in seconds (time-to-live) after which the session automatically terminates, regardless of ongoing activity. Defaults to 900 seconds (15 minutes). Recommended minimum: 60 seconds. Maximum allowed: 28,800 seconds (8 hours).
" }, "certificates":{ "shape":"Certificates", "documentation":"A list of certificates to install in the code interpreter session.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request, but does not return an error. This parameter helps prevent the creation of duplicate sessions if there are temporary network issues.
", "idempotencyToken":true } } }, "StartCodeInterpreterSessionRequestTraceIdString":{ "type":"string", "max":1024, "min":0 }, "StartCodeInterpreterSessionRequestTraceParentString":{ "type":"string", "max":1024, "min":0 }, "StartCodeInterpreterSessionResponse":{ "type":"structure", "required":[ "codeInterpreterIdentifier", "sessionId", "createdAt" ], "members":{ "codeInterpreterIdentifier":{ "shape":"String", "documentation":"The identifier of the code interpreter.
" }, "sessionId":{ "shape":"CodeInterpreterSessionId", "documentation":"The unique identifier of the created code interpreter session.
" }, "createdAt":{ "shape":"DateTimestamp", "documentation":"The time at which the code interpreter session was created.
" } } }, "StartMemoryExtractionJobInput":{ "type":"structure", "required":[ "memoryId", "extractionJob" ], "members":{ "memoryId":{ "shape":"MemoryId", "documentation":"The unique identifier of the memory for which to start extraction jobs.
", "location":"uri", "locationName":"memoryId" }, "extractionJob":{ "shape":"ExtractionJob", "documentation":"Extraction job to start in this operation.
" }, "clientToken":{ "shape":"String", "documentation":"A unique, case-sensitive identifier to ensure idempotent processing of the request.
", "idempotencyToken":true } } }, "StartMemoryExtractionJobOutput":{ "type":"structure", "required":["jobId"], "members":{ "jobId":{ "shape":"String", "documentation":"Extraction Job ID that was attempted to start.
" } } }, "StartRecommendationRequest":{ "type":"structure", "required":[ "name", "type", "recommendationConfig" ], "members":{ "name":{ "shape":"RecommendationName", "documentation":"The name of the recommendation. Must be unique within your account.
" }, "description":{ "shape":"RecommendationDescription", "documentation":"The description of the recommendation.
" }, "type":{ "shape":"RecommendationType", "documentation":"The type of recommendation to generate. Valid values are SYSTEM_PROMPT_RECOMMENDATION for system prompt optimization or TOOL_DESCRIPTION_RECOMMENDATION for tool description optimization.
The configuration for the recommendation, including the input to optimize, agent traces to analyze, and evaluation settings.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.
", "idempotencyToken":true } } }, "StartRecommendationResponse":{ "type":"structure", "required":[ "recommendationId", "recommendationArn", "name", "type", "recommendationConfig", "status", "createdAt", "updatedAt" ], "members":{ "recommendationId":{ "shape":"RecommendationId", "documentation":"The unique identifier of the created recommendation.
" }, "recommendationArn":{ "shape":"RecommendationArn", "documentation":"The Amazon Resource Name (ARN) of the created recommendation.
" }, "name":{ "shape":"RecommendationName", "documentation":"The name of the recommendation.
" }, "description":{ "shape":"RecommendationDescription", "documentation":"The description of the recommendation.
" }, "type":{ "shape":"RecommendationType", "documentation":"The type of recommendation.
" }, "recommendationConfig":{ "shape":"RecommendationConfig", "documentation":"The configuration for the recommendation.
" }, "status":{ "shape":"RecommendationStatus", "documentation":"The status of the recommendation.
" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The timestamp when the recommendation was created.
" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The timestamp when the recommendation was last updated.
" } } }, "State":{ "type":"string", "max":4096, "min":1, "sensitive":true }, "StopBatchEvaluationRequest":{ "type":"structure", "required":["batchEvaluationId"], "members":{ "batchEvaluationId":{ "shape":"BatchEvaluationId", "documentation":"The unique identifier of the batch evaluation to stop.
", "location":"uri", "locationName":"batchEvaluationId" } } }, "StopBatchEvaluationResponse":{ "type":"structure", "required":[ "batchEvaluationId", "batchEvaluationArn", "status" ], "members":{ "batchEvaluationId":{ "shape":"BatchEvaluationId", "documentation":"The unique identifier of the stopped batch evaluation.
" }, "batchEvaluationArn":{ "shape":"BatchEvaluationArn", "documentation":"The Amazon Resource Name (ARN) of the stopped batch evaluation.
" }, "status":{ "shape":"BatchEvaluationStatus", "documentation":"The status of the batch evaluation after the stop request.
" }, "description":{ "shape":"BatchEvaluationDescription", "documentation":"The description of the batch evaluation.
" } } }, "StopBrowserSessionRequest":{ "type":"structure", "required":[ "browserIdentifier", "sessionId" ], "members":{ "traceId":{ "shape":"StopBrowserSessionRequestTraceIdString", "documentation":"The trace identifier for request tracking.
", "location":"header", "locationName":"X-Amzn-Trace-Id" }, "traceParent":{ "shape":"StopBrowserSessionRequestTraceParentString", "documentation":"The parent trace information for distributed tracing.
", "location":"header", "locationName":"traceparent" }, "browserIdentifier":{ "shape":"String", "documentation":"The unique identifier of the browser associated with the session.
", "location":"uri", "locationName":"browserIdentifier" }, "sessionId":{ "shape":"BrowserSessionId", "documentation":"The unique identifier of the browser session to stop.
", "location":"querystring", "locationName":"sessionId" }, "clientToken":{ "shape":"ClientToken", "documentation":"A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request, but does not return an error.
", "idempotencyToken":true } } }, "StopBrowserSessionRequestTraceIdString":{ "type":"string", "max":1024, "min":0 }, "StopBrowserSessionRequestTraceParentString":{ "type":"string", "max":1024, "min":0 }, "StopBrowserSessionResponse":{ "type":"structure", "required":[ "browserIdentifier", "sessionId", "lastUpdatedAt" ], "members":{ "browserIdentifier":{ "shape":"String", "documentation":"The identifier of the browser.
" }, "sessionId":{ "shape":"BrowserSessionId", "documentation":"The identifier of the browser session.
" }, "lastUpdatedAt":{ "shape":"DateTimestamp", "documentation":"The time at which the browser session was last updated.
" } } }, "StopCodeInterpreterSessionRequest":{ "type":"structure", "required":[ "codeInterpreterIdentifier", "sessionId" ], "members":{ "traceId":{ "shape":"StopCodeInterpreterSessionRequestTraceIdString", "documentation":"The trace identifier for request tracking.
", "location":"header", "locationName":"X-Amzn-Trace-Id" }, "traceParent":{ "shape":"StopCodeInterpreterSessionRequestTraceParentString", "documentation":"The parent trace information for distributed tracing.
", "location":"header", "locationName":"traceparent" }, "codeInterpreterIdentifier":{ "shape":"String", "documentation":"The unique identifier of the code interpreter associated with the session.
", "location":"uri", "locationName":"codeInterpreterIdentifier" }, "sessionId":{ "shape":"CodeInterpreterSessionId", "documentation":"The unique identifier of the code interpreter session to stop.
", "location":"querystring", "locationName":"sessionId" }, "clientToken":{ "shape":"ClientToken", "documentation":"A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request, but does not return an error.
", "idempotencyToken":true } } }, "StopCodeInterpreterSessionRequestTraceIdString":{ "type":"string", "max":1024, "min":0 }, "StopCodeInterpreterSessionRequestTraceParentString":{ "type":"string", "max":1024, "min":0 }, "StopCodeInterpreterSessionResponse":{ "type":"structure", "required":[ "codeInterpreterIdentifier", "sessionId", "lastUpdatedAt" ], "members":{ "codeInterpreterIdentifier":{ "shape":"String", "documentation":"The identifier of the code interpreter.
" }, "sessionId":{ "shape":"CodeInterpreterSessionId", "documentation":"The identifier of the code interpreter session.
" }, "lastUpdatedAt":{ "shape":"DateTimestamp", "documentation":"The timestamp when the code interpreter session was last updated.
" } } }, "StopRuntimeSessionRequest":{ "type":"structure", "required":[ "runtimeSessionId", "agentRuntimeArn" ], "members":{ "runtimeSessionId":{ "shape":"SessionType", "documentation":"The ID of the session that you want to stop.
", "location":"header", "locationName":"X-Amzn-Bedrock-AgentCore-Runtime-Session-Id" }, "agentRuntimeArn":{ "shape":"String", "documentation":"The ARN of the agent that contains the session that you want to stop.
", "location":"uri", "locationName":"agentRuntimeArn" }, "qualifier":{ "shape":"String", "documentation":"Optional qualifier to specify an agent alias, such as prodcode> or dev. If you don't provide a value, the DEFAULT alias is used.
Idempotent token used to identify the request. If you use the same token with multiple requests, the same response is returned. Use ClientToken to prevent the same request from being processed more than once.
", "idempotencyToken":true } } }, "StopRuntimeSessionResponse":{ "type":"structure", "members":{ "runtimeSessionId":{ "shape":"SessionId", "documentation":"The ID of the session that you requested to stop.
", "location":"header", "locationName":"X-Amzn-Bedrock-AgentCore-Runtime-Session-Id" }, "statusCode":{ "shape":"HttpResponseCode", "documentation":"The status code of the request to stop the session.
", "location":"statusCode" } } }, "StreamUpdate":{ "type":"structure", "members":{ "automationStreamUpdate":{ "shape":"AutomationStreamUpdate", "documentation":"The update to an automation stream.
" } }, "documentation":"Contains information about an update to a stream.
", "union":true }, "String":{"type":"string"}, "StringList":{ "type":"list", "member":{"shape":"MaxLenString"} }, "StringListMemberValue":{ "type":"string", "max":64, "min":1, "pattern":"[a-zA-Z0-9\\s._:/=+@-]*" }, "StringMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "StringType":{ "type":"string", "max":1024, "min":1 }, "StringValue":{ "type":"string", "max":256, "min":1, "pattern":"[a-zA-Z0-9\\s._:/=+@-]*" }, "StringValueList":{ "type":"list", "member":{"shape":"StringListMemberValue"}, "max":5, "min":1 }, "SyntheticTimestamp_date_time":{ "type":"timestamp", "timestampFormat":"iso8601" }, "SystemPromptConfig":{ "type":"structure", "members":{ "text":{ "shape":"SystemPromptText", "documentation":"The system prompt text provided inline.
" }, "configurationBundle":{ "shape":"SystemPromptConfigurationBundle", "documentation":"The system prompt sourced from a configuration bundle version.
" } }, "documentation":"The system prompt input, either as inline text or from a configuration bundle.
", "union":true }, "SystemPromptConfigurationBundle":{ "type":"structure", "required":[ "bundleArn", "versionId", "systemPromptJsonPath" ], "members":{ "bundleArn":{ "shape":"ConfigurationBundleArn", "documentation":"The Amazon Resource Name (ARN) of the configuration bundle.
" }, "versionId":{ "shape":"ConfigurationBundleVersionId", "documentation":"The version identifier of the configuration bundle.
" }, "systemPromptJsonPath":{ "shape":"String", "documentation":"The JSON path within the configuration bundle that contains the system prompt.
" } }, "documentation":"A system prompt sourced from a configuration bundle version.
" }, "SystemPromptRecommendationConfig":{ "type":"structure", "required":[ "systemPrompt", "agentTraces", "evaluationConfig" ], "members":{ "systemPrompt":{ "shape":"SystemPromptConfig", "documentation":"The current system prompt to optimize.
" }, "agentTraces":{ "shape":"AgentTracesConfig", "documentation":"The agent traces to analyze for generating recommendations.
" }, "evaluationConfig":{ "shape":"RecommendationEvaluationConfig", "documentation":"The evaluation configuration specifying which evaluator to use for assessing recommendation quality.
" } }, "documentation":"Configuration for generating system prompt optimization recommendations.
" }, "SystemPromptRecommendationResult":{ "type":"structure", "members":{ "recommendedSystemPrompt":{ "shape":"SystemPromptText", "documentation":"The optimized system prompt text generated by the recommendation.
" }, "configurationBundle":{ "shape":"RecommendationResultConfigurationBundle", "documentation":"The configuration bundle containing the recommended system prompt, if the input was sourced from a configuration bundle.
" }, "errorCode":{ "shape":"RecommendationErrorCode", "documentation":"The error code if the recommendation failed.
" }, "errorMessage":{ "shape":"RecommendationErrorMessage", "documentation":"The error message if the recommendation failed.
" } }, "documentation":"The result of a system prompt recommendation, containing the optimized prompt.
" }, "SystemPromptText":{ "type":"string", "max":20000, "min":1, "sensitive":true }, "TargetName":{ "type":"string", "max":100, "min":1 }, "TargetPathList":{ "type":"list", "member":{"shape":"PathPattern"}, "max":1, "min":1 }, "TargetRef":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"TargetName", "documentation":"The name of the gateway target.
" } }, "documentation":"A reference to a gateway target.
" }, "TaskStatus":{ "type":"string", "enum":[ "submitted", "working", "completed", "canceled", "failed" ] }, "Temperature":{ "type":"float", "box":true, "max":2.0, "min":0.0 }, "ThrottledException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"The request was denied due to request throttling. Reduce the frequency of requests and try again.
", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true }, "ThrottlingException":{ "type":"structure", "members":{ "message":{"shape":"NonBlankString"} }, "documentation":"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.
", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true }, "Timestamp":{"type":"timestamp"}, "TokenUsage":{ "type":"structure", "members":{ "inputTokens":{ "shape":"Integer", "documentation":"The number of tokens consumed for input processing during the evaluation. Includes tokens from the evaluation prompt, agent traces, and any additional context provided to the evaluator model.
" }, "outputTokens":{ "shape":"Integer", "documentation":"The number of tokens generated by the evaluator model in its response. Includes tokens for the score, explanation, and any additional output produced during the evaluation process.
" }, "totalTokens":{ "shape":"Integer", "documentation":"The total number of tokens consumed during the evaluation, calculated as the sum of input and output tokens. Used for cost calculation and rate limiting within the service limits.
" } }, "documentation":"The token consumption statistics for language model operations during evaluation. Provides detailed breakdown of input, output, and total tokens used for cost tracking and performance monitoring.
" }, "ToolArguments":{ "type":"structure", "members":{ "code":{ "shape":"MaxLenString", "documentation":"The code to execute in a code interpreter session. This is the source code in the specified programming language that will be executed by the code interpreter.
" }, "language":{ "shape":"ProgrammingLanguage", "documentation":"The programming language of the code to execute. This tells the code interpreter which language runtime to use for execution.
" }, "clearContext":{ "shape":"Boolean", "documentation":"Whether to clear the context for the tool.
" }, "command":{ "shape":"MaxLenString", "documentation":"The command to execute with the tool.
" }, "path":{ "shape":"MaxLenString", "documentation":"The path for the tool operation.
" }, "paths":{ "shape":"StringList", "documentation":"The paths for the tool operation.
" }, "content":{ "shape":"InputContentBlockList", "documentation":"The content for the tool operation.
" }, "directoryPath":{ "shape":"MaxLenString", "documentation":"The directory path for the tool operation.
" }, "taskId":{ "shape":"MaxLenString", "documentation":"The identifier of the task for the tool operation.
" }, "runtime":{ "shape":"LanguageRuntime", "documentation":"The runtime environment to use for code execution. If not specified, defaults to deno for JavaScript and TypeScript.
The collection of arguments that specify the operation to perform and its parameters when invoking a tool in Amazon Bedrock AgentCore. Different tools require different arguments, and this structure provides a flexible way to pass the appropriate arguments to each tool type.
" }, "ToolDescriptionConfig":{ "type":"structure", "members":{ "text":{ "shape":"ToolDescriptionText", "documentation":"The tool description as inline text.
" } }, "documentation":"The tool description content.
", "union":true }, "ToolDescriptionConfigurationBundle":{ "type":"structure", "required":[ "bundleArn", "versionId", "tools" ], "members":{ "bundleArn":{ "shape":"ConfigurationBundleArn", "documentation":"The Amazon Resource Name (ARN) of the configuration bundle.
" }, "versionId":{ "shape":"ConfigurationBundleVersionId", "documentation":"The version identifier of the configuration bundle.
" }, "tools":{ "shape":"ConfigurationBundleToolEntryList", "documentation":"The list of tool entries mapping tool names to their JSON paths within the bundle.
" } }, "documentation":"Tool descriptions sourced from a configuration bundle version.
" }, "ToolDescriptionInput":{ "type":"structure", "required":[ "toolName", "toolDescription" ], "members":{ "toolName":{ "shape":"RecommendationToolName", "documentation":"The name of the tool.
" }, "toolDescription":{ "shape":"ToolDescriptionConfig", "documentation":"The current description of the tool to optimize.
" } }, "documentation":"A tool description input containing the tool name and its current description.
" }, "ToolDescriptionList":{ "type":"list", "member":{"shape":"ToolDescriptionInput"} }, "ToolDescriptionOutput":{ "type":"structure", "required":["toolName"], "members":{ "toolName":{ "shape":"RecommendationToolName", "documentation":"The name of the tool.
" }, "recommendedToolDescription":{ "shape":"ToolDescriptionText", "documentation":"The optimized tool description text generated by the recommendation.
" } }, "documentation":"The output for a single tool description recommendation.
" }, "ToolDescriptionRecommendationConfig":{ "type":"structure", "required":[ "toolDescription", "agentTraces" ], "members":{ "toolDescription":{ "shape":"ToolDescriptionSource", "documentation":"The current tool descriptions to optimize.
" }, "agentTraces":{ "shape":"AgentTracesConfig", "documentation":"The agent traces to analyze for generating tool description recommendations.
" } }, "documentation":"Configuration for generating tool description optimization recommendations.
" }, "ToolDescriptionRecommendationResult":{ "type":"structure", "members":{ "tools":{ "shape":"ToolDescriptionResultList", "documentation":"The list of tools with their recommended descriptions.
" }, "configurationBundle":{ "shape":"RecommendationResultConfigurationBundle", "documentation":"The configuration bundle containing the recommended tool descriptions, if the input was sourced from a configuration bundle.
" }, "errorCode":{ "shape":"RecommendationErrorCode", "documentation":"The error code if the recommendation failed.
" }, "errorMessage":{ "shape":"RecommendationErrorMessage", "documentation":"The error message if the recommendation failed.
" } }, "documentation":"The result of a tool description recommendation, containing optimized descriptions.
" }, "ToolDescriptionResultList":{ "type":"list", "member":{"shape":"ToolDescriptionOutput"} }, "ToolDescriptionSource":{ "type":"structure", "members":{ "toolDescriptionText":{ "shape":"ToolDescriptionTextInput", "documentation":"Tool descriptions provided as inline text.
" }, "configurationBundle":{ "shape":"ToolDescriptionConfigurationBundle", "documentation":"Tool descriptions sourced from a configuration bundle version.
" } }, "documentation":"The source of tool descriptions, either inline text or from a configuration bundle.
", "union":true }, "ToolDescriptionText":{ "type":"string", "max":20000, "min":1, "sensitive":true }, "ToolDescriptionTextInput":{ "type":"structure", "required":["tools"], "members":{ "tools":{ "shape":"ToolDescriptionList", "documentation":"The list of tool descriptions to optimize.
" } }, "documentation":"Inline tool description input containing a list of tools.
" }, "ToolName":{ "type":"string", "enum":[ "executeCode", "executeCommand", "readFiles", "listFiles", "removeFiles", "writeFiles", "startCommandExecution", "getTask", "stopTask" ] }, "ToolResultStructuredContent":{ "type":"structure", "members":{ "taskId":{ "shape":"String", "documentation":"The identifier of the task that produced the result.
" }, "taskStatus":{ "shape":"TaskStatus", "documentation":"The status of the task that produced the result.
" }, "stdout":{ "shape":"String", "documentation":"The standard output from the tool execution.
" }, "stderr":{ "shape":"String", "documentation":"The standard error output from the tool execution.
" }, "exitCode":{ "shape":"Integer", "documentation":"The exit code from the tool execution.
" }, "executionTime":{ "shape":"Double", "documentation":"The execution time of the tool operation in milliseconds.
" } }, "documentation":"Contains structured content from a tool result.
" }, "ToolsDefinition":{ "type":"structure", "members":{ "protocolVersion":{ "shape":"SchemaVersion", "documentation":" The MCP protocol version that the tools conform to. This differs from the schemaVersion field in the server definition, which identifies the server configuration schema format.
The inline content of the tools definition.
" } }, "documentation":" The MCP tools definition with a protocol version and inline content. The protocolVersion identifies the MCP protocol version that the tools conform to. This differs from schemaVersion in the server definition, which identifies the server configuration schema format.
This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access
", "error":{ "httpStatusCode":401, "senderFault":true }, "exception":true }, "Unit":{ "type":"structure", "members":{} }, "UpdateABTestRequest":{ "type":"structure", "required":["abTestId"], "members":{ "abTestId":{ "shape":"ABTestId", "documentation":"The unique identifier of the A/B test to update.
", "location":"uri", "locationName":"abTestId" }, "clientToken":{ "shape":"ClientToken", "documentation":"A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.
", "idempotencyToken":true }, "name":{ "shape":"ABTestName", "documentation":"The updated name of the A/B test.
" }, "description":{ "shape":"ABTestDescription", "documentation":"The updated description of the A/B test.
" }, "variants":{ "shape":"VariantList", "documentation":"The updated list of variants.
" }, "gatewayFilter":{ "shape":"GatewayFilter", "documentation":"The updated gateway filter.
" }, "evaluationConfig":{ "shape":"ABTestEvaluationConfig", "documentation":"The updated evaluation configuration.
" }, "roleArn":{ "shape":"RoleArn", "documentation":"The updated IAM role ARN.
" }, "executionStatus":{ "shape":"ABTestExecutionStatus", "documentation":"The updated execution status to enable or disable the A/B test.
" } } }, "UpdateABTestResponse":{ "type":"structure", "required":[ "abTestId", "abTestArn", "status", "executionStatus", "updatedAt" ], "members":{ "abTestId":{ "shape":"ABTestId", "documentation":"The unique identifier of the updated A/B test.
" }, "abTestArn":{ "shape":"ABTestArn", "documentation":"The Amazon Resource Name (ARN) of the updated A/B test.
" }, "status":{ "shape":"ABTestStatus", "documentation":"The status of the A/B test.
" }, "executionStatus":{ "shape":"ABTestExecutionStatus", "documentation":"The execution status of the A/B test.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The timestamp when the A/B test was updated.
" } } }, "UpdateBrowserStreamRequest":{ "type":"structure", "required":[ "browserIdentifier", "sessionId", "streamUpdate" ], "members":{ "browserIdentifier":{ "shape":"String", "documentation":"The identifier of the browser.
", "location":"uri", "locationName":"browserIdentifier" }, "sessionId":{ "shape":"BrowserSessionId", "documentation":"The identifier of the browser session.
", "location":"querystring", "locationName":"sessionId" }, "streamUpdate":{ "shape":"StreamUpdate", "documentation":"The update to apply to the browser stream.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error.
", "idempotencyToken":true } } }, "UpdateBrowserStreamResponse":{ "type":"structure", "required":[ "browserIdentifier", "sessionId", "streams", "updatedAt" ], "members":{ "browserIdentifier":{ "shape":"String", "documentation":"The identifier of the browser.
" }, "sessionId":{ "shape":"BrowserSessionId", "documentation":"The identifier of the browser session.
" }, "streams":{"shape":"BrowserSessionStream"}, "updatedAt":{ "shape":"DateTimestamp", "documentation":"The time at which the browser stream was updated.
" } } }, "UserIdType":{ "type":"string", "max":128, "min":1 }, "UserIdentifier":{ "type":"structure", "members":{ "userToken":{ "shape":"UserTokenType", "documentation":"The OAuth2.0 token issued by the user’s identity provider that was used to generate the workload access token
" }, "userId":{ "shape":"UserIdType", "documentation":"The ID of the user for whom you have retrieved a workload access token for
" } }, "documentation":"The OAuth2.0 token or user ID that was used to generate the workload access token used for initiating the user authorization flow to retrieve OAuth2.0 tokens.
", "union":true }, "UserTokenType":{ "type":"string", "max":131072, "min":1, "pattern":"[A-Za-z0-9-_=]+.[A-Za-z0-9-_=]+.[A-Za-z0-9-_=]+", "sensitive":true }, "ValidationException":{ "type":"structure", "required":[ "message", "reason" ], "members":{ "message":{"shape":"String"}, "reason":{"shape":"ValidationExceptionReason"}, "fieldList":{"shape":"ValidationExceptionFieldList"} }, "documentation":"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.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "ValidationExceptionField":{ "type":"structure", "required":[ "name", "message" ], "members":{ "name":{ "shape":"String", "documentation":"The name of the field.
" }, "message":{ "shape":"String", "documentation":"A message describing why this field failed validation.
" } }, "documentation":"Stores information about a field passed inside a request that resulted in an exception.
" }, "ValidationExceptionFieldList":{ "type":"list", "member":{"shape":"ValidationExceptionField"} }, "ValidationExceptionReason":{ "type":"string", "enum":[ "CannotParse", "FieldValidationFailed", "IdempotentParameterMismatchException", "EventInOtherSession", "ResourceConflict" ] }, "Variant":{ "type":"structure", "required":[ "name", "weight", "variantConfiguration" ], "members":{ "name":{ "shape":"VariantName", "documentation":"The name of the variant. Must be C for control or T1 for treatment.
The percentage of traffic to route to this variant. Weights across all variants must sum to 100.
" }, "variantConfiguration":{ "shape":"VariantConfiguration", "documentation":"The configuration for this variant, including the configuration bundle or target reference.
" } }, "documentation":"A variant in an A/B test, representing either the control (C) or treatment (T1) configuration.
" }, "VariantConfiguration":{ "type":"structure", "members":{ "configurationBundle":{ "shape":"ConfigurationBundleRef", "documentation":"A reference to a configuration bundle version to use for this variant.
" }, "target":{ "shape":"TargetRef", "documentation":"A reference to a gateway target to route traffic to for this variant.
" } }, "documentation":"The configuration for an A/B test variant.
" }, "VariantList":{ "type":"list", "member":{"shape":"Variant"}, "max":2, "min":2 }, "VariantName":{ "type":"string", "max":2, "min":1, "pattern":"(C|T1)" }, "VariantResult":{ "type":"structure", "required":[ "variantName", "sampleSize", "mean", "isSignificant" ], "members":{ "variantName":{ "shape":"String", "documentation":"The name of the treatment variant.
" }, "sampleSize":{ "shape":"Integer", "documentation":"The number of sessions evaluated for this variant.
" }, "mean":{ "shape":"Double", "documentation":"The mean evaluation score for this variant.
" }, "absoluteChange":{ "shape":"Double", "documentation":"The absolute change in mean score compared to the control variant.
" }, "percentChange":{ "shape":"Double", "documentation":"The percentage change in mean score compared to the control variant.
" }, "pValue":{ "shape":"Double", "documentation":"The p-value indicating the statistical significance of the observed difference.
" }, "confidenceInterval":{ "shape":"ConfidenceInterval", "documentation":"The confidence interval for the observed difference.
" }, "isSignificant":{ "shape":"Boolean", "documentation":"Whether the observed difference is statistically significant.
" } }, "documentation":"Statistical results for a treatment variant compared against the control.
" }, "VariantResultList":{ "type":"list", "member":{"shape":"VariantResult"} }, "VariantWeightInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "ViewPort":{ "type":"structure", "required":[ "width", "height" ], "members":{ "width":{ "shape":"ViewPortWidth", "documentation":"The width of the viewport in pixels. This value determines the horizontal dimension of the visible area. Valid values range from 800 to 1920 pixels.
" }, "height":{ "shape":"ViewPortHeight", "documentation":"The height of the viewport in pixels. This value determines the vertical dimension of the visible area. Valid values range from 600 to 1080 pixels.
" } }, "documentation":"The configuration that defines the dimensions of a browser viewport in a browser session. The viewport determines the visible area of web content and affects how web pages are rendered and displayed. Proper viewport configuration ensures that web content is displayed correctly for the agent's browsing tasks.
" }, "ViewPortHeight":{ "type":"integer", "box":true, "max":2160, "min":240 }, "ViewPortWidth":{ "type":"integer", "box":true, "max":3840, "min":320 }, "WorkloadIdentityNameType":{ "type":"string", "max":255, "min":3, "pattern":"[A-Za-z0-9_.-]+" }, "WorkloadIdentityTokenType":{ "type":"string", "max":131072, "min":1, "sensitive":true } }, "documentation":"Welcome to the Amazon Bedrock AgentCore Data Plane API reference. Data Plane actions process and handle data or workloads within Amazon Web Services services.
" }