Skip to content

get_code_interpreter_session

Operation

get_code_interpreter_session

get_code_interpreter_session(request: GetCodeInterpreterSessionInput | GetCodeInterpreterSessionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetCodeInterpreterSessionInputDict]) -> GetCodeInterpreterSessionOutput

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:

Parameters:

Name Type Description Default
request GetCodeInterpreterSessionInput | GetCodeInterpreterSessionInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetCodeInterpreterSessionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetCodeInterpreterSessionOutput

An instance of GetCodeInterpreterSessionOutput.

get_code_interpreter_session async

get_code_interpreter_session(request: GetCodeInterpreterSessionInput | GetCodeInterpreterSessionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetCodeInterpreterSessionInputDict]) -> GetCodeInterpreterSessionOutput

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:

Parameters:

Name Type Description Default
request GetCodeInterpreterSessionInput | GetCodeInterpreterSessionInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetCodeInterpreterSessionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetCodeInterpreterSessionOutput

An instance of GetCodeInterpreterSessionOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetCodeInterpreterSessionInputDict

Bases: TypedDict

Dictionary form of GetCodeInterpreterSessionInput.

Attributes

code_interpreter_identifier instance-attribute
code_interpreter_identifier: Required[str]

The unique identifier of the code interpreter associated with the session.

session_id instance-attribute
session_id: Required[str]

The unique identifier of the code interpreter session to retrieve.

GetCodeInterpreterSessionInput dataclass

Bases: _SerdeShape

Dataclass for GetCodeInterpreterSessionInput structure.

Attributes

code_interpreter_identifier class-attribute instance-attribute
code_interpreter_identifier: str | None = ...

The unique identifier of the code interpreter associated with the session.

session_id class-attribute instance-attribute
session_id: str | None = ...

The unique identifier of the code interpreter session to retrieve.

Output

GetCodeInterpreterSessionOutput dataclass

Bases: _SerdeShape

Dataclass for GetCodeInterpreterSessionOutput structure.

Attributes

certificates class-attribute instance-attribute
certificates: list[Certificate] | None = ...

The list of certificates installed in the code interpreter session.

code_interpreter_identifier instance-attribute
code_interpreter_identifier: str

The identifier of the code interpreter.

created_at instance-attribute
created_at: datetime

The time at which the code interpreter session was created.

filesystem_configurations class-attribute instance-attribute
filesystem_configurations: list[ToolsFileSystemConfiguration] | None = ...

The file system configurations for the code interpreter session. Each entry describes an access point and its mount path.

name class-attribute instance-attribute
name: str | None = ...

The name of the code interpreter session.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

session_id instance-attribute
session_id: str

The identifier of the code interpreter session.

session_timeout_seconds class-attribute instance-attribute
session_timeout_seconds: int | None = ...

The timeout period for the code interpreter session in seconds.

status class-attribute instance-attribute
status: str | None = ...

The current status of the code interpreter session. Possible values include ACTIVE, STOPPING, and STOPPED.