BedrockAgentCoreControlPlaneFrontingLayer / Client / get_agent_runtime

get_agent_runtime

BedrockAgentCoreControlPlaneFrontingLayer.Client.get_agent_runtime(**kwargs)

Gets an Amazon Secure Agent.

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 agent runtime to retrieve.

  • agentRuntimeVersion (string) – The version of the agent runtime to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'agentRuntimeArn': 'string',
    'workloadIdentityDetails': {
        'workloadIdentityArn': 'string'
    },
    'agentRuntimeName': 'string',
    'description': 'string',
    'agentRuntimeId': 'string',
    'agentRuntimeVersion': 'string',
    'createdAt': datetime(2015, 1, 1),
    'lastUpdatedAt': datetime(2015, 1, 1),
    'roleArn': 'string',
    'agentRuntimeArtifact': {
        'containerConfiguration': {
            'containerUri': 'string'
        }
    },
    'networkConfiguration': {
        'networkMode': 'PUBLIC'
    },
    'protocolConfiguration': {
        'serverProtocol': 'MCP'|'HTTP'
    },
    'environmentVariables': {
        'string': 'string'
    },
    'authorizerConfiguration': {
        'customJWTAuthorizer': {
            'discoveryUrl': 'string',
            'allowedAudience': [
                'string',
            ],
            'allowedClients': [
                'string',
            ]
        }
    },
    'status': 'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'READY'|'DELETING'
}

Response Structure

  • (dict) –

    • agentRuntimeArn (string) –

      The Amazon Resource Name (ARN) of the agent runtime.

    • workloadIdentityDetails (dict) –

      The workload identity details for the agent runtime.

      • workloadIdentityArn (string) –

        The ARN associated with the workload identity.

    • agentRuntimeName (string) –

      The name of the agent runtime.

    • description (string) –

      The description of the agent runtime.

    • agentRuntimeId (string) –

      The unique identifier of the agent runtime.

    • agentRuntimeVersion (string) –

      The version of the agent runtime.

    • createdAt (datetime) –

      The timestamp when the agent runtime was created.

    • lastUpdatedAt (datetime) –

      The timestamp when the agent runtime was last updated.

    • roleArn (string) –

      The IAM role ARN that provides permissions for the agent runtime.

    • agentRuntimeArtifact (dict) –

      The artifact of the agent runtime.

      Note

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

    • networkConfiguration (dict) –

      The network configuration for the agent runtime.

      • networkMode (string) –

        The network mode for the agent runtime.

    • 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 agent runtime environment.

      • (string) –

        • (string) –

    • authorizerConfiguration (dict) –

      The authorizer configuration for the agent 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) –

    • status (string) –

      The current status of the agent runtime.

Exceptions