Skip to content

Commit 5ae559a

Browse files
arepageekAndrés Aguilar
andauthored
docs: sync CLI documentation with actual command surface (#1296)
* docs: update CLI command names and table formatting - Replace `batch-eval` with `batch-evaluation` in PERMISSIONS.md for consistency - Replace `recommend` with `recommendation` in PERMISSIONS.md for consistency - Update table column alignment in PERMISSIONS.md logging section - Standardize table formatting across commands.md and evals.md documentation - Align CLI command naming conventions throughout documentation * docs: fix --request-header-allowlist auto-prefix value Per review feedback (#1296), the auto-prefix for bare header names without 'X-' is the legacy 'X-Amzn-Bedrock-AgentCore-Runtime-Custom-', not 'X-Custom-' as the table previously stated. The X-* pass-through half was already correct. Confirmed against normalizeHeaderName in src/cli/commands/shared/header-utils.ts and the HEADER_ALLOWLIST_PREFIX constant in src/schema/schemas/agent-env.ts. --------- Co-authored-by: Andrés Aguilar <andiaa@amazon.com>
1 parent 52d3e84 commit 5ae559a

3 files changed

Lines changed: 352 additions & 129 deletions

File tree

docs/PERMISSIONS.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -337,17 +337,17 @@ Required for all deployment operations (`deploy`, `status`, `diff`).
337337

338338
### Batch evaluation and recommendations
339339

340-
| Action | CLI Commands | Purpose |
341-
| ----------------------------------------- | ---------------- | ------------------------------ |
342-
| `bedrock-agentcore:StartBatchEvaluation` | `run batch-eval` | Start a batch evaluation job |
343-
| `bedrock-agentcore:GetBatchEvaluation` | `run batch-eval` | Poll batch evaluation status |
344-
| `bedrock-agentcore:ListBatchEvaluations` | `evals history` | List past batch evaluations |
345-
| `bedrock-agentcore:StopBatchEvaluation` | `run batch-eval` | Stop an in-progress batch eval |
346-
| `bedrock-agentcore:DeleteBatchEvaluation` | `run batch-eval` | Delete a batch evaluation |
347-
| `bedrock-agentcore:StartRecommendation` | `run recommend` | Start a recommendation job |
348-
| `bedrock-agentcore:GetRecommendation` | `run recommend` | Poll recommendation status |
349-
| `bedrock-agentcore:ListRecommendations` | `run recommend` | List past recommendations |
350-
| `bedrock-agentcore:DeleteRecommendation` | `run recommend` | Stop/delete a recommendation |
340+
| Action | CLI Commands | Purpose |
341+
| ----------------------------------------- | ---------------------- | ------------------------------ |
342+
| `bedrock-agentcore:StartBatchEvaluation` | `run batch-evaluation` | Start a batch evaluation job |
343+
| `bedrock-agentcore:GetBatchEvaluation` | `run batch-evaluation` | Poll batch evaluation status |
344+
| `bedrock-agentcore:ListBatchEvaluations` | `evals history` | List past batch evaluations |
345+
| `bedrock-agentcore:StopBatchEvaluation` | `run batch-evaluation` | Stop an in-progress batch eval |
346+
| `bedrock-agentcore:DeleteBatchEvaluation` | `run batch-evaluation` | Delete a batch evaluation |
347+
| `bedrock-agentcore:StartRecommendation` | `run recommendation` | Start a recommendation job |
348+
| `bedrock-agentcore:GetRecommendation` | `run recommendation` | Poll recommendation status |
349+
| `bedrock-agentcore:ListRecommendations` | `run recommendation` | List past recommendations |
350+
| `bedrock-agentcore:DeleteRecommendation` | `run recommendation` | Stop/delete a recommendation |
351351

352352
### Identity and credential management
353353

@@ -375,19 +375,19 @@ Required for all deployment operations (`deploy`, `status`, `diff`).
375375

376376
### Logging, traces, and observability
377377

378-
| Action | CLI Commands | Purpose |
379-
| ------------------------------- | ---------------------------------------- | ---------------------------------------------------------- |
380-
| `logs:StartLiveTail` | `logs` | Stream agent logs in real-time |
381-
| `logs:FilterLogEvents` | `logs` | Search agent logs |
382-
| `logs:StartQuery` | `traces list`, `traces get`, `run evals` | Run CloudWatch Logs Insights queries |
383-
| `logs:GetQueryResults` | `traces list`, `traces get`, `run evals` | Retrieve query results |
384-
| `logs:DescribeResourcePolicies` | `deploy` | Check for X-Ray log resource policy |
385-
| `logs:PutResourcePolicy` | `deploy` | Create resource policy for X-Ray trace access |
386-
| `logs:DescribeLogGroups` | `run batch-eval`, `run recommend` | Discover runtime log groups for evaluation data sources |
387-
| `logs:CreateLogGroup` | `run batch-eval` | Create log group for batch evaluation results output |
388-
| `logs:CreateLogStream` | `run batch-eval` | Create log stream for batch evaluation results |
389-
| `logs:PutLogEvents` | `run batch-eval` | Write batch evaluation results to CloudWatch Logs |
390-
| `logs:PutRetentionPolicy` | `run batch-eval` | Set retention policy on batch evaluation results log group |
378+
| Action | CLI Commands | Purpose |
379+
| ------------------------------- | -------------------------------------------- | ---------------------------------------------------------- |
380+
| `logs:StartLiveTail` | `logs` | Stream agent logs in real-time |
381+
| `logs:FilterLogEvents` | `logs` | Search agent logs |
382+
| `logs:StartQuery` | `traces list`, `traces get`, `run evals` | Run CloudWatch Logs Insights queries |
383+
| `logs:GetQueryResults` | `traces list`, `traces get`, `run evals` | Retrieve query results |
384+
| `logs:DescribeResourcePolicies` | `deploy` | Check for X-Ray log resource policy |
385+
| `logs:PutResourcePolicy` | `deploy` | Create resource policy for X-Ray trace access |
386+
| `logs:DescribeLogGroups` | `run batch-evaluation`, `run recommendation` | Discover runtime log groups for evaluation data sources |
387+
| `logs:CreateLogGroup` | `run batch-evaluation` | Create log group for batch evaluation results output |
388+
| `logs:CreateLogStream` | `run batch-evaluation` | Create log stream for batch evaluation results |
389+
| `logs:PutLogEvents` | `run batch-evaluation` | Write batch evaluation results to CloudWatch Logs |
390+
| `logs:PutRetentionPolicy` | `run batch-evaluation` | Set retention policy on batch evaluation results log group |
391391

392392
### Transaction search setup
393393

0 commit comments

Comments
 (0)