Skip to content

Get Object Torrent

s3_get_object_torrent R Documentation

This operation is not supported for directory buckets

Description

This operation is not supported for directory buckets.

Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files.

You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using server-side encryption with a customer-provided encryption key.

To use GET, you must have READ access to the object.

This functionality is not supported for Amazon S3 on Outposts.

The following action is related to get_object_torrent:

  • get_object

You must URL encode any signed header values that contain spaces. For example, if your header value is ⁠my file.txt⁠, containing two spaces after my, you must URL encode this value to ⁠my%20%20file.txt⁠.

Usage

s3_get_object_torrent(Bucket, Key, RequestPayer, ExpectedBucketOwner)

Arguments

Bucket

[required] The name of the bucket containing the object for which to get the torrent files.
Key

[required] The object key for which to get the information.
RequestPayer

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for the corresponding charges. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.
ExpectedBucketOwner

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ⁠403 Forbidden⁠ (access denied).

Value

A list with the following syntax:

list(
  Body = raw,
  RequestCharged = "requester"
)

Request syntax

svc$get_object_torrent(
  Bucket = "string",
  Key = "string",
  RequestPayer = "requester",
  ExpectedBucketOwner = "string"
)

Examples

## Not run: 
# The following example retrieves torrent files of an object.
svc$get_object_torrent(
  Bucket = "examplebucket",
  Key = "HappyFace.jpg"
)

## End(Not run)