Agents

Agents define instruction-driven AI assistants with configurable models, tools, and controlled access to shared resources.

Agent package artifacts must be specified under the Artifacts.Package key using one of the two supported input modes: File or Folder.
Each path should be relative to the root resources directory.

Note

Agent definitions now use Artifacts.Package (File / Folder) and the Properties shown below.

If you have existing definitions that use a top-level Artifacts.Script path, or properties such as Instruction, Tools, and AgentResponseType, update them to the current structure before redeploying.

Input Modes

File Mode

Use File mode for a pre-built zip package. The zip is uploaded as-is.

{
  "rAgent": {
    "Type": "Agent",
    "Artifacts": {
      "Package": {
        "File": "resources/new.zip"
      }
    },
    "Properties": {
      "AgentName": "cicd_agent_zip",
      "Description": "Agent fixture for CICD testing (pre-built zip File input, uploaded as-is)",
      "ModelId": "anthropic.claude-sonnet-4-20250514-v1:0",
      "PythonVersion": "PYTHON_3_12",
      "EntryPoint": "new.py",
      "AgentType": "CUSTOM",
      "ResourceAccessMetadata": {
        "KnowledgebaseAccess": [],
        "ParameterAccess": [],
        "GuardRails": [
          {
            "Id": {"!DependsOn": "rGuardrail.GuardRailId"},
            "Version": "DRAFT"
          }
        ]
      }
    }
  }
}

Folder Mode

Use Folder mode when the agent source lives in a directory. CICD packages the folder before upload.

{
  "rAgentFolder": {
    "Type": "Agent",
    "Artifacts": {
      "Package": {
        "Folder": "resources/agent_folder"
      }
    },
    "Properties": {
      "AgentName": "cicd_agent_folder",
      "Description": "Agent Folder",
      "ModelId": "anthropic.claude-sonnet-4-20250514-v1:0",
      "PythonVersion": "PYTHON_3_12",
      "EntryPoint": "agent_main.py",
      "AgentType": "CUSTOM",
      "ResourceAccessMetadata": {
        "KnowledgebaseAccess": [],
        "ParameterAccess": [],
        "GuardRails": [
          {
            "Id": {"!DependsOn": "rGuardrail.GuardRailId"},
            "Version": "DRAFT"
          }
        ]
      }
    }
  }
}

Note: Deployment dependencies

Agent has dependencies on Tag.

Dependent resources should not be deleted before the primary resource; attempting to do so may lead to failures or inconsistencies during the deletion process.

Referencing this Resource

Below are the common keys that can be used in the DependsOn function to retrieve details of this resource.

Supported Keys

Key	Description
AgentName	Returns the AgentName value of this resource
AgentId	Returns the AgentId value of this resource

For additional supported keys, refer to the API definition document for the respective resource type.

Example

To reference this agent from another resource, use !DependsOn with logical name and property in the format <logicalResourceName>.<PropertyName>.

Example: {"!DependsOn": "rAgent.AgentId"}