Command reference
deployments email-placement
Agent email regional placements
| Command | Summary |
|---|---|
deployments email-placement create | Create an email placement |
deployments email-placement list | List email placements |
deployments email-placement show | Show an email placement |
deployments email-placement update | Update an email placement |
deployments email-placement create
Create an email placement.
deployments email-placement create --name <name> --region <region>- Calls
POST /v1/agent-email/placements(SDKcreateAgentEmailPlacement). - Needs an environment:
--envor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--name | string | yes | Resource name | |
--region | string | yes | Primary AWS region | |
--secondary-region | string | Secondary AWS region | ||
--dedicated-pool | boolean | Use a dedicated IP pool | ||
--is-default | boolean | Make this the default placement |
Also accepts the global flags.
deployments email-placement list
List email placements.
deployments email-placement list- Calls
GET /v1/agent-email/placements(SDKlistAgentEmailPlacements). - Needs an environment:
--envor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (number) | Page size |
Also accepts the global flags.
deployments email-placement show
Show an email placement.
deployments email-placement show <id>- Calls
GET /v1/agent-email/placements/{placementId}(SDKgetAgentEmailPlacement). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments email-placement update
Update an email placement.
deployments email-placement update <id>- Calls
PATCH /v1/agent-email/placements/{placementId}(SDKupdateAgentEmailPlacement). - Needs an environment:
--envor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID | |
--name | string | Placement name | ||
--status | string | active or disabled | ||
--dedicated-pool | boolean | Use a dedicated IP pool | ||
--is-default | boolean | Make this the default placement |
Also accepts the global flags.