deployments system
Install operator status for platform administrators
| Command | Summary |
|---|---|
deployments system installation | Show the deployed release, account, endpoints, and observability data locations |
deployments system deployments | List recorded deployments, newest first |
deployments system components | Show ECS service and Lambda function health for the install |
deployments system alarms | List the install's CloudWatch alarms |
deployments system model-providers | Show model provider key metadata |
deployments system organizations | List every organization in the install |
deployments system standing | Show an organization's holds, grants, data boundary, and effective entitlements |
deployments system standing-history | List an organization's hold and grant changes, newest first |
deployments system spend | Show an organization's spend in a month, split by who paid |
deployments system hold | Place an operator hold on an organization |
deployments system release | Release an operator hold on an organization |
deployments system set-entitlements | Replace the operator's entitlement grant; omitted fields fall to other sources |
deployments system clear-entitlements | Remove the operator's entitlement grant |
deployments system set-data-boundary | Limit where an organization's data can go; only operators can set it |
deployments system clear-data-boundary | Remove an organization's data boundary |
deployments system set-principal-status | Disable a person, which ends their sessions, or re-enable them |
deployments system access-open | Open or renew your operator access to an organization's data |
deployments system access-close | Close your operator access to an organization |
deployments system access-show | Show your operator access to an organization |
deployments system access-list | List open operator access across the install |
deployments system people find | Find the person or pending sign-up holding an email; matches the whole address |
deployments system people show | Show a person's organizations, multi-factor state, and session counts |
deployments system people events | List a person's security events, newest first; secret fields are withheld |
deployments system people revoke-sessions | End every session, refresh token, and device grant without disabling the person |
deployments system people resend-verification | Resend a pending sign-up's verification email, under the self-service limits |
deployments system installation
Show the deployed release, account, endpoints, and observability data locations.
deployments system installation- Calls
GET /v1/system/installation(SDKgetSystemInstallation). - No tenancy context required.
Also accepts the global flags.
deployments system deployments
List recorded deployments, newest first.
deployments system deployments- Calls
GET /v1/system/deployments(SDKlistSystemDeployments). - No tenancy context required.
- 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 system components
Show ECS service and Lambda function health for the install.
deployments system components- Calls
GET /v1/system/components(SDKgetSystemComponents). - No tenancy context required.
Also accepts the global flags.
deployments system alarms
List the install's CloudWatch alarms.
deployments system alarms- Calls
GET /v1/system/alarms(SDKlistSystemAlarms). - No tenancy context required.
- 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 | ||
--state | ALARM | INSUFFICIENT_DATA | OK | Only alarms currently in this state |
Also accepts the global flags.
deployments system model-providers
Show model provider key metadata.
deployments system model-providers- Calls
GET /v1/system/model-providers(SDKlistSystemModelProviders). - No tenancy context required.
Also accepts the global flags.
deployments system organizations
List every organization in the install.
deployments system organizations- Calls
GET /v1/system/organizations(SDKlistSystemOrganizations). - No tenancy context required.
- 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 system standing
Show an organization's holds, grants, data boundary, and effective entitlements.
deployments system standing <organization-id>- Calls
GET /v1/system/organizations/{organizationId}/standing(SDKgetSystemOrganizationStanding). - No tenancy context required.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<organization-id> | positional | yes | Organization ID |
Also accepts the global flags.
deployments system standing-history
List an organization's hold and grant changes, newest first.
deployments system standing-history <organization-id>- Calls
GET /v1/system/organizations/{organizationId}/standing/history(SDKlistSystemOrganizationStandingHistory). - No tenancy context required.
- 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 | ||
<organization-id> | positional | yes | Organization ID |
Also accepts the global flags.
deployments system spend
Show an organization's spend in a month, split by who paid.
deployments system spend <organization-id>- Calls
GET /v1/system/organizations/{organizationId}/spend(SDKgetSystemOrganizationSpend). - No tenancy context required.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<organization-id> | positional | yes | Organization ID | |
--month | string | UTC month as YYYY-MM; defaults to the current month |
Also accepts the global flags.
deployments system hold
Place an operator hold on an organization.
deployments system hold <organization-id> <hold-key> --reason payment --customer-message <customer-message>- Calls
PUT /v1/system/organizations/{organizationId}/holds/{holdKey}(SDKplaceSystemOrganizationHold). - No tenancy context required.
- Destructive. Live runs ask for confirmation; pass
--yesin scripts or with--json.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<organization-id> | positional | yes | Organization ID | |
<hold-key> | positional | yes | Hold key: lowercase letters, digits, and hyphens | |
--reason | payment | abuse | policy | manual | yes | Why the organization is held | |
--customer-message | string | yes | Shown to the organization's members | |
--operator-note | string | Seen only by operators and services |
Also accepts the global flags.
deployments system release
Release an operator hold on an organization.
deployments system release <organization-id> <hold-key>- Calls
DELETE /v1/system/organizations/{organizationId}/holds/{holdKey}(SDKreleaseSystemOrganizationHold). - No tenancy context required.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<organization-id> | positional | yes | Organization ID | |
<hold-key> | positional | yes | Hold key: lowercase letters, digits, and hyphens | |
--release-note | string | Why the hold is released; recorded in the history |
Also accepts the global flags.
deployments system set-entitlements
Replace the operator's entitlement grant; omitted fields fall to other sources.
deployments system set-entitlements <organization-id>- Calls
PUT /v1/system/organizations/{organizationId}/entitlements(SDKreplaceSystemOrganizationEntitlements). - No tenancy context required.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<organization-id> | positional | yes | Organization ID | |
--tenant-limits | string (json) | Tenant limits, such as {"concurrentRuns":32} | ||
--model-spend-ceiling | string (json) | "unlimited" or {"monthlyUsdMicros":100000000} |
Also accepts the global flags.
deployments system clear-entitlements
Remove the operator's entitlement grant.
deployments system clear-entitlements <organization-id>- Calls
DELETE /v1/system/organizations/{organizationId}/entitlements(SDKclearSystemOrganizationEntitlements). - No tenancy context required.
- Destructive. Live runs ask for confirmation; pass
--yesin scripts or with--json.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<organization-id> | positional | yes | Organization ID |
Also accepts the global flags.
deployments system set-data-boundary
Limit where an organization's data can go; only operators can set it.
deployments system set-data-boundary --profile phi <organization-id> --operator-note <operator-note>- Calls
PUT /v1/system/organizations/{organizationId}/data-boundary(SDKsetSystemOrganizationDataBoundary). - No tenancy context required.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--profile | phi | yes | phi keeps tools off the public internet and models on Bedrock | |
<organization-id> | positional | yes | Organization ID | |
--operator-note | string | yes | Why, such as the agreement reference; never shown to members |
Also accepts the global flags.
deployments system clear-data-boundary
Remove an organization's data boundary.
deployments system clear-data-boundary <organization-id> --operator-note <operator-note>- Calls
DELETE /v1/system/organizations/{organizationId}/data-boundary(SDKclearSystemOrganizationDataBoundary). - No tenancy context required.
- Destructive. Live runs ask for confirmation; pass
--yesin scripts or with--json.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<organization-id> | positional | yes | Organization ID | |
--operator-note | string | yes | Why the boundary ends; recorded in the history |
Also accepts the global flags.
deployments system set-principal-status
Disable a person, which ends their sessions, or re-enable them.
deployments system set-principal-status <principal-id> --status active --reason <reason>- Calls
PUT /v1/system/principals/{principalId}/status(SDKreplaceSystemPrincipalStatus). - No tenancy context required.
- Destructive. Live runs ask for confirmation; pass
--yesin scripts or with--json.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<principal-id> | positional | yes | Principal ID of the person | |
--status | active | disabled | yes | disabled or active | |
--reason | string | yes | Why the status changes; recorded in the person's security events |
Also accepts the global flags.
deployments system access-open
Open or renew your operator access to an organization's data.
deployments system access-open <organization-id> --reason <reason>- Calls
PUT /v1/system/organizations/{organizationId}/operator-access(SDKopenSystemOrganizationAccess). - No tenancy context required.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<organization-id> | positional | yes | Organization ID | |
--reason | string | yes | Why you need the data; shown in the organization's audit log | |
--ticket | string | Support ticket or case reference | ||
--duration-minutes | string (number) | Minutes until access expires; defaults to 60, at most 480 |
Also accepts the global flags.
deployments system access-close
Close your operator access to an organization.
deployments system access-close <organization-id>- Calls
DELETE /v1/system/organizations/{organizationId}/operator-access(SDKcloseSystemOrganizationAccess). - No tenancy context required.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<organization-id> | positional | yes | Organization ID |
Also accepts the global flags.
deployments system access-show
Show your operator access to an organization.
deployments system access-show <organization-id>- Calls
GET /v1/system/organizations/{organizationId}/operator-access(SDKgetSystemOrganizationAccess). - No tenancy context required.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<organization-id> | positional | yes | Organization ID |
Also accepts the global flags.
deployments system access-list
List open operator access across the install.
deployments system access-list- Calls
GET /v1/system/operator-access(SDKlistSystemOperatorAccess). - No tenancy context required.
- 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 | ||
--organization-id | string | Only access to this organization |
Also accepts the global flags.
deployments system people find
Find the person or pending sign-up holding an email; matches the whole address.
deployments system people find --email <email>- Calls
GET /v1/system/principals(SDKfindSystemPrincipal). - No tenancy context required.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--email | string | yes | The whole email address |
Also accepts the global flags.
deployments system people show
Show a person's organizations, multi-factor state, and session counts.
deployments system people show <principal-id>- Calls
GET /v1/system/principals/{principalId}(SDKgetSystemPrincipal). - No tenancy context required.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<principal-id> | positional | yes | Principal ID of the person |
Also accepts the global flags.
deployments system people events
List a person's security events, newest first; secret fields are withheld.
deployments system people events <principal-id>- Calls
GET /v1/system/principals/{principalId}/security-events(SDKlistSystemPrincipalSecurityEvents). - No tenancy context required.
- 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 | ||
<principal-id> | positional | yes | Principal ID of the person |
Also accepts the global flags.
deployments system people revoke-sessions
End every session, refresh token, and device grant without disabling the person.
deployments system people revoke-sessions <principal-id> --reason <reason>- Calls
POST /v1/system/principals/{principalId}/sessions/revoke(SDKrevokeSystemPrincipalSessions). - No tenancy context required.
- Destructive. Live runs ask for confirmation; pass
--yesin scripts or with--json.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<principal-id> | positional | yes | Principal ID of the person | |
--reason | string | yes | Why the sessions end; recorded in the person's security events |
Also accepts the global flags.
deployments system people resend-verification
Resend a pending sign-up's verification email, under the self-service limits.
deployments system people resend-verification <principal-id> --reason <reason>- Calls
POST /v1/system/principals/{principalId}/verification-email(SDKresendSystemPrincipalVerification). - No tenancy context required.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<principal-id> | positional | yes | Principal ID of the person | |
--email | string | The email the sign-up waits on, from system people find | ||
--reason | string | yes | Why the email is resent; recorded in the person's security events |
Also accepts the global flags.