list-objects

The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

Available in Classic and VPC

Get the list of objects stored in Ncloud Storage.

Commands

The command statement is as follows:

aws s3api list-objects --bucket <value> [--options]

Note

We recommend using the latest version, list-objects-v2.

Parameter

The following describes the parameters.

Parameter	Type	Required	Description	Restrictions
--bucket <value>	string	Y	Name of the target bucket to query the stored object	-
--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.
--prefix	string	N	Specify a specific prefix to query.	-
--starting-token <value>	string	N	Specify the location to start the call from.	-
--page-size <value>	integer	N		-
--max-items <value>	integer	N	Specify the number of listings for each response.	Up to 1000 supported
--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 list-objects command.

Get object list

Call examples

You can query the list of objects stored in a bucket by calling the list-objects command. The following is a call example.

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

Response example

The response example is as follows:

{
    "Contents": [
        {
            "Key": "img/image.png",
            "LastModified": "2025-03-25T00:51:18+00:00",
            "ETag": "\"27447060a25da72de9ec3094a1f30cb6\"",
            "Size": 79238,
            "StorageClass": "STANDARD"
        },
        {
            "Key": "img/image2.png",
            "LastModified": "2025-03-25T06:20:52+00:00",
            "ETag": "\"d2e370952633b9b9cf503eefa8b460bb\"",
            "Size": 81115,
            "StorageClass": "DEEP_ARCHIVE"
        }
    ],
    "RequestCharged": null
}

Related commands

Related commands are as follows:

Documentation Index