head-bucket

Prev Next

Available in Classic and VPC

Get the properties of a bucket created in Ncloud Storage.

Commands

The command statement is as follows:

aws s3api head-bucket --bucket <value> [--options]

Parameter

The following describes the parameters.

Parameter Type Required Description Restrictions
--bucket <value> string Y Name of the target bucket to query -
--endpoint-url <value> string Y Specify the default URL for command calls. It is only available for the KR Region. See Ncloud Storage overview for call domain information.
--cli-input-json | --cli-input-yaml string N Enter arguments from the provided json or yaml string. You can't specify json and yaml together.
--generate-cli-skeleton <value> integer N Create a parameter template that can be used as input later without executing the API command. -
--debug boolean N Use debug logging. -
--no-verify-ssl boolean N Redefine the default behavior for validating SSL certificates. -
--no-paginate boolean N Disable automatic pagination, call only the first page for results. -
--output <value> string N Specify the format of response results. Available options
  • json
  • text
  • table
  • yaml
  • yaml-stream
--query <value> string N JMESPath query to use for filtering response data -
--profile <value> string N Use a specific profile in the credentials file. -
--region <value> string N Specify the Region. Only KR is supported.
--color <value> string N Set output color. Available options
  • on
  • off
  • auto
--no-sign-request boolean N Disable credential loading. -
--ca-bundle <value> string N Specify the CA certificate to use when verifying SSL certificates. -
--cli-read-timeout <value> int N Maximum read time; entering 0 changes it to a blocked status instead of a timeout. It is set to 60 seconds by default.
--cli-connect-timeout <value> int N Maximum connection time; entering 0 changes it to a blocked status instead of a timeout. It is set to 60 seconds by default.
--no-cli-pager boolean N Disable the CLI pager for response values. -
--cli-auto-prompt boolean N Enable automatic prompting for CLI input parameters. -
--no-cli-auto-prompt boolean N Disable automatic prompting for CLI input parameters. -

Permission

If a sub account user wants to use this command, they need the View/ListBucket action permission.

Examples

This section describes an example of calling and responding to the head-bucket command.

Get bucket properties

Call examples

You can get the properties of a bucket by specifying the bucket to query and calling the command. The following is a call example.

aws s3api head-bucket --bucket bucket-a --endpoint-url=https://kr.ncloudstorage.com

Response example

The response example is as follows:

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

Related commands

Related commands are as follows: