View a markdown version of this page

Use ListObjects with a CLI - Amazon Simple Storage Service

Use ListObjects with a CLI

The following code examples show how to use ListObjects.

Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:

CLI
AWS CLI

To list the objects in a bucket

The following list-objects example displays the names of all the objects in the specified bucket.

aws s3api list-objects \
    --bucket amzn-s3-demo-bucket \
    --query 'Contents[].{Key: Key, Size: Size}'

Output:

[
    {
        "Key": "dir/my_data",
        "Size": 20000
    },
    {
        "Key": "dir/my_images.tar.bz2",
        "Size": 3191
    }
]

The example uses the --query argument to filter the output of list-objects down to the key value and size for each object

For more information, see Listing object keys programmatically in the Amazon S3 User Guide.

  • For API details, see ListObjects in AWS CLI Command Reference.

PowerShell
Tools for PowerShell V4

Example 1: This command retrieves the information about all of the items in the bucket "test-files".

Get-S3Object -BucketName amzn-s3-demo-bucket

Example 2: This command retrieves the information about the item "sample.txt" from bucket "test-files".

Get-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt

Example 3: This command retrieves the information about all items with the prefix "sample" from bucket "test-files".

Get-S3Object -BucketName amzn-s3-demo-bucket -KeyPrefix sample

  • For API details, see ListObjects in AWS Tools for PowerShell Cmdlet Reference (V4).

Tools for PowerShell V5

Example 1: This command retrieves the information about all of the items in the bucket "amzn-s3-demo-bucket".

Get-S3Object -BucketName amzn-s3-demo-bucket

Example 2: This command retrieves the information about the item "sample.txt" from bucket "amzn-s3-demo-bucket".

Get-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt

Example 3: This command retrieves the information about all items with the prefix "sample" from bucket "amzn-s3-demo-bucket".

Get-S3Object -BucketName amzn-s3-demo-bucket -KeyPrefix sample

  • For API details, see ListObjects in AWS Tools for PowerShell Cmdlet Reference (V5).

For a complete list of AWS SDK developer guides and code examples, see Developing with Amazon S3 using the AWS SDKs. This topic also includes information about getting started and details about previous SDK versions.