BedrockAgentCoreControl / Client / get_agent_runtime

get_agent_runtime

BedrockAgentCoreControl.Client.get_agent_runtime(**kwargs)

Gets an Amazon Bedrock AgentCore Runtime.

See also: AWS API Documentation

Request Syntax

response = client.get_agent_runtime(
    agentRuntimeId='string',
    agentRuntimeVersion='string'
)
Parameters:

  • agentRuntimeId (string) –

    [REQUIRED]

    The unique identifier of the AgentCore Runtime to retrieve.

  • agentRuntimeVersion (string) – The version of the AgentCore Runtime to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'agentRuntimeArn': 'string',
    'agentRuntimeName': 'string',
    'agentRuntimeId': 'string',
    'agentRuntimeVersion': 'string',
    'createdAt': datetime(2015, 1, 1),
    'lastUpdatedAt': datetime(2015, 1, 1),
    'roleArn': 'string',
    'networkConfiguration': {
        'networkMode': 'PUBLIC'|'VPC',
        'networkModeConfig': {
            'securityGroups': [
                'string',
            ],
            'subnets': [
                'string',
            ]
        }
    },
    'status': 'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'READY'|'DELETING',
    'lifecycleConfiguration': {
        'idleRuntimeSessionTimeout': 123,
        'maxLifetime': 123
    },
    'description': 'string',
    'workloadIdentityDetails': {
        'workloadIdentityArn': 'string'
    },
    'agentRuntimeArtifact': {
        'containerConfiguration': {
            'containerUri': 'string'
        },
        'codeConfiguration': {
            'code': {
                's3': {
                    'bucket': 'string',
                    'prefix': 'string',
                    'versionId': 'string'
                }
            },
            'runtime': 'PYTHON_3_10'|'PYTHON_3_11'|'PYTHON_3_12'|'PYTHON_3_13',
            'entryPoint': [
                'string',
            ]
        }
    },
    'protocolConfiguration': {
        'serverProtocol': 'MCP'|'HTTP'|'A2A'
    },
    'environmentVariables': {
        'string': 'string'
    },
    'authorizerConfiguration': {
        'customJWTAuthorizer': {
            'discoveryUrl': 'string',
            'allowedAudience': [
                'string',
            ],
            'allowedClients': [
                'string',
            ]
        }
    },
    'requestHeaderConfiguration': {
        'requestHeaderAllowlist': [
            'string',
        ]
    }
}

Response Structure

  • (dict) –

    • agentRuntimeArn (string) –

      The Amazon Resource Name (ARN) of the AgentCore Runtime.

    • agentRuntimeName (string) –

      The name of the AgentCore Runtime.

    • agentRuntimeId (string) –

      The unique identifier of the AgentCore Runtime.

    • agentRuntimeVersion (string) –

      The version of the AgentCore Runtime.

    • createdAt (datetime) –

      The timestamp when the AgentCore Runtime was created.

    • lastUpdatedAt (datetime) –

      The timestamp when the AgentCore Runtime was last updated.

    • roleArn (string) –

      The IAM role ARN that provides permissions for the AgentCore Runtime.

    • networkConfiguration (dict) –

      The network configuration for the AgentCore Runtime.

      • networkMode (string) –

        The network mode for the AgentCore Runtime.

      • networkModeConfig (dict) –

        The network mode configuration for the AgentCore Runtime.

        • 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 AgentCore Runtime.

    • lifecycleConfiguration (dict) –

      The life cycle configuration for the AgentCore Runtime.

      • idleRuntimeSessionTimeout (integer) –

        Timeout in seconds for idle runtime sessions. When a session remains idle for this duration, it will be automatically terminated. Default: 900 seconds (15 minutes).

      • maxLifetime (integer) –

        Maximum lifetime for the instance in seconds. Once reached, instances will be automatically terminated and replaced. Default: 28800 seconds (8 hours).

    • description (string) –

      The description of the AgentCore Runtime.

    • workloadIdentityDetails (dict) –

      The workload identity details for the AgentCore Runtime.

      • workloadIdentityArn (string) –

        The ARN associated with the workload identity.

    • agentRuntimeArtifact (dict) –

      The artifact of the AgentCore Runtime.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: containerConfiguration, codeConfiguration. 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'}

      • containerConfiguration (dict) –

        The container configuration for the agent artifact.

        • containerUri (string) –

          The ECR URI of the container.

      • codeConfiguration (dict) –

        The code configuration for the agent runtime artifact, including the source code location and execution settings.

        • code (dict) –

          The source code location and configuration details.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: s3. 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'}

          • s3 (dict) –

            The Amazon Amazon S3 object that contains the source code for the agent runtime.

            • bucket (string) –

              The name of the Amazon S3 bucket. This bucket contains the stored data.

            • prefix (string) –

              The prefix for objects in the Amazon S3 bucket. This prefix is added to the object keys to organize the data.

            • versionId (string) –

              The version ID of the Amazon Amazon S3 object. If not specified, the latest version of the object is used.

        • runtime (string) –

          The runtime environment for executing the code (for example, Python 3.9 or Node.js 18).

        • entryPoint (list) –

          The entry point for the code execution, specifying the function or method that should be invoked when the code runs.

          • (string) –

    • protocolConfiguration (dict) –

      The protocol configuration for an agent runtime. This structure defines how the agent runtime communicates with clients.

      • serverProtocol (string) –

        The server protocol for the agent runtime. This field specifies which protocol the agent runtime uses to communicate with clients.

    • environmentVariables (dict) –

      Environment variables set in the AgentCore Runtime environment.

      • (string) –

        • (string) –

    • authorizerConfiguration (dict) –

      The authorizer configuration for the AgentCore Runtime.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: customJWTAuthorizer. 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'}

      • customJWTAuthorizer (dict) –

        The inbound JWT-based authorization, specifying how incoming requests should be authenticated.

        • discoveryUrl (string) –

          This URL is used to fetch OpenID Connect configuration or authorization server metadata for validating incoming tokens.

        • allowedAudience (list) –

          Represents individual audience values that are validated in the incoming JWT token validation process.

          • (string) –

        • allowedClients (list) –

          Represents individual client IDs that are validated in the incoming JWT token validation process.

          • (string) –

    • requestHeaderConfiguration (dict) –

      Configuration for HTTP request headers that will be passed through to the runtime.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: requestHeaderAllowlist. 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'}

      • requestHeaderAllowlist (list) –

        A list of HTTP request headers that are allowed to be passed through to the runtime.

        • (string) –

Exceptions