GetCodeInterpreter
Gets information about a custom code interpreter.
Request Syntax
GET /code-interpreters/codeInterpreterId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- codeInterpreterId
-
The unique identifier of the code interpreter to retrieve.
Pattern:
(aws\.codeinterpreter\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10})Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"codeInterpreterArn": "string",
"codeInterpreterId": "string",
"createdAt": "string",
"description": "string",
"executionRoleArn": "string",
"failureReason": "string",
"lastUpdatedAt": "string",
"name": "string",
"networkConfiguration": {
"networkMode": "string",
"vpcConfig": {
"securityGroups": [ "string" ],
"subnets": [ "string" ]
}
},
"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.
- codeInterpreterArn
-
The Amazon Resource Name (ARN) of the code interpreter.
Type: String
Pattern:
arn:(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:(aws|[0-9]{12}):code-interpreter(-custom)?/(aws\.codeinterpreter\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}) - codeInterpreterId
-
The unique identifier of the code interpreter.
Type: String
Pattern:
(aws\.codeinterpreter\.v1|[a-zA-Z][a-zA-Z0-9_]{0,47}-[a-zA-Z0-9]{10}) - createdAt
-
The timestamp when the code interpreter was created.
Type: Timestamp
- description
-
The description of the code interpreter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
- executionRoleArn
-
The IAM role ARN that provides permissions for the code interpreter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+ - failureReason
-
The reason for failure if the code interpreter is in a failed state.
Type: String
- lastUpdatedAt
-
The timestamp when the code interpreter was last updated.
Type: Timestamp
- name
-
The name of the code interpreter.
Type: String
Pattern:
[a-zA-Z][a-zA-Z0-9_]{0,47} - networkConfiguration
-
The network configuration for a code interpreter. This structure defines how the code interpreter connects to the network.
Type: CodeInterpreterNetworkConfiguration object
- status
-
The current status of the code interpreter.
Type: String
Valid Values:
CREATING | CREATE_FAILED | READY | DELETING | DELETE_FAILED | DELETED
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
This exception is thrown when a request is denied per access permissions
HTTP Status Code: 403
- InternalServerException
-
This exception is thrown if there was an unexpected error during processing of request
HTTP Status Code: 500
- ResourceNotFoundException
-
This exception is thrown when a resource referenced by the operation does not exist
HTTP Status Code: 404
- ServiceQuotaExceededException
-
This exception is thrown when a request is made beyond the service quota
HTTP Status Code: 402
- ThrottlingException
-
This exception is thrown when the number of requests exceeds the limit
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
