code_interpreter_sessions
Creates, updates, deletes, gets or lists a code_interpreter_sessions resource.
Overview
| Name | code_interpreter_sessions |
| Type | Resource |
| Id | aws.bedrock_agentcore.code_interpreter_sessions |
Fields
The following fields are returned by SELECT queries:
- get_code_interpreter_session
- list_code_interpreter_sessions
| Name | Datatype | Description |
|---|---|---|
name | string | The name of the code interpreter session. |
certificates | array | The list of certificates installed in the code interpreter session. |
code_interpreter_identifier | string | The identifier of the code interpreter. |
created_at | string (date-time) | The time at which the code interpreter session was created. |
filesystem_configurations | array | The file system configurations for the code interpreter session. Each entry describes an access point and its mount path. |
session_id | string | The identifier of the code interpreter session. (pattern: <code>[0-9a-zA-Z]{1,40}</code>) |
session_timeout_seconds | integer | The timeout period for the code interpreter session in seconds. |
status | string | The current status of the code interpreter session. Possible values include ACTIVE, STOPPING, and STOPPED. (READY, TERMINATED) |
| Name | Datatype | Description |
|---|---|---|
items_ | array | The list of code interpreter sessions that match the specified criteria. |
next_token | string | The token to use in a subsequent ListCodeInterpreterSessions request to get the next set of results. (pattern: <code>\S*</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_code_interpreter_session | select | code_interpreter_identifier, sessionId, region | 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: StartCodeInterpreterSession ListCodeInterpreterSessions StopCodeInterpreterSession | |
list_code_interpreter_sessions | select | code_interpreter_identifier, region | 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: StartCodeInterpreterSession GetCodeInterpreterSession |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
code_interpreter_identifier | string | 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. |
region | string | AWS region (default: us-east-1) |
sessionId | string | The unique identifier of the code interpreter session to retrieve. |
SELECT examples
- get_code_interpreter_session
- list_code_interpreter_sessions
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: StartCodeInterpreterSession ListCodeInterpreterSessions StopCodeInterpreterSession
SELECT
name,
certificates,
code_interpreter_identifier,
created_at,
filesystem_configurations,
session_id,
session_timeout_seconds,
status
FROM aws.bedrock_agentcore.code_interpreter_sessions
WHERE code_interpreter_identifier = '{{ code_interpreter_identifier }}' -- required
AND sessionId = '{{ sessionId }}' -- required
AND region = '{{ region }}' -- required
;
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: StartCodeInterpreterSession GetCodeInterpreterSession
SELECT
items_,
next_token
FROM aws.bedrock_agentcore.code_interpreter_sessions
WHERE code_interpreter_identifier = '{{ code_interpreter_identifier }}' -- required
AND region = '{{ region }}' -- required
;