BedrockAgentCoreControl / Client / get_code_interpreter

get_code_interpreter

BedrockAgentCoreControl.Client.get_code_interpreter(**kwargs)

Gets information about a custom code interpreter.

See also: AWS API Documentation

Request Syntax

response = client.get_code_interpreter(
    codeInterpreterId='string'
)
Parameters:

codeInterpreterId (string) –

[REQUIRED]

The unique identifier of the code interpreter to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'codeInterpreterId': 'string',
    'codeInterpreterArn': 'string',
    'name': 'string',
    'description': 'string',
    'executionRoleArn': 'string',
    'networkConfiguration': {
        'networkMode': 'PUBLIC'|'SANDBOX'|'VPC',
        'vpcConfig': {
            'securityGroups': [
                'string',
            ],
            'subnets': [
                'string',
            ]
        }
    },
    'status': 'CREATING'|'CREATE_FAILED'|'READY'|'DELETING'|'DELETE_FAILED'|'DELETED',
    'certificates': [
        {
            'location': {
                'secretsManager': {
                    'secretArn': 'string'
                }
            }
        },
    ],
    'failureReason': 'string',
    'createdAt': datetime(2015, 1, 1),
    'lastUpdatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • codeInterpreterId (string) –

      The unique identifier of the code interpreter.

    • codeInterpreterArn (string) –

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

    • name (string) –

      The name of the code interpreter.

    • description (string) –

      The description of the code interpreter.

    • executionRoleArn (string) –

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

    • networkConfiguration (dict) –

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

      • networkMode (string) –

        The network mode for the code interpreter. This field specifies how the code interpreter connects to the network.

      • vpcConfig (dict) –

        VpcConfig for the Agent.

        • securityGroups (list) –

          The security groups associated with the VPC configuration.

          • (string) –

        • subnets (list) –

          The subnets associated with the VPC configuration.

          • (string) –

    • status (string) –

      The current status of the code interpreter.

    • certificates (list) –

      The list of certificates configured for the code interpreter.

      • (dict) –

        A certificate to install in the browser or code interpreter.

        • location (dict) –

          The location of the certificate.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: secretsManager. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • secretsManager (dict) –

            The Amazon Web Services Secrets Manager location of the certificate.

            • secretArn (string) –

              The ARN of the Amazon Web Services Secrets Manager secret containing the certificate.

    • failureReason (string) –

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

    • createdAt (datetime) –

      The timestamp when the code interpreter was created.

    • lastUpdatedAt (datetime) –

      The timestamp when the code interpreter was last updated.

Exceptions