Skip to main content
PATCH
Update an AWS account

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

If-Match
string | null
x-tenant-id
string
required

The organization ID the request is scoped to.

Path Parameters

aws_account_id
string
required

Body

application/json

Changes to apply to an AWS payer account.

A JSON merge patch: omit a field to leave it unchanged. Only s3_prefix may be set to null, which moves SELECT to reading the root of the bucket. Every other field is optional here only so it can be omitted; an explicit null on one of them is rejected rather than silently ignored, since none of them has a legal cleared state — an account with no name, no payer id, no bucket, no region or no credentials cannot ingest anything. Supplying credentials replaces the stored key pair.

name
string | null

Display name for the account, as shown throughout SELECT.

payer_account_id
string | null

The 12-digit AWS account id of the payer account SELECT reads spend for.

Pattern: ^\d{12}$
s3_bucket
string | null

The S3 bucket AWS delivers this payer account's Cost and Usage Report to.

Minimum string length: 1
s3_prefix
string | null

Path within the bucket that the report is delivered under. Null when the report is delivered at the root of the bucket.

region
string | null

The AWS region the bucket is in, such as us-east-1. SELECT reads the bucket through this region's S3 endpoint.

Pattern: ^[a-z][a-z0-9-]+-\d+$
credentials
AwsCredentials · object | null

Replacement IAM credentials. Omit to keep the stored ones. SELECT verifies them against the bucket before they are saved.

sync_enabled
boolean | null

Whether SELECT is currently syncing data for this account.

Response

Successful Response

A connection to one AWS payer account.

id
string
required
read-only

The unique identifier of the account.

etag
string
required
read-only

Opaque strong ETag for this account's configuration. Matches the ETag response header, and is what If-Match requires on a write. It changes whenever a configurable field on the account changes.

name
string
required

Display name for the account, as shown throughout SELECT.

connection_id
string
required
read-only

Identifier of the underlying connection, which SELECT reports sync state and connection alerts against.

payer_account_id
string
required

The 12-digit AWS account id of the payer account SELECT reads spend for.

s3_bucket
string
required

The S3 bucket AWS delivers this payer account's Cost and Usage Report to.

region
string
required

The AWS region the bucket is in, such as us-east-1. SELECT reads the bucket through this region's S3 endpoint.

sync_enabled
boolean
required

Whether SELECT is currently syncing data for this account.

create_time
string
required
read-only

When the account was added.

update_time
string
required
read-only

When the account was last changed.

s3_prefix
string | null

Path within the bucket that the report is delivered under. Null when the report is delivered at the root of the bucket.

added_by_email
string | null

Email address of the person who added the account. Null when it was not added by a person.

last_successful_sync_time
string | null

When SELECT last completed a sync for this account. Null before the first one succeeds.