Sign in

Update an account (admin)

Changed on
put/accounts/{accountId}

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/accounts/{accountId}
  • Auth: HTTP bearer

Path parameters

accountIdstring required

Request body

namestring
descriptionstring
assume_role_arnstring
external_idstring
default_regionstring
vend_role_arnstring

The fleet-vend role a cross-account vend into this account assumes. Published to SSM by landing-zone. Omit the key to leave the stored value alone; send an empty string to clear it. Requires both permissions boundaries whenever it is set.

data_kms_key_arnstring

Customer-managed KMS key for this account's data at rest. Published to SSM by landing-zone. Empty means the XRD default.

cluster_permissions_boundary_arnstring

IAM permissions boundary capping the roles a cross-account vend mints for the cluster. Published to SSM at /eks-fleet/<environment>/fleet-vend/vend_permissions_boundary_arn.

operator_permissions_boundary_arnstring

Permissions boundary capping the roles the agent-platform operator mints on this account. Same requirement and SSM source as cluster_permissions_boundary_arn.

Response

Updated account

idstring required
org_idstring required
namestring required
descriptionstring required
aws_account_idstring required
assume_role_arnstring required
default_regionstring required
created_bystring required
created_atstring date-time required
updated_atstring date-time required
external_id_setboolean required

Whether an assume-role external id is configured; the value itself never leaves the server.

vend_role_arnstring required

The fleet-vend role a cross-account vend into this account assumes. Published to SSM by landing-zone; the vend does not create it. Empty means ungated (same-account vending). Requires both permissions boundaries — an order carrying the role without them is refused.

data_kms_key_arnstring required

Customer-managed KMS key for this account's data at rest. Published to SSM by landing-zone. Empty means the XRD default.

cluster_permissions_boundary_arnstring required

IAM permissions boundary capping the roles a cross-account vend mints for the cluster. Published to SSM at /eks-fleet/<environment>/fleet-vend/vend_permissions_boundary_arn.

operator_permissions_boundary_arnstring required

Permissions boundary capping the roles the agent-platform operator mints on this account. Same requirement and SSM source as cluster_permissions_boundary_arn.

Changes

  • eb15df8427c9Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status