GetCodeInterpreterSession
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:
Request Syntax
GET /code-interpreters/codeInterpreterIdentifier/sessions/get?sessionId=sessionId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- codeInterpreterIdentifier
-
The unique identifier of the code interpreter associated with the session.
Required: Yes
- sessionId
-
The unique identifier of the code interpreter session to retrieve.
Pattern:
[0-9a-zA-Z]{1,40}Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"codeInterpreterIdentifier": "string",
"createdAt": "string",
"name": "string",
"sessionId": "string",
"sessionTimeoutSeconds": number,
"status": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- codeInterpreterIdentifier
-
The identifier of the code interpreter.
Type: String
- createdAt
-
The time at which the code interpreter session was created.
Type: Timestamp
- name
-
The name of the code interpreter session.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
- sessionId
-
The identifier of the code interpreter session.
Type: String
Pattern:
[0-9a-zA-Z]{1,40} - sessionTimeoutSeconds
-
The timeout period for the code interpreter session in seconds.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 28800.
- status
-
The current status of the code interpreter session. Possible values include ACTIVE, STOPPING, and STOPPED.
Type: String
Valid Values:
READY | TERMINATED
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
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.
HTTP Status Code: 403
- InternalServerException
-
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.
HTTP Status Code: 500
- ResourceNotFoundException
-
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.
HTTP Status Code: 404
- ThrottlingException
-
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.
HTTP Status Code: 429
- ValidationException
-
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.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
