Downloading an object

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

1. See the description of the CLI command for downloading an object from a bucket:

   yc storage s3api get-object --help
   

2. Get a list of buckets in the default folder:

   yc storage bucket list
   

   Result:

   +------------------+----------------------+-------------+-----------------------+---------------------+
   |       NAME       |      FOLDER ID       |  MAX SIZE   | DEFAULT STORAGE CLASS |     CREATED AT      |
   +------------------+----------------------+-------------+-----------------------+---------------------+
   | first-bucket     | b1gmit33ngp6******** | 53687091200 | STANDARD              | 2022-12-16 13:58:18 |
   +------------------+----------------------+-------------+-----------------------+---------------------+
   

3. Run this command:

   yc storage s3api get-object \
     --bucket <bucket_name> \
     --key <object_key> \
     <download_path>
   

   Where:

   • --bucket: Name of your bucket.
   • --key: Object key.
   • <download_path>: Local download path.

   Result:

   etag: '"d41d8cd98f00b204e9800998********"'
   request_id: af194b83********
   accept_ranges: bytes
   content_type: application/octet-stream
   last_modified_at: "2024-10-08T12:36:36Z"
   server_side_encryption: aws:kms
   sse_kms_key_id: abj497vtg3h0********
   

If you do not have the AWS CLI yet, install and configure it.

Downloading a single object

aws s3 cp \
  --endpoint-url=https://storage.yandexcloud.net \
  s3://<bucket_name>/<object_key> \
  <local_path>

Where:

• --endpoint-url: Object Storage endpoint.
• <bucket_name>: Name of the bucket you want to download the objects from.
• <object_key>: Key of the object you want to download.
• <local_path>: Path to the directory to save the downloaded object to. For example, ~/downloads/.

Downloading a directory (all objects with a specified prefix)

For more information about folders in Object Storage, see Directory.

aws s3 cp \
  --endpoint-url=https://storage.yandexcloud.net \
  --recursive \
  s3://<bucket_name>/<prefix>/ \
  <local_path>

Where:

• --endpoint-url: Object Storage endpoint.
• --recursive: Parameter for downloading all objects with the specified prefix.
• <bucket_name>: Name of the bucket you want to download the objects from.
• <prefix>: Prefix (folder) of the objects you want to download, e.g., test/folder.
• <local_path>: Path to the directory to save the downloaded objects to, e.g., ~/downloads/.

Downloading all objects from a bucket

aws s3 cp \
  --endpoint-url=https://storage.yandexcloud.net \
  --recursive \
  s3://<bucket_name> \
  <local_path>

Where:

• --endpoint-url: Object Storage endpoint.
• --recursive: Parameter for downloading all objects from the bucket to a local folder.
• <bucket_name>: Name of the bucket you want to download the objects from.
• <local_path>: Path to the directory to save the downloaded objects to. For example, ~/downloads/.

aws s3 cp is a high-level command with limited functionality. For more information, see the AWS CLI reference.

You can download bucket objects selectively using the aws s3api command and a JMESPath query template. To download objects using a query template, run this command:

• Bash:

  aws s3api list-objects \
      --endpoint-url https://storage.yandexcloud.net \
      --bucket <bucket_name> \
      --query '<query>' \
      --output text | xargs -I {} aws s3api get-object --endpoint-url https://storage.yandexcloud.net --bucket <bucket_name> --key {} <local_path>{}
  

  Where:

  • --endpoint-url: Object Storage endpoint.
  • --bucket: Name of the bucket you want to download the objects from.
  • --query: Query in JMESPath format.
  • <local_path>: Path to the directory to save the downloaded objects to. For example, ~/downloads/.

  Here is an example of a command that downloads all objects whose filenames start with date-20231002 from the sample-bucket bucket to the ~/downloads/ local folder:

  aws s3api list-objects \
    --endpoint-url https://storage.yandexcloud.net \
    --bucket sample-bucket \
    --query 'Contents[?starts_with(Key, `date-20231002`) == `true`].[Key]' \
    --output text | xargs -I {} aws s3api get-object --endpoint-url https://storage.yandexcloud.net --bucket sample-bucket --key {} ~/downloads/{}
  

• PowerShell:

  Foreach($x in (aws s3api list-objects `
    --endpoint-url https://storage.yandexcloud.net `
    --bucket <bucket_name> `
    --query '<query>' `
    --output text)) `
    {aws s3api get-object --endpoint-url https://storage.yandexcloud.net --bucket <bucket_name> --key $x <local_path>$x}
  

  Where:

  • --endpoint-url: Object Storage endpoint.
  • --bucket: Name of the bucket you want to download the objects from.
  • --query: Query in JMESPath format.
  • <local_path>: Path to the directory to save the downloaded objects to. For example, d:\downloads\.

  Here is an example of a command that downloads all objects whose filenames start with date-20231002 from the sample-bucket bucket to the d:\downloads\ local folder:

  Foreach($x in (aws s3api list-objects `
    --endpoint-url https://storage.yandexcloud.net `
    --bucket sample-bucket `
    --query 'Contents[?starts_with(Key, `date-20231002`) == `true`].[Key]' `
    --output text)) `
    {aws s3api get-object --endpoint-url https://storage.yandexcloud.net --bucket sample-bucket --key $x d:\downloads\$x}
  

To download an object, use the get S3 API method.