head-bucket

Prev Next

Available in Classic and VPC

Get the metadata of a Ncloud Storage bucket.

Note

For a Sub Account user to execute this command, they must have the View/ListBucket action permission.

Syntax

The head-bucket syntax is as follows:

aws s3api head-bucket \
    --bucket <bucket> \
    --endpoint-url <endpoint-url>

Options

This section describes the options available when running head-bucket.

Required options

The following options are required for head-bucket.

Options Type Required Description
--bucket String Required Bucket name

Common options

For information about the options common to all aws subcommands, see Ncloud Storage options.

Examples

If the request to retrieve the bucket's Region information is successful, the bucket's Region information is returned.

Command

The command example is as follows:

aws s3api head-bucket --bucket my-test-bucket \
    --endpoint-url=https://kr.ncloudstorage.com

Output

The output example is as follows:

{
    "BucketRegion": "kr",
    "AccessPointAlias": false
}

Related commands

Related commands are as follows: