S3 Get Bucket

API code: S3_GET_BUCKET
Pre-authorized role(s): TENANT_USER | TENANT_ADMIN | ANONYMOUS

Request

URI

GET

https://apaas-29.eng.vmware.com//api/v1/s3/{bucketName}

COPY

Path Parameters

bucketName

Required

The bucket name. It must be URL encoded.

Header Parameters

x-amz-request-payer

Optional

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests.

Authentication

This operation uses the following authentication methods.

Bearer Authentication

Responses

200

Returns ListBucketResult of type(s) application/json

{
    "truncated": false,
    "continuationToken": "string",
    "nextContinuationToken": "string",
    "name": "string",
    "prefix": "string",
    "delimiter": "string",
    "encodingType": "string",
    "keyCount": 0,
    "maxKeys": 0,
    "commonPrefixes": [
        {
            "prefix": "string",
            "owner": {
                "id": "string",
                "displayName": "string"
            }
        }
    ],
    "objectBrief": [
        {
            "key": "string",
            "versionId": "string",
            "owner": {
                "id": "string",
                "displayName": "string"
            },
            "ownerId": "string",
            "storageClass": "string",
            "etag": "string",
            "size": 0,
            "lastModified": "string"
        }
    ],
    "startAfter": "string"
}

boolean

truncated

Optional

truncated

string

continuationToken

Optional

continuationToken

string

nextContinuationToken

Optional

nextContinuationToken