Connect AWS account

POST/v1/aws-accountsaws-accounts:writeSDK: awsAccounts.connect

Starts the BYOA flow. Buckt creates a pending AWS account record and returns its id along with a server-generated externalId (read it via Get AWS account). Use the external ID as the trust condition when you deploy the Buckt IAM role in your AWS account.

Body parameters

Name	Type	Default	Description
label	string	—	Optional human-readable label (max 100 characters). Useful when an org connects multiple AWS accounts.

Example request

import { Buckt } from "@buckt/sdk";

const client = new Buckt({ apiKey: process.env.BUCKT_API_KEY });

const { id } = await client.awsAccounts.connect({
  label: "Production AWS",
});

// Next: deploy the Buckt IAM role via CloudFormation, then PATCH
// the account with the role ARN and call client.awsAccounts.validate(id).

Responses

{
  "data": {
    "object": "aws_account",
    "id": "acc_01J5AAAAAAAAAAAAAAAAAAAAAA"
  },
  "error": null,
  "meta": null
}