agentcore-cli 0.31.1__py3-none-any.whl

agentcore/schema/schemas/deployed_state.py

@@ -0,0 +1,322 @@
+"""Deployed state, i.e. deployed-state.json (port of ``schemas/deployed-state.ts``)."""
+
+from __future__ import annotations
+
+from collections.abc import Iterable
+from typing import Annotated, Literal
+
+from pydantic import AfterValidator, Field, TypeAdapter
+
+from .._zod import ZBool, ZodModel, raise_issues, zint, zstr
+from .auth import CustomClaimValidation
+from .aws_targets import DeploymentTargetName
+
+_NonEmpty = zstr(min=1)
+
+# ============================================================================
+# Agent / Memory
+# ============================================================================
+
+
+class AgentCoreDeployedState(ZodModel):
+    runtime_id: _NonEmpty
+    runtime_arn: _NonEmpty
+    role_arn: _NonEmpty
+    session_id: str | None = None
+    memory_ids: list[str] | None = None
+    browser_id: str | None = None
+    code_interpreter_id: str | None = None
+    # The latest deployed version number of this runtime.
+    runtime_version: zint(ge=1) | None = None
+
+
+class MemoryDeployedState(ZodModel):
+    memory_id: _NonEmpty
+    memory_arn: _NonEmpty
+
+
+# ============================================================================
+# MCP Gateway / Runtime / Lambda
+# ============================================================================
+
+
+class GatewayTargetDeployedState(ZodModel):
+    target_id: _NonEmpty
+
+
+class GatewayDeployedState(ZodModel):
+    gateway_id: _NonEmpty
+    gateway_arn: _NonEmpty
+    gateway_url: str | None = None
+    targets: dict[str, GatewayTargetDeployedState] | None = None
+
+
+class McpRuntimeDeployedState(ZodModel):
+    runtime_id: _NonEmpty
+    runtime_arn: _NonEmpty
+    runtime_endpoint: _NonEmpty
+
+
+class McpLambdaDeployedState(ZodModel):
+    function_arn: _NonEmpty
+    function_name: _NonEmpty
+
+
+class McpDeployedState(ZodModel):
+    gateways: dict[str, GatewayDeployedState] | None = None
+    runtimes: dict[str, McpRuntimeDeployedState] | None = None
+    lambdas: dict[str, McpLambdaDeployedState] | None = None
+
+
+# ============================================================================
+# Externally Managed Resources
+# ============================================================================
+
+
+class ExternallyManagedResource(ZodModel):
+    name: _NonEmpty
+
+
+class CustomJwtAuthorizer(ExternallyManagedResource):
+    allowed_audience: list[str] | None = None
+    allowed_clients: list[str] | None = None
+    allowed_scopes: list[str] | None = None
+    custom_claims: list[CustomClaimValidation] | None = None
+    discovery_url: str
+
+
+class VpcConfig(ExternallyManagedResource):
+    security_groups: list[str]
+    subnets: list[str]
+
+
+class ExternallyManagedState(ZodModel):
+    custom_jwt_authorizer: CustomJwtAuthorizer | None = None
+    vpc_config: VpcConfig | None = None
+
+
+# ============================================================================
+# Policy Engine / Policy / Harness / Credential / Evaluator
+# ============================================================================
+
+
+class PolicyEngineDeployedState(ZodModel):
+    policy_engine_id: _NonEmpty
+    policy_engine_arn: _NonEmpty
+
+
+class PolicyDeployedState(ZodModel):
+    policy_id: _NonEmpty
+    policy_arn: _NonEmpty
+    engine_name: _NonEmpty
+
+
+class HarnessDeployedState(ZodModel):
+    harness_id: _NonEmpty
+    harness_arn: _NonEmpty
+    role_arn: _NonEmpty
+    status: _NonEmpty
+    # Read-only config version from the CFN `Version` output; service-incremented per update.
+    harness_version: zint(ge=1) | None = None
+    agent_runtime_arn: str | None = None
+    memory_arn: str | None = None
+    # Which subsystem provisioned this harness ('cloudformation' from the CDK deploy path).
+    provisioner: Literal["cloudformation"] | None = None
+
+
+class CredentialDeployedState(ZodModel):
+    credential_provider_arn: _NonEmpty
+    client_secret_arn: str | None = None
+    callback_url: str | None = None
+
+
+class EvaluatorDeployedState(ZodModel):
+    evaluator_id: _NonEmpty
+    evaluator_arn: _NonEmpty
+
+
+class OnlineEvalDeployedState(ZodModel):
+    online_evaluation_config_id: _NonEmpty
+    online_evaluation_config_arn: _NonEmpty
+    execution_status: Literal["ENABLED", "DISABLED"] | None = None
+    agent: zstr(min=1) | None = None
+    endpoint: zstr(min=1) | None = None
+
+
+class DatasetDeployedState(ZodModel):
+    dataset_id: _NonEmpty
+    dataset_arn: _NonEmpty
+    content_hash: str | None = None
+
+
+# ============================================================================
+# Knowledge Base
+# ============================================================================
+
+
+class KnowledgeBaseDataSourceDeployedState(ZodModel):
+    data_source_id: _NonEmpty
+    uri: _NonEmpty
+
+
+class KnowledgeBaseDeployedState(ZodModel):
+    """Per-target KB state. ``dataSources`` is index-aligned with the local ``dataSources[]``.
+
+    ``sourcesHash`` is a SHA-256 of the data-source URIs captured when auto-ingestion last fired;
+    absent means "ingest needed".
+    """
+
+    knowledge_base_id: _NonEmpty
+    knowledge_base_arn: _NonEmpty
+    data_sources: list[KnowledgeBaseDataSourceDeployedState] = Field(default_factory=list)
+    sources_hash: zstr(min=1) | None = None
+
+
+class ConfigBundleDeployedState(ZodModel):
+    bundle_id: _NonEmpty
+    bundle_arn: _NonEmpty
+    version_id: _NonEmpty
+
+
+class ABTestDeployedState(ZodModel):
+    ab_test_id: _NonEmpty
+    ab_test_arn: _NonEmpty
+    role_arn: zstr(min=1) | None = None
+    role_created_by_cli: ZBool | None = None
+    config_hash: str | None = None
+
+
+class RuntimeEndpointDeployedState(ZodModel):
+    endpoint_id: _NonEmpty
+    endpoint_arn: _NonEmpty
+
+
+# ============================================================================
+# Payments
+# ============================================================================
+
+
+class QuickCreatePaymentConnectorDeployedState(ZodModel):
+    connector_id: _NonEmpty
+    credential_provider_name: str | None = None
+    provision_mode: Literal["QUICK_CREATE"]
+    credential_provider_arn: None = None
+
+
+class ManualPaymentConnectorDeployedState(ZodModel):
+    connector_id: _NonEmpty
+    credential_provider_name: str | None = None
+    provision_mode: Literal["MANUAL"] | None = None
+    credential_provider_arn: _NonEmpty
+
+
+PaymentConnectorDeployedState = Annotated[
+    QuickCreatePaymentConnectorDeployedState | ManualPaymentConnectorDeployedState,
+    Field(union_mode="left_to_right"),
+]
+
+
+class PaymentDeployedState(ZodModel):
+    manager_id: _NonEmpty
+    manager_arn: _NonEmpty
+    connectors: dict[str, PaymentConnectorDeployedState] = Field(default_factory=dict)
+    process_payment_role_arn: _NonEmpty
+    resource_retrieval_role_arn: _NonEmpty
+    authorizer_type: Literal["AWS_IAM", "CUSTOM_JWT"] | None = None
+    auto_payment: ZBool | None = None
+    payment_tool_allowlist: list[str] | None = None
+    network_preferences: list[str] | None = None
+
+
+class CapacityProviderDeployedState(ZodModel):
+    capacity_provider_id: _NonEmpty
+    capacity_provider_arn: _NonEmpty
+
+
+# ============================================================================
+# Deployed Resource State / Target / Root
+# ============================================================================
+
+
+class DeployedResourceState(ZodModel):
+    runtimes: dict[str, AgentCoreDeployedState] | None = None
+    memories: dict[str, MemoryDeployedState] | None = None
+    mcp: McpDeployedState | None = None
+    gateways: dict[str, GatewayDeployedState] | None = None
+    externally_managed: ExternallyManagedState | None = None
+    credentials: dict[str, CredentialDeployedState] | None = None
+    evaluators: dict[str, EvaluatorDeployedState] | None = None
+    online_eval_configs: dict[str, OnlineEvalDeployedState] | None = None
+    datasets: dict[str, DatasetDeployedState] | None = None
+    knowledge_bases: dict[str, KnowledgeBaseDeployedState] | None = None
+    config_bundles: dict[str, ConfigBundleDeployedState] | None = None
+    ab_tests: dict[str, ABTestDeployedState] | None = None
+    policy_engines: dict[str, PolicyEngineDeployedState] | None = None
+    policies: dict[str, PolicyDeployedState] | None = None
+    harnesses: dict[str, HarnessDeployedState] | None = None
+    runtime_endpoints: dict[str, RuntimeEndpointDeployedState] | None = None
+    payments: dict[str, PaymentDeployedState] | None = None
+    capacity_providers: dict[str, CapacityProviderDeployedState] | None = None
+    stack_name: str | None = None
+    identity_kms_key_arn: str | None = None
+    deploy_hash: str | None = None
+
+
+class TargetDeployedState(ZodModel):
+    resources: DeployedResourceState | None = None
+
+
+class DeployedState(ZodModel):
+    # Keys are deployment target names (aws-targets.json `name`).
+    targets: dict[DeploymentTargetName, TargetDeployedState]
+
+
+def create_validated_deployed_state_schema(target_names: Iterable[str]) -> TypeAdapter[DeployedState]:
+    """DeployedState validator that also requires every target key to exist in aws-targets.
+
+    Port of ``createValidatedDeployedStateSchema``; use ``.validate_python(data)`` on the result.
+    """
+    names = set(target_names)
+
+    def check(state: DeployedState) -> DeployedState:
+        if not all(key in names for key in state.targets):
+            raise_issues([((), "Deployed state contains target names not present in aws-targets")], state)
+        return state
+
+    return TypeAdapter(Annotated[DeployedState, AfterValidator(check)])
+
+
+__all__ = [
+    "ABTestDeployedState",
+    "AgentCoreDeployedState",
+    "CapacityProviderDeployedState",
+    "ConfigBundleDeployedState",
+    "CredentialDeployedState",
+    "CustomJwtAuthorizer",
+    "DatasetDeployedState",
+    "DeployedResourceState",
+    "DeployedState",
+    "EvaluatorDeployedState",
+    "ExternallyManagedResource",
+    "ExternallyManagedState",
+    "GatewayDeployedState",
+    "GatewayTargetDeployedState",
+    "HarnessDeployedState",
+    "KnowledgeBaseDataSourceDeployedState",
+    "KnowledgeBaseDeployedState",
+    "ManualPaymentConnectorDeployedState",
+    "McpDeployedState",
+    "McpLambdaDeployedState",
+    "McpRuntimeDeployedState",
+    "MemoryDeployedState",
+    "OnlineEvalDeployedState",
+    "PaymentConnectorDeployedState",
+    "PaymentDeployedState",
+    "PolicyDeployedState",
+    "PolicyEngineDeployedState",
+    "QuickCreatePaymentConnectorDeployedState",
+    "RuntimeEndpointDeployedState",
+    "TargetDeployedState",
+    "VpcConfig",
+    "create_validated_deployed_state_schema",
+]