Retrieve all S3 buckets with additional information
Retrieves all S3 buckets with additional information. Use this to view detailed properties of the buckets in your environment.
HTTP method and endpoint
GET /aws/ha/metadata/get-buckets-details
Error
Status: Default, Default response
| Name | Type | Required | Description |
|---|---|---|---|
s3Buckets |
array[S3BucketInfoDetails] |
True |
|
totalBackupTargets |
integer |
False |
|
totalBuckets |
integer |
True |
|
totalRegions |
integer |
False |
|
totalTieringTargets |
integer |
False |
Example error response
{
"s3Buckets": [
{
"bucketName": "string",
"region": "string",
"tags": {
"traversableAgain": false
}
}
],
"totalBuckets": 0
}
Definitions
See Definitions
| Name | Type | Required | Description |
|---|---|---|---|
empty |
boolean |
False |
|
traversableAgain |
boolean |
True |
S3BucketInfoDetails
| Name | Type | Required | Description |
|---|---|---|---|
bucketName |
string |
True |
|
isBackupTarget |
boolean |
False |
|
isTieringTarget |
boolean |
False |
|
region |
string |
False |
|
tags |
True |