Available in Classic and VPC
Get the metadata (attributes) of an object stored in a Ncloud Storage bucket.
Commands
The command statement is as follows:
aws s3api get-object-attributes --bucket <value> --key <value> --object-attributes <value> [--options]
Parameter
The following describes the parameters.
| Parameter | Type | Required | Description | Restrictions |
|---|---|---|---|---|
| --bucket <value> | string | Y | Target bucket where the object is stored | - |
| --key <value> | string | Y | Name of the object whose attribute to query | - |
| --object-attributes <value> | list | Y | List of object attributes to retrieve | Valid values
|
| --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. |
| --version-id <value> | string | N | Specify the version ID of the object to retrieve. | - |
| --max-parts <value> | integer | N | Specify the maximum number of parts to include in the response. | 0-2,147,483,647, default is 1000. |
| --part-number-marker <value> | integer | N | Specify the part number to use as the starting point for the part query. | 0~2,147,483,647 |
| --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
|
| --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
|
| --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. | - |
| --sse-customer-algorithm <value> | string | N | Specify user encryption algorithm. | AES256 |
| --sse-customer-key <value> | string | N | Specify a user-provided encryption key. | - |
| --sse-customer-key-md5 <value> | string | N | Specify the MD5 value of the user-provided encryption key. | - |
Permissions
Sub account users must have the View/GetObject and View/GetObjectAttributes action permissions to use this command. To query a specific version (--version-id), the View/GetObjectVersion and View/GetObjectVersionAttributes action permissions are required.
Examples
This section describes examples of calls and responses for the get-object-attributes command.
Get object attributes
Call examples
If you specify attributes with --object-attributes, you can retrieve the checksum and part information of a multipart object as well. The following is a call example.
aws s3api get-object-attributes --bucket bucket-a --key multipart-object.bin --object-attributes ETag ObjectSize StorageClass Checksum ObjectParts --endpoint-url=https://kr.ncloudstorage.com
Response example
The response example is as follows:
{
"LastModified": "2025-04-23T01:55:37+00:00",
"ETag": "******",
"Checksum": {
"ChecksumSHA256": "******",
"ChecksumType": "COMPOSITE"
},
"ObjectParts": {
"TotalPartsCount": 2,
"PartNumberMarker": 0,
"NextPartNumberMarker": 0,
"MaxParts": 1000,
"IsTruncated": false,
"Parts": [
{
"PartNumber": 1,
"Size": 512
},
{
"PartNumber": 2,
"Size": 512
}
]
},
"StorageClass": "STANDARD",
"ObjectSize": 1024
}
Related commands
Related commands are as follows: