Skip to content

get_code_interpreter

Operation

get_code_interpreter

get_code_interpreter(request: GetCodeInterpreterInput | GetCodeInterpreterInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetCodeInterpreterInputDict]) -> GetCodeInterpreterOutput

Gets information about a custom code interpreter.

Parameters:

Name Type Description Default
request GetCodeInterpreterInput | GetCodeInterpreterInputDict | 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[GetCodeInterpreterInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetCodeInterpreterOutput

An instance of GetCodeInterpreterOutput.

get_code_interpreter async

get_code_interpreter(request: GetCodeInterpreterInput | GetCodeInterpreterInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetCodeInterpreterInputDict]) -> GetCodeInterpreterOutput

Gets information about a custom code interpreter.

Parameters:

Name Type Description Default
request GetCodeInterpreterInput | GetCodeInterpreterInputDict | 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[GetCodeInterpreterInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetCodeInterpreterOutput

An instance of GetCodeInterpreterOutput.

Input

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

GetCodeInterpreterInputDict

Bases: TypedDict

Dictionary form of GetCodeInterpreterInput.

Attributes

code_interpreter_id instance-attribute
code_interpreter_id: Required[str]

The unique identifier of the code interpreter to retrieve.

GetCodeInterpreterInput dataclass

Bases: _SerdeShape

Dataclass for GetCodeInterpreterInput structure.

Attributes

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

The unique identifier of the code interpreter to retrieve.

Output

GetCodeInterpreterOutput dataclass

Bases: _SerdeShape

Dataclass for GetCodeInterpreterOutput structure.

Attributes

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

The list of certificates configured for the code interpreter.

code_interpreter_arn instance-attribute
code_interpreter_arn: str

The Amazon Resource Name (ARN) of the code interpreter.

code_interpreter_id instance-attribute
code_interpreter_id: str

The unique identifier of the code interpreter.

created_at instance-attribute
created_at: datetime

The timestamp when the code interpreter was created.

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

The description of the code interpreter.

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

The IAM role ARN that provides permissions for the code interpreter.

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

The reason for failure if the code interpreter is in a failed state.

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

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

last_updated_at instance-attribute
last_updated_at: datetime

The timestamp when the code interpreter was last updated.

name instance-attribute
name: str

The name of the code interpreter.

network_configuration instance-attribute
network_configuration: CodeInterpreterNetworkConfiguration

The network configuration for a code interpreter. This structure defines how the code interpreter connects to the network.

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.

status instance-attribute
status: str

The current status of the code interpreter.