paws.storage (version 0.1.12)

s3_get_object_torrent: Returns torrent files from a bucket

Description

Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files. For more information about BitTorrent, see Using BitTorrent with Amazon S3.

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 action is not supported by Amazon S3 on Outposts.

The following operation is related to get_object_torrent:

• get_object

Usage

s3_get_object_torrent(Bucket, Key, RequestPayer, ExpectedBucketOwner)

Value

A list with the following syntax:

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

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

ExpectedBucketOwner

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Request syntax

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

Examples

if (FALSE) {
# The following example retrieves torrent files of an object.
svc$get_object_torrent(
  Bucket = "examplebucket",
  Key = "HappyFace.jpg"
)
}