Skip to content

Commit 0821ead

Browse files
authored
Merge pull request #156 from anychen1/anychen/atx-toolkit-owner-contact-info
docs(aws-transform-agent-toolkit): pass required owner_contact_info to deploy pipeline
2 parents b28c71b + e59b452 commit 0821ead

2 files changed

Lines changed: 12 additions & 3 deletions

File tree

aws-transform-agent-toolkit/steering/deploy-agent-workflow.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,13 +76,16 @@ Ask the user these questions in order:
7676

7777
3. **Agent version**: "What version?" (default: `1.0.0`)
7878

79-
4. **IMPORTANT - Agent type**: "Will this agent be the main orchestrator that users interact with in the AWS Transform console?"
79+
4. **Owner contact** (required): "What email or CTI should receive notifications about this agent?" (e.g., `team@example.com`)
80+
- Passed as `owner_contact_info`. The registry requires a contact on every published agent, so this is required unless you deploy with `skip_registry=True`.
81+
82+
5. **IMPORTANT - Agent type**: "Will this agent be the main orchestrator that users interact with in the AWS Transform WebApp?"
8083
- If user says **YES** → This is a job orchestrator (set `job_orchestrator=True`)
8184
- If user says **NO** → This is a subagent (set `job_orchestrator=False`)
8285

83-
5. **If YES to question 4**, also ask: "What should the display name be in the chat UI?" (e.g., "Eswar Test Orchestrator")
86+
6. **If YES to question 5**, also ask: "What should the display name be in the chat UI?" (e.g., "Eswar Test Orchestrator")
8487

85-
6. **Build method**: "Use CodeBuild?" (recommend yes for Windows, auto-detect otherwise)
88+
7. **Build method**: "Use CodeBuild?" (recommend yes for Windows, auto-detect otherwise)
8689

8790
### Step 2: Use deploy_agent_full_pipeline Tool
8891

@@ -92,6 +95,7 @@ Call `deploy_agent_full_pipeline` with the gathered information:
9295
deploy_agent_full_pipeline(
9396
agent_path="<path from Step 1>",
9497
agent_name="<name from Step 1>",
98+
owner_contact_info="<owner email or CTI from Step 1>", # Required
9599
agent_version="<version from Step 1>",
96100
job_orchestrator=<True if user answered YES to orchestrator question, False otherwise>,
97101
chat_ui_label="<display name if job_orchestrator=True>", # Optional
@@ -100,6 +104,7 @@ deploy_agent_full_pipeline(
100104
```
101105

102106
**Key parameters:**
107+
- `owner_contact_info` → Required. Email or CTI for the agent's owner contact and notifications (required unless `skip_registry=True`)
103108
- `job_orchestrator=True` → Agent can be bound to workspaces (for orchestrators)
104109
- `job_orchestrator=False` → Agent called by other agents only (for subagents)
105110
- `chat_ui_label` → Only needed if job_orchestrator=True
@@ -176,6 +181,7 @@ If you want to deploy to Bedrock AgentCore but skip registry registration:
176181
deploy_agent_full_pipeline(
177182
agent_path="./agents/modernization",
178183
agent_name="modernization-orchestrator",
184+
owner_contact_info="", # not required when skip_registry=True
179185
skip_registry=True
180186
)
181187
```
@@ -188,6 +194,7 @@ For Windows users or CI/CD pipelines without local Docker:
188194
deploy_agent_full_pipeline(
189195
agent_path="./agents/modernization",
190196
agent_name="modernization-orchestrator",
197+
owner_contact_info="team@example.com",
191198
use_codebuild=True
192199
)
193200
```
@@ -200,6 +207,7 @@ If your IAM roles have different names:
200207
deploy_agent_full_pipeline(
201208
agent_path="./agents/modernization",
202209
agent_name="modernization-orchestrator",
210+
owner_contact_info="team@example.com",
203211
execution_role_arn="arn:aws:iam::123456:role/CustomExecutionRole",
204212
access_role_arn="arn:aws:iam::123456:role/CustomAccessRole"
205213
)

aws-transform-agent-toolkit/steering/deployment-pipeline-guide.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -993,6 +993,7 @@ Instead of manual shell scripts, you can deploy agents directly from Kiro using
993993
deploy_agent_full_pipeline(
994994
agent_path="./agents/modernization",
995995
agent_name="modernization-orchestrator",
996+
owner_contact_info="team@example.com",
996997
agent_version="1.0.0"
997998
)
998999
```

0 commit comments

Comments
 (0)