S3 / Client / get_object_torrent

get_object_torrent#

S3.Client.get_object_torrent(**kwargs)#

Note

This operation is not supported by directory buckets.

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

Note

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 GetObjectTorrent:

See also: AWS API Documentation

Request Syntax

response = client.get_object_torrent(
    Bucket='string',
    Key='string',
    RequestPayer='requester',
    ExpectedBucketOwner='string'
)
Parameters:

  • Bucket (string) –

    [REQUIRED]

    The name of the bucket containing the object for which to get the torrent files.

  • Key (string) –

    [REQUIRED]

    The object key for which to get the information.

  • RequestPayer (string) –

    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 corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

    Note

    This functionality is not supported for directory buckets.

  • ExpectedBucketOwner (string) – 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).

Return type:

dict

Returns:

Response Syntax

{
    'Body': StreamingBody(),
    'RequestCharged': 'requester'
}

Response Structure

  • (dict) –

    • Body (StreamingBody) –

      A Bencoded dictionary as defined by the BitTorrent specification

    • RequestCharged (string) –

      If present, indicates that the requester was successfully charged for the request.

      Note

      This functionality is not supported for directory buckets.

Examples

The following example retrieves torrent files of an object.

response = client.get_object_torrent(
    Bucket='examplebucket',
    Key='HappyFace.jpg',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}