v1

latestSwagger 2.02026-07-1722732.4 KB

Get leases

get/leases

Query parameters

principalIdstring

Principal ID of the leases.

accountIdstring

Account ID of the leases.

statusstring

Status of the leases.

nextPrincipalIdstring

Principal ID with which to begin the scan operation. This is used to traverse through paginated results.

nextAccountIdstring

Account ID with which to begin the scan operation. This is used to traverse through paginated results.

limitinteger

The maximum number of leases to evaluate (not necessarily the number of matching leases). If there is another page, the URL for page will be in the response Link header.

Response

idstring

Lease ID

principalIdstring

principalId of the lease to get

accountIdstring

accountId of the AWS account

leaseStatus'Active' | 'Inactive'

Status of the Lease. "Active": The principal is leased and has access to the account "Inactive": The lease has become inactive, either through expiring, exceeding budget, or by request.

leaseStatusReason'LeaseExpired' | 'LeaseOverBudget' | 'LeaseDestroyed' | 'LeaseActive' | 'LeaseRolledBack'

A reason behind the lease status. "LeaseExpired": The lease exceeded its expiration time ("expiresOn") and the associated account was reset and returned to the account pool. "LeaseOverBudget": The lease exceeded its budgeted amount and the associated account was reset and returned to the account pool. "LeaseDestroyed": The lease was adminstratively ended, which can be done via the leases API. "LeaseActive": The lease is active. "LeaseRolledBack": A system error occurred while provisioning the lease. and it was rolled back.

createdOnnumber

creation date in epoch seconds

lastModifiedOnnumber

date last modified in epoch seconds

budgetAmountnumber

budget amount

budgetCurrencystring

budget currency

budgetNotificationEmailsstring[]

budget notification emails

leaseStatusModifiedOnnumber

date lease status was last modified in epoch seconds

expiresOnnumber

date lease should expire in epoch seconds