BedrockAgentCoreControlPlaneFrontingLayer / Client / create_agent_runtime

create_agent_runtime

BedrockAgentCoreControlPlaneFrontingLayer.Client.create_agent_runtime(**kwargs)

Creates an Amazon Secure Agent.

See also: AWS API Documentation

Request Syntax

response = client.create_agent_runtime(
    agentRuntimeName='string',
    description='string',
    agentRuntimeArtifact={
        'containerConfiguration': {
            'containerUri': 'string'
        }
    },
    roleArn='string',
    networkConfiguration={
        'networkMode': 'PUBLIC'
    },
    protocolConfiguration={
        'serverProtocol': 'MCP'|'HTTP'
    },
    clientToken='string',
    environmentVariables={
        'string': 'string'
    },
    authorizerConfiguration={
        'customJWTAuthorizer': {
            'discoveryUrl': 'string',
            'allowedAudience': [
                'string',
            ],
            'allowedClients': [
                'string',
            ]
        }
    }
)
Parameters:

  • agentRuntimeName (string) –

    [REQUIRED]

    The name of the secure agent.

  • description (string) – The description of the agent runtime.

  • agentRuntimeArtifact (dict) –

    [REQUIRED]

    The artifact of the agent.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: containerConfiguration.

    • containerConfiguration (dict) –

      The container configuration for the agent artifact.

      • containerUri (string) – [REQUIRED]

        The ECR URI of the container.

  • roleArn (string) –

    [REQUIRED]

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

  • networkConfiguration (dict) –

    [REQUIRED]

    The network configuration for the agent runtime.

    • networkMode (string) – [REQUIRED]

      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) – [REQUIRED]

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

  • clientToken (string) –

    A unique, case-sensitive identifier to ensure idempotency of the request.

    This field is autopopulated if not provided.

  • environmentVariables (dict) –

    Environment variables to 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 can be set: customJWTAuthorizer.

    • customJWTAuthorizer (dict) –

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

      • discoveryUrl (string) – [REQUIRED]

        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) –

Return type:

dict

Returns:

Response Syntax

{
    'agentRuntimeArn': 'string',
    'workloadIdentityDetails': {
        'workloadIdentityArn': 'string'
    },
    'agentRuntimeId': 'string',
    'agentRuntimeVersion': 'string',
    'createdAt': datetime(2015, 1, 1),
    '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.

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

    • status (string) –

      The current status of the agent runtime.

Exceptions