Sign in

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

OK

idstring

Lease ID

principalIdstring

principalId of the lease to get

accountIdstring

accountId of the AWS account

leaseStatus'Active' | 'Decommissioned' | 'FinanceLock' | 'ResetLock' | 'ResetFinanceLock'

Status of the Lease. "Active": The principal is leased and has access to the account "Decommissioned": The principal was previously leased to the account, but now is not. "FinanceLock": The principal is leased to the account, but has hit a budget threshold, and is locked out of the account. "ResetLock": The principal is leased to the account, but the account is being reset. The principal's access is temporarily revoked, and will be given back after the reset process is complete. "ResetFinanceLock": The principal is leased to the account, but has been locked out for hitting a budget threshold. Additionally, the account is being reset. After reset, the principal's access will not be restored, and the LeaseStatus will be set back to ResetLock.

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

requestedLeaseEndnumber

date lease should expire in epoch seconds

Changes