Welcome to the Amazon Bedrock AgentCore Data Plane API reference. Data Plane actions process and handle data or workloads within Amazon Web Services services.
", "operations": { "BatchCreateMemoryRecords": "Creates multiple memory records in a single batch operation for the specified memory with custom content.
", "BatchDeleteMemoryRecords": "Deletes multiple memory records in a single batch operation from the specified memory.
", "BatchUpdateMemoryRecords": "Updates multiple memory records with custom content in a single batch operation within the specified memory.
", "CompleteResourceTokenAuth": "Confirms the user authentication session for obtaining OAuth2.0 tokens for a resource.
", "CreateEvent": "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.
", "DeleteEvent": "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.
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.
", "GetAgentCard": "Retrieves the A2A agent card associated with an AgentCore Runtime agent.
", "GetBrowserSession": "Retrieves detailed information about a specific browser session in Amazon Bedrock. This operation returns the session's configuration, current status, associated streams, and metadata.
To get a browser session, you must specify both the browser identifier and the session ID. The response includes information about the session's viewport configuration, timeout settings, and stream endpoints.
The following operations are related to GetBrowserSession:
Retrieves detailed information about a specific code interpreter session in Amazon Bedrock. This operation returns the session's configuration, current status, and metadata.
To get a code interpreter session, you must specify both the code interpreter identifier and the session ID. The response includes information about the session's timeout settings and current status.
The following operations are related to GetCodeInterpreterSession:
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 the API key associated with an API key credential provider.
", "GetResourceOauth2Token": "Returns the OAuth 2.0 token of the provided resource.
", "GetWorkloadAccessToken": "Obtains a workload access token for agentic workloads not acting on behalf of a user.
", "GetWorkloadAccessTokenForJWT": "Obtains a workload access token for agentic workloads acting on behalf of a user, using a JWT token.
", "GetWorkloadAccessTokenForUserId": "Obtains a workload access token for agentic workloads acting on behalf of a user, using the user's ID.
", "InvokeAgentRuntime": "Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.
To invoke an agent you must specify the AgentCore Runtime ARN and provide a payload containing your request. You can optionally specify a qualifier to target a specific version or endpoint of the agent.
This operation supports streaming responses, allowing you to receive partial responses as they become available. We recommend using pagination to ensure that the operation returns quickly and successfully when processing large responses.
For example code, see Invoke an AgentCore Runtime agent.
If you're integrating your agent with OAuth, you can't use the Amazon Web Services SDK to call InvokeAgentRuntime. Instead, make a HTTPS request to InvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.
To use this operation, you must have the bedrock-agentcore:InvokeAgentRuntime permission. 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 code within an active code interpreter session in Amazon Bedrock. This operation processes the provided code, runs it in a secure environment, and returns the execution results including output, errors, and generated visualizations.
To execute code, you must specify the code interpreter identifier, session ID, and the code to run in the arguments parameter. The operation returns a stream containing the execution results, which can include text output, error messages, and data visualizations.
This operation is subject to request rate limiting based on your account's service quotas.
The following operations are related to InvokeCodeInterpreter:
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.
Retrieves a list of browser sessions in Amazon Bedrock that match the specified criteria. This operation returns summary information about each session, including identifiers, status, and timestamps.
You can filter the results by browser identifier and session status. The operation supports pagination to handle large result sets efficiently.
We recommend using pagination to ensure that the operation returns quickly and successfully when retrieving large numbers of sessions.
The following operations are related to ListBrowserSessions:
Retrieves a list of code interpreter sessions in Amazon Bedrock that match the specified criteria. This operation returns summary information about each session, including identifiers, status, and timestamps.
You can filter the results by code interpreter identifier and session status. The operation supports pagination to handle large result sets efficiently.
We recommend using pagination to ensure that the operation returns quickly and successfully when retrieving large numbers of sessions.
The following operations are related to ListCodeInterpreterSessions:
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 sessions in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.
To use this operation, you must have the bedrock-agentcore:ListSessions permission.
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.
Creates and initializes a browser session in Amazon Bedrock. The session enables agents to navigate and interact with web content, extract information from websites, and perform web-based tasks as part of their response generation.
To create a session, you must specify a browser identifier and a name. You can also configure the viewport dimensions to control the visible area of web content. The session remains active until it times out or you explicitly stop it using the StopBrowserSession operation.
The following operations are related to StartBrowserSession:
Creates and initializes a code interpreter session in Amazon Bedrock. The session enables agents to execute code as part of their response generation, supporting programming languages such as Python for data analysis, visualization, and computation tasks.
To create a session, you must specify a code interpreter identifier and a name. The session remains active until it times out or you explicitly stop it using the StopCodeInterpreterSession operation.
The following operations are related to StartCodeInterpreterSession:
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.
Terminates an active browser session in Amazon Bedrock. This operation stops the session, releases associated resources, and makes the session unavailable for further use.
To stop a browser session, you must specify both the browser identifier and the session ID. Once stopped, a session cannot be restarted; you must create a new session using StartBrowserSession.
The following operations are related to StopBrowserSession:
Terminates an active code interpreter session in Amazon Bedrock. This operation stops the session, releases associated resources, and makes the session unavailable for further use.
To stop a code interpreter session, you must specify both the code interpreter identifier and the session ID. Once stopped, a session cannot be restarted; you must create a new session using StartCodeInterpreterSession.
The following operations are related to StopCodeInterpreterSession:
Stops a session that is running in an running AgentCore Runtime agent.
", "UpdateBrowserStream": "Updates a browser stream. To use this operation, you must have permissions to perform the bedrock:UpdateBrowserStream action.
" }, "shapes": { "AccessDeniedException": { "base": "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.
", "refs": { "CodeInterpreterStreamOutput$accessDeniedException": null } }, "AccessTokenType": { "base": null, "refs": { "GetResourceOauth2TokenResponse$accessToken": "The OAuth 2.0 access token to use.
" } }, "ActorId": { "base": null, "refs": { "ActorSummary$actorId": "The unique identifier of the actor.
", "CreateEventInput$actorId": "The identifier of the actor associated with this event. An actor represents an entity that participates in sessions and generates events.
", "DeleteEventInput$actorId": "The identifier of the actor associated with the event to delete.
", "Event$actorId": "The identifier of the actor associated with the event.
", "GetEventInput$actorId": "The identifier of the actor associated with the event.
", "ListEventsInput$actorId": "The identifier of the actor for which to list events.
", "ListSessionsInput$actorId": "The identifier of the actor for which to list sessions.
", "SessionSummary$actorId": "The identifier of the actor associated with the session.
" } }, "ActorSummary": { "base": "Contains summary information about an actor in an AgentCore Memory resource.
", "refs": { "ActorSummaryList$member": null } }, "ActorSummaryList": { "base": null, "refs": { "ListActorsOutput$actorSummaries": "The list of actor summaries.
" } }, "AgentCard": { "base": null, "refs": { "GetAgentCardResponse$agentCard": "An agent card document that contains metadata and capabilities for an AgentCore Runtime agent.
" } }, "ApiKeyType": { "base": null, "refs": { "GetResourceApiKeyResponse$apiKey": "The API key associated with the resource requested.
" } }, "AuthorizationUrlType": { "base": null, "refs": { "GetResourceOauth2TokenResponse$authorizationUrl": "The URL to initiate the authorization process, provided when the access token requires user authorization.
" } }, "AutomationStream": { "base": "The configuration for a stream that enables programmatic control of a browser session in Amazon Bedrock. 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.
", "refs": { "BrowserSessionStream$automationStream": "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.
" } }, "AutomationStreamStatus": { "base": null, "refs": { "AutomationStream$streamStatus": "The current status of the automation stream. This indicates whether the stream is available for use. Possible values include ACTIVE, CONNECTING, and DISCONNECTED.
", "AutomationStreamUpdate$streamStatus": "The status of the automation stream.
" } }, "AutomationStreamUpdate": { "base": "Contains information about an update to an automation stream.
", "refs": { "StreamUpdate$automationStreamUpdate": "The update to an automation stream.
" } }, "BatchCreateMemoryRecordsInput": { "base": null, "refs": {} }, "BatchCreateMemoryRecordsOutput": { "base": null, "refs": {} }, "BatchDeleteMemoryRecordsInput": { "base": null, "refs": {} }, "BatchDeleteMemoryRecordsOutput": { "base": null, "refs": {} }, "BatchUpdateMemoryRecordsInput": { "base": null, "refs": {} }, "BatchUpdateMemoryRecordsOutput": { "base": null, "refs": {} }, "Blob": { "base": null, "refs": { "ContentBlock$data": "The binary data content of the block.
", "ResourceContent$blob": "The binary resource content.
" } }, "Body": { "base": null, "refs": { "InputContentBlock$blob": "The binary input content.
", "InvokeAgentRuntimeRequest$payload": "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.
" } }, "Boolean": { "base": null, "refs": { "BranchFilter$includeParentBranches": "Specifies whether to include parent branches in the results. Set to true to include parent branches, or false to exclude them.
", "CodeInterpreterResult$isError": "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.
", "GetResourceOauth2TokenRequest$forceAuthentication": "Indicates whether to always initiate a new three-legged OAuth (3LO) flow, regardless of any existing session.
", "ListEventsInput$includePayloads": "Specifies whether to include event payloads in the response. Set to true to include payloads, or false to exclude them.
", "ToolArguments$clearContext": "Whether to clear the context for the tool.
" } }, "Branch": { "base": "Contains information about a branch in an AgentCore Memory resource. Branches allow for organizing events into different conversation threads or paths.
", "refs": { "CreateEventInput$branch": "The branch information for this event. Branches allow for organizing events into different conversation threads or paths.
", "Event$branch": "The branch information for the event.
" } }, "BranchFilter": { "base": "Contains filter criteria for branches when listing events.
", "refs": { "FilterInput$branch": "The branch filter criteria to apply when listing events.
" } }, "BranchName": { "base": null, "refs": { "Branch$name": "The name of the branch.
", "BranchFilter$name": "The name of the branch to filter by.
" } }, "BrowserExtension": { "base": "Browser extension configuration.
", "refs": { "BrowserExtensions$member": null } }, "BrowserExtensions": { "base": null, "refs": { "GetBrowserSessionResponse$extensions": "The list of browser extensions that are configured in the browser session.
", "StartBrowserSessionRequest$extensions": "A list of browser extensions to load into the browser session.
" } }, "BrowserSessionId": { "base": null, "refs": { "BrowserSessionSummary$sessionId": "The unique identifier of the browser session. This identifier is used in operations that interact with the session.
", "GetBrowserSessionRequest$sessionId": "The unique identifier of the browser session to retrieve.
", "GetBrowserSessionResponse$sessionId": "The identifier of the browser session.
", "StartBrowserSessionResponse$sessionId": "The unique identifier of the created browser session.
", "StopBrowserSessionRequest$sessionId": "The unique identifier of the browser session to stop.
", "StopBrowserSessionResponse$sessionId": "The identifier of the browser session.
", "UpdateBrowserStreamRequest$sessionId": "The identifier of the browser session.
", "UpdateBrowserStreamResponse$sessionId": "The identifier of the browser session.
" } }, "BrowserSessionStatus": { "base": null, "refs": { "BrowserSessionSummary$status": "The current status of the browser session. Possible values include ACTIVE, STOPPING, and STOPPED.
", "GetBrowserSessionResponse$status": "The current status of the browser session. Possible values include ACTIVE, STOPPING, and STOPPED.
", "ListBrowserSessionsRequest$status": "The status of the browser sessions to list. Valid values include ACTIVE, STOPPING, and STOPPED. If not specified, sessions with any status are returned.
" } }, "BrowserSessionStream": { "base": "The collection of streams associated with a browser session in Amazon Bedrock. These streams provide different ways to interact with and observe the browser session, including programmatic control and visual representation of the browser content.
", "refs": { "GetBrowserSessionResponse$streams": "The streams associated with this browser session. These include the automation stream and live view stream.
", "StartBrowserSessionResponse$streams": "The streams associated with this browser session. These include the automation stream and live view stream.
", "UpdateBrowserStreamResponse$streams": null } }, "BrowserSessionSummaries": { "base": null, "refs": { "ListBrowserSessionsResponse$items": "The list of browser sessions that match the specified criteria.
" } }, "BrowserSessionSummary": { "base": "A condensed representation of a browser session in Amazon Bedrock. This structure contains key information about a browser session, including identifiers, status, and timestamps, without the full details of the session configuration and streams.
", "refs": { "BrowserSessionSummaries$member": null } }, "BrowserSessionTimeout": { "base": null, "refs": { "GetBrowserSessionResponse$sessionTimeoutSeconds": "The timeout period for the browser session in seconds.
", "StartBrowserSessionRequest$sessionTimeoutSeconds": "The time in seconds after which the session automatically terminates if there is no activity. The default value is 3600 seconds (1 hour). The minimum allowed value is 60 seconds, and the maximum allowed value is 28800 seconds (8 hours).
" } }, "BrowserStreamEndpoint": { "base": null, "refs": { "AutomationStream$streamEndpoint": "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.
", "LiveViewStream$streamEndpoint": "The endpoint URL for the live view stream. This URL is used to establish a connection to receive visual updates from the browser session.
" } }, "ClientToken": { "base": null, "refs": { "StartBrowserSessionRequest$clientToken": "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 ignores the request, but does not return an error. This parameter helps prevent the creation of duplicate sessions if there are temporary network issues.
", "StartCodeInterpreterSessionRequest$clientToken": "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 ignores the request, but does not return an error. This parameter helps prevent the creation of duplicate sessions if there are temporary network issues.
", "StopBrowserSessionRequest$clientToken": "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 ignores the request, but does not return an error.
", "StopCodeInterpreterSessionRequest$clientToken": "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 ignores the request, but does not return an error.
", "StopRuntimeSessionRequest$clientToken": "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.
", "UpdateBrowserStreamRequest$clientToken": "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.
" } }, "CodeInterpreterResult": { "base": "The output produced by executing code in a code interpreter session in Amazon Bedrock. 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.
", "refs": { "CodeInterpreterStreamOutput$result": null } }, "CodeInterpreterSessionId": { "base": null, "refs": { "CodeInterpreterSessionSummary$sessionId": "The unique identifier of the code interpreter session. This identifier is used in operations that interact with the session.
", "GetCodeInterpreterSessionRequest$sessionId": "The unique identifier of the code interpreter session to retrieve.
", "GetCodeInterpreterSessionResponse$sessionId": "The identifier of the code interpreter session.
", "InvokeCodeInterpreterRequest$sessionId": "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 identifier of the code interpreter session.
", "StartCodeInterpreterSessionResponse$sessionId": "The unique identifier of the created code interpreter session.
", "StopCodeInterpreterSessionRequest$sessionId": "The unique identifier of the code interpreter session to stop.
", "StopCodeInterpreterSessionResponse$sessionId": "The identifier of the code interpreter session.
" } }, "CodeInterpreterSessionStatus": { "base": null, "refs": { "CodeInterpreterSessionSummary$status": "The current status of the code interpreter session. Possible values include ACTIVE, STOPPING, and STOPPED.
", "GetCodeInterpreterSessionResponse$status": "The current status of the code interpreter session. Possible values include ACTIVE, STOPPING, and STOPPED.
", "ListCodeInterpreterSessionsRequest$status": "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.
" } }, "CodeInterpreterSessionSummaries": { "base": null, "refs": { "ListCodeInterpreterSessionsResponse$items": "The list of code interpreter sessions that match the specified criteria.
" } }, "CodeInterpreterSessionSummary": { "base": "A condensed representation of a code interpreter session in Amazon Bedrock. This structure contains key information about a code interpreter session, including identifiers, status, and timestamps, without the full details of the session configuration.
", "refs": { "CodeInterpreterSessionSummaries$member": null } }, "CodeInterpreterSessionTimeout": { "base": null, "refs": { "GetCodeInterpreterSessionResponse$sessionTimeoutSeconds": "The timeout period for the code interpreter session in seconds.
", "StartCodeInterpreterSessionRequest$sessionTimeoutSeconds": "The time in seconds after which the session automatically terminates if there is no activity. The default value is 900 seconds (15 minutes). The minimum allowed value is 60 seconds, and the maximum allowed value is 28800 seconds (8 hours).
" } }, "CodeInterpreterStreamOutput": { "base": "Contains output from a code interpreter stream.
", "refs": { "InvokeCodeInterpreterResponse$stream": "The stream containing the results of the code execution. This includes output, errors, and execution status.
" } }, "CompleteResourceTokenAuthRequest": { "base": null, "refs": {} }, "CompleteResourceTokenAuthResponse": { "base": null, "refs": {} }, "ConflictException": { "base": "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.
", "refs": { "CodeInterpreterStreamOutput$conflictException": null } }, "Content": { "base": "Contains the content of a memory item.
", "refs": { "Conversational$content": "The content of the conversation message.
" } }, "ContentBlock": { "base": "A block of content in a response.
", "refs": { "ContentBlockList$member": null } }, "ContentBlockList": { "base": null, "refs": { "CodeInterpreterResult$content": "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.
" } }, "ContentBlockType": { "base": null, "refs": { "ContentBlock$type": "The type of content in the block.
" } }, "ContentTextString": { "base": null, "refs": { "Content$text": "The text content of the memory item.
" } }, "Context": { "base": "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.
", "refs": { "EvaluationResultContent$context": "The contextual information associated with this evaluation result, including span context details that identify the specific traces and sessions that were evaluated.
" } }, "Conversational": { "base": "Contains conversational content for an event payload.
", "refs": { "PayloadType$conversational": "The conversational content of the payload.
" } }, "CreateEventInput": { "base": null, "refs": {} }, "CreateEventOutput": { "base": null, "refs": {} }, "CredentialProviderName": { "base": null, "refs": { "GetResourceApiKeyRequest$resourceCredentialProviderName": "The credential provider name for the resource from which you are retrieving the API key.
", "GetResourceOauth2TokenRequest$resourceCredentialProviderName": "The name of the resource's credential provider.
" } }, "CustomRequestKeyType": { "base": null, "refs": { "CustomRequestParametersType$key": null } }, "CustomRequestParametersType": { "base": null, "refs": { "GetResourceOauth2TokenRequest$customParameters": "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.
" } }, "CustomRequestValueType": { "base": null, "refs": { "CustomRequestParametersType$value": null } }, "DateTimestamp": { "base": null, "refs": { "BrowserSessionSummary$createdAt": "The timestamp when the browser session was created. This value is in ISO 8601 format.
", "BrowserSessionSummary$lastUpdatedAt": "The timestamp when the browser session was last updated. This value is in ISO 8601 format.
", "CodeInterpreterSessionSummary$createdAt": "The timestamp when the code interpreter session was created. This value is in ISO 8601 format.
", "CodeInterpreterSessionSummary$lastUpdatedAt": "The timestamp when the code interpreter session was last updated. This value is in ISO 8601 format.
", "GetBrowserSessionResponse$createdAt": "The time at which the browser session was created.
", "GetBrowserSessionResponse$lastUpdatedAt": "The time at which the browser session was last updated.
", "GetCodeInterpreterSessionResponse$createdAt": "The time at which the code interpreter session was created.
", "StartBrowserSessionResponse$createdAt": "The timestamp when the browser session was created.
", "StartCodeInterpreterSessionResponse$createdAt": "The time at which the code interpreter session was created.
", "StopBrowserSessionResponse$lastUpdatedAt": "The time at which the browser session was last updated.
", "StopCodeInterpreterSessionResponse$lastUpdatedAt": "The timestamp when the code interpreter session was last updated.
", "UpdateBrowserStreamResponse$updatedAt": "The time at which the browser stream was updated.
" } }, "DeleteEventInput": { "base": null, "refs": {} }, "DeleteEventOutput": { "base": null, "refs": {} }, "DeleteMemoryRecordInput": { "base": null, "refs": {} }, "DeleteMemoryRecordOutput": { "base": null, "refs": {} }, "Document": { "base": null, "refs": { "PayloadType$blob": "The binary content of the payload.
" } }, "Double": { "base": null, "refs": { "EvaluationResultContent$value": "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.
", "MemoryRecordSummary$score": "The relevance score of the memory record when returned as part of a search result. Higher values indicate greater relevance to the search query.
", "ToolResultStructuredContent$executionTime": "The execution time of the tool operation in milliseconds.
" } }, "DuplicateIdException": { "base": "An exception thrown when attempting to create a resource with an identifier that already exists.
", "refs": {} }, "EvaluateRequest": { "base": null, "refs": {} }, "EvaluateResponse": { "base": null, "refs": {} }, "EvaluationErrorCode": { "base": null, "refs": { "EvaluationResultContent$errorCode": "The error code indicating the type of failure that occurred during evaluation. Used to programmatically identify and handle different categories of evaluation errors.
" } }, "EvaluationErrorMessage": { "base": null, "refs": { "EvaluationResultContent$errorMessage": "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.
" } }, "EvaluationExplanation": { "base": null, "refs": { "EvaluationResultContent$explanation": "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.
" } }, "EvaluationInput": { "base": "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.
", "refs": { "EvaluateRequest$evaluationInput": "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.
" } }, "EvaluationResultContent": { "base": "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.
", "refs": { "EvaluationResults$member": null } }, "EvaluationResults": { "base": null, "refs": { "EvaluateResponse$evaluationResults": "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.
" } }, "EvaluationTarget": { "base": "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.
", "refs": { "EvaluateRequest$evaluationTarget": "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.
" } }, "EvaluatorArn": { "base": null, "refs": { "EvaluationResultContent$evaluatorArn": " 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 to use for scoring. Can be a built-in evaluator (e.g., Builtin.Helpfulness, Builtin.Correctness) or a custom evaluator ARN created through the control plane API.
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.
" } }, "Event": { "base": "Contains information about an event in an AgentCore Memory resource.
", "refs": { "CreateEventOutput$event": "The event that was created.
", "EventList$member": null, "GetEventOutput$event": "The requested event information.
" } }, "EventId": { "base": null, "refs": { "Branch$rootEventId": "The identifier of the root event for this branch.
", "DeleteEventInput$eventId": "The identifier of the event to delete.
", "DeleteEventOutput$eventId": "The identifier of the event that was deleted.
", "Event$eventId": "The unique identifier of the event.
", "GetEventInput$eventId": "The identifier of the event to retrieve.
" } }, "EventList": { "base": null, "refs": { "ListEventsOutput$events": "The list of events that match the specified criteria.
" } }, "EventMetadataFilterExpression": { "base": "Filter expression for retrieving events based on metadata associated with an event.
", "refs": { "EventMetadataFilterList$member": null } }, "EventMetadataFilterList": { "base": null, "refs": { "FilterInput$eventMetadata": "Event metadata filter criteria to apply when retrieving events.
" } }, "ExtractionJob": { "base": "Represents the metadata of a memory extraction job such as the message identifiers that compose this job.
", "refs": { "StartMemoryExtractionJobInput$extractionJob": "Extraction job to start in this operation.
" } }, "ExtractionJobFilterInput": { "base": "Filters for querying memory extraction jobs based on various criteria.
", "refs": { "ListMemoryExtractionJobsInput$filter": "Filter criteria to apply when listing extraction jobs.
" } }, "ExtractionJobMessages": { "base": "The list of messages that compose this extraction job.
", "refs": { "ExtractionJobMetadata$messages": "The messages associated with the extraction job.
" } }, "ExtractionJobMetadata": { "base": "Metadata information associated with this extraction job.
", "refs": { "ExtractionJobMetadataList$member": null } }, "ExtractionJobMetadataList": { "base": null, "refs": { "ListMemoryExtractionJobsOutput$jobs": "List of extraction job metadata matching the specified criteria.
" } }, "ExtractionJobStatus": { "base": null, "refs": { "ExtractionJobFilterInput$status": "The status of the extraction job. If specified, only extraction jobs with this status are returned.
", "ExtractionJobMetadata$status": "The current status of the extraction job.
" } }, "FilterInput": { "base": "Contains filter criteria for listing events.
", "refs": { "ListEventsInput$filter": "Filter criteria to apply when listing events.
" } }, "GetAgentCardRequest": { "base": null, "refs": {} }, "GetAgentCardResponse": { "base": null, "refs": {} }, "GetBrowserSessionRequest": { "base": null, "refs": {} }, "GetBrowserSessionResponse": { "base": null, "refs": {} }, "GetCodeInterpreterSessionRequest": { "base": null, "refs": {} }, "GetCodeInterpreterSessionResponse": { "base": null, "refs": {} }, "GetEventInput": { "base": null, "refs": {} }, "GetEventOutput": { "base": null, "refs": {} }, "GetMemoryRecordInput": { "base": null, "refs": {} }, "GetMemoryRecordOutput": { "base": null, "refs": {} }, "GetResourceApiKeyRequest": { "base": null, "refs": {} }, "GetResourceApiKeyResponse": { "base": null, "refs": {} }, "GetResourceOauth2TokenRequest": { "base": null, "refs": {} }, "GetResourceOauth2TokenResponse": { "base": null, "refs": {} }, "GetWorkloadAccessTokenForJWTRequest": { "base": null, "refs": {} }, "GetWorkloadAccessTokenForJWTResponse": { "base": null, "refs": {} }, "GetWorkloadAccessTokenForUserIdRequest": { "base": null, "refs": {} }, "GetWorkloadAccessTokenForUserIdResponse": { "base": null, "refs": {} }, "GetWorkloadAccessTokenRequest": { "base": null, "refs": {} }, "GetWorkloadAccessTokenResponse": { "base": null, "refs": {} }, "HttpResponseCode": { "base": null, "refs": { "GetAgentCardResponse$statusCode": "The status code of the request.
", "InvokeAgentRuntimeResponse$statusCode": "The HTTP status code of the response. A status code of 200 indicates a successful operation. Other status codes indicate various error conditions.
", "StopRuntimeSessionResponse$statusCode": "The status code of the request to stop the session.
" } }, "InputContentBlock": { "base": "A block of input content.
", "refs": { "InputContentBlockList$member": null } }, "InputContentBlockList": { "base": null, "refs": { "ToolArguments$content": "The content for the tool operation.
" } }, "Integer": { "base": null, "refs": { "MemoryRecordOutput$errorCode": "The error code returned when the memory record operation fails.
", "MessageMetadata$messageIndex": "The position of this message within that event’s ordered list of messages.
", "TokenUsage$inputTokens": "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.
", "TokenUsage$outputTokens": "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.
", "TokenUsage$totalTokens": "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.
", "ToolResultStructuredContent$exitCode": "The exit code from the tool execution.
" } }, "InternalServerException": { "base": "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.
", "refs": { "CodeInterpreterStreamOutput$internalServerException": null } }, "InvalidInputException": { "base": "The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.
", "refs": {} }, "InvokeAgentRuntimeRequest": { "base": null, "refs": {} }, "InvokeAgentRuntimeRequestAccountIdString": { "base": null, "refs": { "InvokeAgentRuntimeRequest$accountId": "The identifier of the Amazon Web Services account for the agent runtime resource.
" } }, "InvokeAgentRuntimeRequestBaggageString": { "base": null, "refs": { "InvokeAgentRuntimeRequest$baggage": "Additional context information for distributed tracing.
" } }, "InvokeAgentRuntimeRequestTraceIdString": { "base": null, "refs": { "InvokeAgentRuntimeRequest$traceId": "The trace identifier for request tracking.
" } }, "InvokeAgentRuntimeRequestTraceParentString": { "base": null, "refs": { "InvokeAgentRuntimeRequest$traceParent": "The parent trace information for distributed tracing.
" } }, "InvokeAgentRuntimeRequestTraceStateString": { "base": null, "refs": { "InvokeAgentRuntimeRequest$traceState": "The trace state information for distributed tracing.
" } }, "InvokeAgentRuntimeResponse": { "base": null, "refs": {} }, "InvokeCodeInterpreterRequest": { "base": null, "refs": {} }, "InvokeCodeInterpreterRequestTraceIdString": { "base": null, "refs": { "InvokeCodeInterpreterRequest$traceId": "The trace identifier for request tracking.
" } }, "InvokeCodeInterpreterRequestTraceParentString": { "base": null, "refs": { "InvokeCodeInterpreterRequest$traceParent": "The parent trace information for distributed tracing.
" } }, "InvokeCodeInterpreterResponse": { "base": null, "refs": {} }, "LeftExpression": { "base": "Left expression of the event metadata filter.
", "refs": { "EventMetadataFilterExpression$left": "Left operand of the event metadata filter expression.
", "MemoryMetadataFilterExpression$left": null } }, "ListActorsInput": { "base": null, "refs": {} }, "ListActorsOutput": { "base": null, "refs": {} }, "ListBrowserSessionsRequest": { "base": null, "refs": {} }, "ListBrowserSessionsResponse": { "base": null, "refs": {} }, "ListCodeInterpreterSessionsRequest": { "base": null, "refs": {} }, "ListCodeInterpreterSessionsResponse": { "base": null, "refs": {} }, "ListEventsInput": { "base": null, "refs": {} }, "ListEventsOutput": { "base": null, "refs": {} }, "ListMemoryExtractionJobsInput": { "base": null, "refs": {} }, "ListMemoryExtractionJobsInputMaxResultsInteger": { "base": null, "refs": { "ListMemoryExtractionJobsInput$maxResults": "The maximum number of results to return in a single call. The default value is 20.
" } }, "ListMemoryExtractionJobsOutput": { "base": null, "refs": {} }, "ListMemoryRecordsInput": { "base": null, "refs": {} }, "ListMemoryRecordsOutput": { "base": null, "refs": {} }, "ListSessionsInput": { "base": null, "refs": {} }, "ListSessionsOutput": { "base": null, "refs": {} }, "LiveViewStream": { "base": "The configuration for a stream that provides a visual representation of a browser session in Amazon Bedrock. This stream enables agents to observe the current state of the browser, including rendered web pages, visual elements, and the results of interactions.
", "refs": { "BrowserSessionStream$liveViewStream": "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.
" } }, "Long": { "base": null, "refs": { "ContentBlock$size": "The size of the content in bytes.
" } }, "MaxLenString": { "base": null, "refs": { "InputContentBlock$path": "The path to the input content.
", "InputContentBlock$text": "The text input content.
", "StringList$member": null, "ToolArguments$code": "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.
", "ToolArguments$command": "The command to execute with the tool.
", "ToolArguments$path": "The path for the tool operation.
", "ToolArguments$directoryPath": "The directory path for the tool operation.
", "ToolArguments$taskId": "The identifier of the task for the tool operation.
" } }, "MaxResults": { "base": null, "refs": { "ListActorsInput$maxResults": "The maximum number of results to return in a single call. The default value is 20.
", "ListBrowserSessionsRequest$maxResults": "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 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 maximum number of results to return in a single call. The default value is 20.
", "ListMemoryRecordsInput$maxResults": "The maximum number of results to return in a single call. The default value is 20.
", "ListSessionsInput$maxResults": "The maximum number of results to return in a single call. The default value is 20.
", "RetrieveMemoryRecordsInput$maxResults": "The maximum number of results to return in a single call. The default value is 20.
" } }, "MemoryContent": { "base": "Contains the content of a memory record.
", "refs": { "MemoryRecord$content": "The content of the memory record.
", "MemoryRecordCreateInput$content": "The content to be stored within the memory record.
", "MemoryRecordSummary$content": "The content of the memory record.
", "MemoryRecordUpdateInput$content": "The content to be stored within the memory record.
" } }, "MemoryContentTextString": { "base": null, "refs": { "MemoryContent$text": "The text content of the memory record.
" } }, "MemoryId": { "base": null, "refs": { "BatchCreateMemoryRecordsInput$memoryId": "The unique ID of the memory resource where records will be created.
", "BatchDeleteMemoryRecordsInput$memoryId": "The unique ID of the memory resource where records will be deleted.
", "BatchUpdateMemoryRecordsInput$memoryId": "The unique ID of the memory resource where records will be updated.
", "CreateEventInput$memoryId": "The identifier of the AgentCore Memory resource in which to create the event.
", "DeleteEventInput$memoryId": "The identifier of the AgentCore Memory resource from which to delete the event.
", "DeleteMemoryRecordInput$memoryId": "The identifier of the AgentCore Memory resource from which to delete the memory record.
", "Event$memoryId": "The identifier of the AgentCore Memory resource containing the event.
", "GetEventInput$memoryId": "The identifier of the AgentCore Memory resource containing the event.
", "GetMemoryRecordInput$memoryId": "The identifier of the AgentCore Memory resource containing the memory record.
", "ListActorsInput$memoryId": "The identifier of the AgentCore Memory resource for which to list actors.
", "ListEventsInput$memoryId": "The identifier of the AgentCore Memory resource for which to list events.
", "ListMemoryExtractionJobsInput$memoryId": "The unique identifier of the memory to list extraction jobs for.
", "ListMemoryRecordsInput$memoryId": "The identifier of the AgentCore Memory resource for which to list memory records.
", "ListSessionsInput$memoryId": "The identifier of the AgentCore Memory resource for which to list sessions.
", "RetrieveMemoryRecordsInput$memoryId": "The identifier of the AgentCore Memory resource from which to retrieve memory records.
", "StartMemoryExtractionJobInput$memoryId": "The unique identifier of the memory for which to start extraction jobs.
" } }, "MemoryMetadataFilterExpression": { "base": "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.
Filters to apply to metadata associated with a memory.
" } }, "MemoryRecord": { "base": "Contains information about a memory record in an AgentCore Memory resource.
", "refs": { "GetMemoryRecordOutput$memoryRecord": "The requested memory record.
" } }, "MemoryRecordCreateInput": { "base": "Input structure to create a new memory record.
", "refs": { "MemoryRecordsCreateInputList$member": null } }, "MemoryRecordDeleteInput": { "base": "Input structure to delete an existing memory record.
", "refs": { "MemoryRecordsDeleteInputList$member": null } }, "MemoryRecordId": { "base": null, "refs": { "DeleteMemoryRecordInput$memoryRecordId": "The identifier of the memory record to delete.
", "DeleteMemoryRecordOutput$memoryRecordId": "The identifier of the memory record that was deleted.
", "GetMemoryRecordInput$memoryRecordId": "The identifier of the memory record to retrieve.
", "MemoryRecord$memoryRecordId": "The unique identifier of the memory record.
", "MemoryRecordDeleteInput$memoryRecordId": "The unique ID of the memory record to be deleted.
", "MemoryRecordOutput$memoryRecordId": "The unique ID associated to the memory record.
", "MemoryRecordSummary$memoryRecordId": "The unique identifier of the memory record.
", "MemoryRecordUpdateInput$memoryRecordId": "The unique ID of the memory record to be updated.
" } }, "MemoryRecordOutput": { "base": "Output information returned after processing a memory record operation.
", "refs": { "MemoryRecordsOutputList$member": null } }, "MemoryRecordStatus": { "base": null, "refs": { "MemoryRecordOutput$status": "The status of the memory record operation (e.g., SUCCEEDED, FAILED).
" } }, "MemoryRecordSummary": { "base": "Contains summary information about a memory record.
", "refs": { "MemoryRecordSummaryList$member": null } }, "MemoryRecordSummaryList": { "base": null, "refs": { "ListMemoryRecordsOutput$memoryRecordSummaries": "The list of memory record summaries that match the specified criteria.
", "RetrieveMemoryRecordsOutput$memoryRecordSummaries": "The list of memory record summaries that match the search criteria, ordered by relevance.
" } }, "MemoryRecordUpdateInput": { "base": "Input structure to update an existing memory record.
", "refs": { "MemoryRecordsUpdateInputList$member": null } }, "MemoryRecordsCreateInputList": { "base": null, "refs": { "BatchCreateMemoryRecordsInput$records": "A list of memory record creation inputs to be processed in the batch operation.
" } }, "MemoryRecordsDeleteInputList": { "base": null, "refs": { "BatchDeleteMemoryRecordsInput$records": "A list of memory record deletion inputs to be processed in the batch operation.
" } }, "MemoryRecordsOutputList": { "base": null, "refs": { "BatchCreateMemoryRecordsOutput$successfulRecords": "A list of memory records that were successfully created during the batch operation.
", "BatchCreateMemoryRecordsOutput$failedRecords": "A list of memory records that failed to be created, including error details for each failure.
", "BatchDeleteMemoryRecordsOutput$successfulRecords": "A list of memory records that were successfully deleted during the batch operation.
", "BatchDeleteMemoryRecordsOutput$failedRecords": "A list of memory records that failed to be deleted, including error details for each failure.
", "BatchUpdateMemoryRecordsOutput$successfulRecords": "A list of memory records that were successfully updated during the batch operation.
", "BatchUpdateMemoryRecordsOutput$failedRecords": "A list of memory records that failed to be updated, including error details for each failure.
" } }, "MemoryRecordsUpdateInputList": { "base": null, "refs": { "BatchUpdateMemoryRecordsInput$records": "A list of memory record update inputs to be processed in the batch operation.
" } }, "MemoryStrategyId": { "base": null, "refs": { "ListMemoryRecordsInput$memoryStrategyId": "The memory strategy identifier to filter memory records by. If specified, only memory records with this strategy ID are returned.
", "MemoryRecord$memoryStrategyId": "The identifier of the memory strategy associated with this record.
", "MemoryRecordCreateInput$memoryStrategyId": "The ID of the memory strategy that defines how this memory record is grouped.
", "MemoryRecordSummary$memoryStrategyId": "The identifier of the memory strategy associated with this record.
", "MemoryRecordUpdateInput$memoryStrategyId": "The updated ID of the memory strategy that defines how this memory record is grouped.
", "SearchCriteria$memoryStrategyId": "The memory strategy identifier to filter memory records by.
" } }, "MessageMetadata": { "base": "Metadata information associated with this message.
", "refs": { "MessagesList$member": null } }, "MessagesList": { "base": null, "refs": { "ExtractionJobMessages$messagesList": "The list of messages that compose this extraction job.
" } }, "MetadataKey": { "base": null, "refs": { "LeftExpression$metadataKey": "Key associated with the metadata in an event.
", "MetadataMap$key": null } }, "MetadataMap": { "base": null, "refs": { "CreateEventInput$metadata": "The key-value metadata to attach to the event.
", "Event$metadata": "Metadata associated with an event.
", "MemoryRecord$metadata": "A map of metadata key-value pairs associated with a memory record.
", "MemoryRecordSummary$metadata": "A map of metadata key-value pairs associated with a memory record.
" } }, "MetadataValue": { "base": "Value associated with the eventMetadata key.
Value associated with the key in eventMetadata.
Value associated with the eventMetadata key.
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.
", "InvokeAgentRuntimeRequest$accept": "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.
" } }, "Name": { "base": null, "refs": { "BrowserSessionSummary$name": "The name of the browser session. This name helps identify and manage the session.
", "CodeInterpreterSessionSummary$name": "The name of the code interpreter session. This name helps identify and manage the session.
", "GetBrowserSessionResponse$name": "The name of the browser session.
", "GetCodeInterpreterSessionResponse$name": "The name of the code interpreter session.
", "StartBrowserSessionRequest$name": "The name of the browser session. This name helps you identify and manage the session. The name does not need to be unique.
", "StartCodeInterpreterSessionRequest$name": "The name of the code interpreter session. This name helps you identify and manage the session. The name does not need to be unique.
" } }, "Namespace": { "base": null, "refs": { "ListMemoryRecordsInput$namespace": "The namespace to filter memory records by. If specified, only memory records in this namespace are returned.
", "NamespacesList$member": null, "RetrieveMemoryRecordsInput$namespace": "The namespace to filter memory records by.
" } }, "NamespacesList": { "base": null, "refs": { "MemoryRecord$namespaces": "The namespaces associated with this memory record. Namespaces help organize and categorize memory records.
", "MemoryRecordCreateInput$namespaces": "A list of namespace identifiers that categorize or group the memory record.
", "MemoryRecordSummary$namespaces": "The namespaces associated with this memory record.
", "MemoryRecordUpdateInput$namespaces": "The updated list of namespace identifiers for categorizing the memory record.
" } }, "NextToken": { "base": null, "refs": { "ListBrowserSessionsRequest$nextToken": "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 returns the first page of results.
", "ListBrowserSessionsResponse$nextToken": "The token to use in a subsequent ListBrowserSessions request to get the next set of results.
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 returns the first page of results.
", "ListCodeInterpreterSessionsResponse$nextToken": "The token to use in a subsequent ListCodeInterpreterSessions request to get the next set of results.
The type of flow to be performed.
" } }, "OperatorType": { "base": null, "refs": { "EventMetadataFilterExpression$operator": "Operator applied to the event metadata filter expression.
", "MemoryMetadataFilterExpression$operator": "The relationship between the metadata key and value to match when applying the metadata filter.
" } }, "PaginationToken": { "base": null, "refs": { "ListActorsInput$nextToken": "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$nextToken": "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.
", "ListEventsInput$nextToken": "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$nextToken": "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$nextToken": "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.
", "ListMemoryExtractionJobsOutput$nextToken": "Token to retrieve the next page of results, if available.
", "ListMemoryRecordsInput$nextToken": "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.
", "ListMemoryRecordsOutput$nextToken": "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.
", "ListSessionsInput$nextToken": "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.
", "ListSessionsOutput$nextToken": "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.
", "RetrieveMemoryRecordsInput$nextToken": "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.
", "RetrieveMemoryRecordsOutput$nextToken": "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.
" } }, "PayloadType": { "base": "Contains the payload content for an event.
", "refs": { "PayloadTypeList$member": null } }, "PayloadTypeList": { "base": null, "refs": { "CreateEventInput$payload": "The content payload of the event. This can include conversational data or binary content.
", "Event$payload": "The content payload of the event.
" } }, "ProgrammingLanguage": { "base": null, "refs": { "ToolArguments$language": "The programming language of the code to execute. This tells the code interpreter which language runtime to use for execution. Common values include 'python', 'javascript', and 'r'.
" } }, "RequestIdentifier": { "base": null, "refs": { "MemoryRecordCreateInput$requestIdentifier": "A client-provided identifier for tracking this specific record creation request.
", "MemoryRecordOutput$requestIdentifier": "The client-provided identifier that was used to track this record operation.
" } }, "RequestUri": { "base": null, "refs": { "CompleteResourceTokenAuthRequest$sessionUri": "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.
", "GetResourceOauth2TokenRequest$sessionUri": "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.
", "GetResourceOauth2TokenResponse$sessionUri": "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.
" } }, "ResourceContent": { "base": "Contains information about resource content.
", "refs": { "ContentBlock$resource": "The resource associated with the content block.
" } }, "ResourceContentType": { "base": null, "refs": { "ResourceContent$type": "The type of resource content.
" } }, "ResourceLocation": { "base": "The location of the browser extension.
", "refs": { "BrowserExtension$location": "The location where the browser extension files are stored. This specifies the source from which the extension will be loaded and installed.
" } }, "ResourceNotFoundException": { "base": "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.
", "refs": { "CodeInterpreterStreamOutput$resourceNotFoundException": null } }, "ResourceOauth2ReturnUrlType": { "base": null, "refs": { "GetResourceOauth2TokenRequest$resourceOauth2ReturnUrl": "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.
" } }, "ResponseStream": { "base": null, "refs": { "InvokeAgentRuntimeResponse$response": "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.
" } }, "RetrieveMemoryRecordsInput": { "base": null, "refs": {} }, "RetrieveMemoryRecordsOutput": { "base": null, "refs": {} }, "RetryableConflictException": { "base": "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.
", "refs": {} }, "RightExpression": { "base": "Right expression of the eventMetadatafilter.
Right operand of the event metadata filter expression.
", "MemoryMetadataFilterExpression$right": null } }, "Role": { "base": null, "refs": { "Conversational$role": "The role of the participant in the conversation (for example, \"user\" or \"assistant\").
" } }, "RuntimeClientError": { "base": "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.
", "refs": {} }, "S3Location": { "base": "The Amazon S3 location configuration of a resource.
", "refs": { "ResourceLocation$s3": "The Amazon S3 location of the resource. Use this when the resource is stored in an Amazon S3 bucket.
" } }, "S3LocationBucketString": { "base": null, "refs": { "S3Location$bucket": "The name of the Amazon S3 bucket where the resource is stored.
" } }, "S3LocationPrefixString": { "base": null, "refs": { "S3Location$prefix": "The name of the Amazon S3 prefix/key where the resource is stored.
" } }, "S3LocationVersionIdString": { "base": null, "refs": { "S3Location$versionId": "The name of the Amazon S3 version ID where the resource is stored (Optional).
" } }, "ScopeType": { "base": null, "refs": { "ScopesListType$member": null } }, "ScopesListType": { "base": null, "refs": { "GetResourceOauth2TokenRequest$scopes": "The OAuth scopes being requested.
" } }, "SearchCriteria": { "base": "Contains search criteria for retrieving memory records.
", "refs": { "RetrieveMemoryRecordsInput$searchCriteria": "The search criteria to use for finding relevant memory records. This includes the search query, memory strategy ID, and other search parameters.
" } }, "SearchCriteriaSearchQueryString": { "base": null, "refs": { "SearchCriteria$searchQuery": "The search query to use for finding relevant memory records.
" } }, "SearchCriteriaTopKInteger": { "base": null, "refs": { "SearchCriteria$topK": "The maximum number of top-scoring memory records to return. This value is used for semantic search ranking.
" } }, "ServiceException": { "base": "The service encountered an internal error. Try your request again later.
", "refs": {} }, "ServiceQuotaExceededException": { "base": "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.
", "refs": { "CodeInterpreterStreamOutput$serviceQuotaExceededException": null } }, "SessionId": { "base": null, "refs": { "CreateEventInput$sessionId": "The identifier of the session in which this event occurs. A session represents a sequence of related events.
", "DeleteEventInput$sessionId": "The identifier of the session containing the event to delete.
", "Event$sessionId": "The identifier of the session containing the event.
", "GetAgentCardResponse$runtimeSessionId": "The ID of the session associated with the AgentCore Runtime agent.
", "GetEventInput$sessionId": "The identifier of the session containing the event.
", "InvokeAgentRuntimeResponse$runtimeSessionId": "The identifier of the runtime session.
", "InvokeAgentRuntimeResponse$mcpSessionId": "The identifier of the MCP session.
", "ListEventsInput$sessionId": "The identifier of the session for which to list events.
", "SessionSummary$sessionId": "The unique identifier of the session.
", "StopRuntimeSessionResponse$runtimeSessionId": "The ID of the session that you requested to stop.
" } }, "SessionStatus": { "base": null, "refs": { "GetResourceOauth2TokenResponse$sessionStatus": "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.
" } }, "SessionSummary": { "base": "Contains summary information about a session in an AgentCore Memory resource.
", "refs": { "SessionSummaryList$member": null } }, "SessionSummaryList": { "base": null, "refs": { "ListSessionsOutput$sessionSummaries": "The list of session summaries that match the specified criteria.
" } }, "SessionType": { "base": null, "refs": { "GetAgentCardRequest$runtimeSessionId": "The session ID that the AgentCore Runtime agent is using.
", "InvokeAgentRuntimeRequest$runtimeSessionId": "The identifier of the runtime session.
", "StopRuntimeSessionRequest$runtimeSessionId": "The ID of the session that you want to stop.
" } }, "Span": { "base": null, "refs": { "Spans$member": null } }, "SpanContext": { "base": "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.
", "refs": { "Context$spanContext": "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.
" } }, "SpanId": { "base": null, "refs": { "SpanIds$member": null } }, "SpanIds": { "base": null, "refs": { "EvaluationTarget$spanIds": "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.
" } }, "Spans": { "base": null, "refs": { "EvaluationInput$sessionSpans": "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.
" } }, "StartBrowserSessionRequest": { "base": null, "refs": {} }, "StartBrowserSessionRequestTraceIdString": { "base": null, "refs": { "StartBrowserSessionRequest$traceId": "The trace identifier for request tracking.
" } }, "StartBrowserSessionRequestTraceParentString": { "base": null, "refs": { "StartBrowserSessionRequest$traceParent": "The parent trace information for distributed tracing.
" } }, "StartBrowserSessionResponse": { "base": null, "refs": {} }, "StartCodeInterpreterSessionRequest": { "base": null, "refs": {} }, "StartCodeInterpreterSessionRequestTraceIdString": { "base": null, "refs": { "StartCodeInterpreterSessionRequest$traceId": "The trace identifier for request tracking.
" } }, "StartCodeInterpreterSessionRequestTraceParentString": { "base": null, "refs": { "StartCodeInterpreterSessionRequest$traceParent": "The parent trace information for distributed tracing.
" } }, "StartCodeInterpreterSessionResponse": { "base": null, "refs": {} }, "StartMemoryExtractionJobInput": { "base": null, "refs": {} }, "StartMemoryExtractionJobOutput": { "base": null, "refs": {} }, "State": { "base": null, "refs": { "GetResourceOauth2TokenRequest$customState": "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.
" } }, "StopBrowserSessionRequest": { "base": null, "refs": {} }, "StopBrowserSessionRequestTraceIdString": { "base": null, "refs": { "StopBrowserSessionRequest$traceId": "The trace identifier for request tracking.
" } }, "StopBrowserSessionRequestTraceParentString": { "base": null, "refs": { "StopBrowserSessionRequest$traceParent": "The parent trace information for distributed tracing.
" } }, "StopBrowserSessionResponse": { "base": null, "refs": {} }, "StopCodeInterpreterSessionRequest": { "base": null, "refs": {} }, "StopCodeInterpreterSessionRequestTraceIdString": { "base": null, "refs": { "StopCodeInterpreterSessionRequest$traceId": "The trace identifier for request tracking.
" } }, "StopCodeInterpreterSessionRequestTraceParentString": { "base": null, "refs": { "StopCodeInterpreterSessionRequest$traceParent": "The parent trace information for distributed tracing.
" } }, "StopCodeInterpreterSessionResponse": { "base": null, "refs": {} }, "StopRuntimeSessionRequest": { "base": null, "refs": {} }, "StopRuntimeSessionResponse": { "base": null, "refs": {} }, "StreamUpdate": { "base": "Contains information about an update to a stream.
", "refs": { "UpdateBrowserStreamRequest$streamUpdate": "The update to apply to the browser stream.
" } }, "String": { "base": null, "refs": { "BatchCreateMemoryRecordsInput$clientToken": "A unique, case-sensitive identifier to ensure idempotent processing of the batch request.
", "BrowserSessionSummary$browserIdentifier": "The unique identifier of the browser associated with the session. This identifier specifies which browser environment is used for the session.
", "CodeInterpreterSessionSummary$codeInterpreterIdentifier": "The unique identifier of the code interpreter associated with the session. This identifier specifies which code interpreter environment is used for the session.
", "ContentBlock$text": "The text content of the block.
", "ContentBlock$mimeType": "The MIME type of the content.
", "ContentBlock$uri": "The URI of the content.
", "ContentBlock$name": "The name of the content block.
", "ContentBlock$description": "The description of the content block.
", "CreateEventInput$clientToken": "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.
", "EvaluationResultContent$label": "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\").
", "ExtractionJob$jobId": "The unique identifier of the extraction job.
", "ExtractionJobFilterInput$strategyId": "The memory strategy identifier to filter extraction jobs by. If specified, only extraction jobs with this strategy ID are returned.
", "ExtractionJobFilterInput$sessionId": "The unique identifier of the session. If specified, only extraction jobs with this session ID are returned.
", "ExtractionJobFilterInput$actorId": "The identifier of the actor. If specified, only extraction jobs with this actor ID are returned.
", "ExtractionJobMetadata$jobID": "The unique identifier for the extraction job.
", "ExtractionJobMetadata$failureReason": "The cause of failure, if the job did not complete successfully.
", "ExtractionJobMetadata$strategyId": "The identifier of the memory strategy for this extraction job.
", "ExtractionJobMetadata$sessionId": "The identifier of the session for this extraction job.
", "ExtractionJobMetadata$actorId": "The identifier of the actor for this extraction job.
", "GetAgentCardRequest$agentRuntimeArn": "The ARN of the AgentCore Runtime agent for which you want to get the A2A agent card.
", "GetAgentCardRequest$qualifier": "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 unique identifier of the browser associated with the session.
", "GetBrowserSessionResponse$browserIdentifier": "The identifier of the browser.
", "GetBrowserSessionResponse$sessionReplayArtifact": "The artifact containing the session replay information.
", "GetCodeInterpreterSessionRequest$codeInterpreterIdentifier": "The unique identifier of the code interpreter associated with the session.
", "GetCodeInterpreterSessionResponse$codeInterpreterIdentifier": "The identifier of the code interpreter.
", "InvalidInputException$message": null, "InvokeAgentRuntimeRequest$agentRuntimeArn": "The Amazon Web Services Resource Name (ARN) of the agent runtime to invoke. The ARN uniquely identifies the agent runtime resource in Amazon Bedrock.
", "InvokeAgentRuntimeRequest$qualifier": "The qualifier to use for the agent runtime. This can be a version number or an endpoint name that points to a specific version. If not specified, Amazon Bedrock uses the default version of the agent runtime.
", "InvokeAgentRuntimeResponse$mcpProtocolVersion": "The version of the MCP protocol being used.
", "InvokeAgentRuntimeResponse$traceId": "The trace identifier for request tracking.
", "InvokeAgentRuntimeResponse$traceParent": "The parent trace information for distributed tracing.
", "InvokeAgentRuntimeResponse$traceState": "The trace state information for distributed tracing.
", "InvokeAgentRuntimeResponse$baggage": "Additional context information for distributed tracing.
", "InvokeAgentRuntimeResponse$contentType": "The MIME type of the response data. This indicates how to interpret the response data. Common values include application/json for JSON data.
", "InvokeCodeInterpreterRequest$codeInterpreterIdentifier": "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 browser to list sessions for. If specified, only sessions for this browser are returned. If not specified, sessions for all browsers are returned.
", "ListCodeInterpreterSessionsRequest$codeInterpreterIdentifier": "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.
", "MemoryRecordOutput$errorMessage": "A human-readable error message describing why the memory record operation failed.
", "MessageMetadata$eventId": "The identifier of the event associated with this message.
", "ResourceContent$uri": "The URI of the resource content.
", "ResourceContent$mimeType": "The MIME type of the resource content.
", "ResourceContent$text": "The text resource content.
", "RetryableConflictException$message": null, "ServiceException$message": null, "SpanContext$sessionId": " 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.
", "SpanContext$spanId": "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.
", "StartBrowserSessionRequest$browserIdentifier": "The unique identifier of the browser to use for this session. This identifier specifies which browser environment to initialize for the session.
", "StartBrowserSessionResponse$browserIdentifier": "The identifier of the browser.
", "StartCodeInterpreterSessionRequest$codeInterpreterIdentifier": "The unique identifier of the code interpreter to use for this session. This identifier specifies which code interpreter environment to initialize for the session.
", "StartCodeInterpreterSessionResponse$codeInterpreterIdentifier": "The identifier of the code interpreter.
", "StartMemoryExtractionJobInput$clientToken": "A unique, case-sensitive identifier to ensure idempotent processing of the request.
", "StartMemoryExtractionJobOutput$jobId": "Extraction Job ID that was attempted to start.
", "StopBrowserSessionRequest$browserIdentifier": "The unique identifier of the browser associated with the session.
", "StopBrowserSessionResponse$browserIdentifier": "The identifier of the browser.
", "StopCodeInterpreterSessionRequest$codeInterpreterIdentifier": "The unique identifier of the code interpreter associated with the session.
", "StopCodeInterpreterSessionResponse$codeInterpreterIdentifier": "The identifier of the code interpreter.
", "StopRuntimeSessionRequest$agentRuntimeArn": "The ARN of the agent that contains the session that you want to stop.
", "StopRuntimeSessionRequest$qualifier": "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 identifier of the task that produced the result.
", "ToolResultStructuredContent$stdout": "The standard output from the tool execution.
", "ToolResultStructuredContent$stderr": "The standard error output from the tool execution.
", "UpdateBrowserStreamRequest$browserIdentifier": "The identifier of the browser.
", "UpdateBrowserStreamResponse$browserIdentifier": "The identifier of the browser.
", "ValidationException$message": null, "ValidationExceptionField$name": "The name of the field.
", "ValidationExceptionField$message": "A message describing why this field failed validation.
" } }, "StringList": { "base": null, "refs": { "ToolArguments$paths": "The paths for the tool operation.
" } }, "StringType": { "base": null, "refs": { "InvokeAgentRuntimeRequest$mcpSessionId": "The identifier of the MCP session.
", "InvokeAgentRuntimeRequest$mcpProtocolVersion": "The version of the MCP protocol being used.
", "InvokeAgentRuntimeRequest$runtimeUserId": "The identifier of the runtime user.
" } }, "TaskStatus": { "base": null, "refs": { "ToolResultStructuredContent$taskStatus": "The status of the task that produced the result.
" } }, "ThrottledException": { "base": "The request was denied due to request throttling. Reduce the frequency of requests and try again.
", "refs": {} }, "ThrottlingException": { "base": "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.
", "refs": { "CodeInterpreterStreamOutput$throttlingException": null } }, "Timestamp": { "base": null, "refs": { "CreateEventInput$eventTimestamp": "The timestamp when the event occurred. If not specified, the current time is used.
", "Event$eventTimestamp": "The timestamp when the event occurred.
", "MemoryRecord$createdAt": "The timestamp when the memory record was created.
", "MemoryRecordCreateInput$timestamp": "Time at which the memory record was created.
", "MemoryRecordSummary$createdAt": "The timestamp when the memory record was created.
", "MemoryRecordUpdateInput$timestamp": "Time at which the memory record was updated
", "SessionSummary$createdAt": "The timestamp when the session was created.
" } }, "TokenUsage": { "base": "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.
", "refs": { "EvaluationResultContent$tokenUsage": "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.
" } }, "ToolArguments": { "base": "The collection of arguments that specify the operation to perform and its parameters when invoking a tool in Amazon Bedrock. Different tools require different arguments, and this structure provides a flexible way to pass the appropriate arguments to each tool type.
", "refs": { "InvokeCodeInterpreterRequest$arguments": "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.
" } }, "ToolName": { "base": null, "refs": { "InvokeCodeInterpreterRequest$name": "The name of the code interpreter to invoke.
" } }, "ToolResultStructuredContent": { "base": "Contains structured content from a tool result.
", "refs": { "CodeInterpreterResult$structuredContent": "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.
" } }, "TraceId": { "base": null, "refs": { "TraceIds$member": null } }, "TraceIds": { "base": null, "refs": { "EvaluationTarget$traceIds": "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.
" } }, "UnauthorizedException": { "base": "This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access
", "refs": {} }, "UpdateBrowserStreamRequest": { "base": null, "refs": {} }, "UpdateBrowserStreamResponse": { "base": null, "refs": {} }, "UserIdType": { "base": null, "refs": { "GetWorkloadAccessTokenForUserIdRequest$userId": "The ID of the user for whom you are retrieving the access token.
", "UserIdentifier$userId": "The ID of the user for whom you have retrieved a workload access token for
" } }, "UserIdentifier": { "base": "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.
", "refs": { "CompleteResourceTokenAuthRequest$userIdentifier": "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.
" } }, "UserTokenType": { "base": null, "refs": { "GetWorkloadAccessTokenForJWTRequest$userToken": "The OAuth 2.0 token issued by the user's identity provider.
", "UserIdentifier$userToken": "The OAuth2.0 token issued by the user’s identity provider
" } }, "ValidationException": { "base": "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.
", "refs": { "CodeInterpreterStreamOutput$validationException": null } }, "ValidationExceptionField": { "base": "Stores information about a field passed inside a request that resulted in an exception.
", "refs": { "ValidationExceptionFieldList$member": null } }, "ValidationExceptionFieldList": { "base": null, "refs": { "ValidationException$fieldList": null } }, "ValidationExceptionReason": { "base": null, "refs": { "ValidationException$reason": null } }, "ViewPort": { "base": "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.
", "refs": { "GetBrowserSessionResponse$viewPort": null, "StartBrowserSessionRequest$viewPort": "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 uses a default viewport size.
" } }, "ViewPortHeight": { "base": null, "refs": { "ViewPort$height": "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.
" } }, "ViewPortWidth": { "base": null, "refs": { "ViewPort$width": "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.
" } }, "WorkloadIdentityNameType": { "base": null, "refs": { "GetWorkloadAccessTokenForJWTRequest$workloadName": "The unique identifier for the registered workload.
", "GetWorkloadAccessTokenForUserIdRequest$workloadName": "The name of the workload from which you want to retrieve the access token.
", "GetWorkloadAccessTokenRequest$workloadName": "The unique identifier for the registered workload.
" } }, "WorkloadIdentityTokenType": { "base": null, "refs": { "GetResourceApiKeyRequest$workloadIdentityToken": "The identity token of the workload from which you want to retrieve the API key.
", "GetResourceOauth2TokenRequest$workloadIdentityToken": "The identity token of the workload from which you want to retrieve the OAuth2 token.
", "GetWorkloadAccessTokenForJWTResponse$workloadAccessToken": "An opaque token representing the identity of both the workload and the user.
", "GetWorkloadAccessTokenForUserIdResponse$workloadAccessToken": "The access token for the specified workload.
", "GetWorkloadAccessTokenResponse$workloadAccessToken": "An opaque token representing the identity of both the workload and the user.
" } } } }