import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint"; import { Command as $Command } from "@aws-sdk/smithy-client"; import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack, WithSdkStreamMixin as __WithSdkStreamMixin } from "@aws-sdk/types"; import { GetObjectTorrentOutput, GetObjectTorrentRequest } from "../models/models_0"; import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; /** * @public * * The input for {@link GetObjectTorrentCommand}. */ export interface GetObjectTorrentCommandInput extends GetObjectTorrentRequest { } /** * @public * * The output of {@link GetObjectTorrentCommand}. */ export interface GetObjectTorrentCommandOutput extends __WithSdkStreamMixin, __MetadataBearer { } /** * @public *

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 action is related to GetObjectTorrent:

* * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { S3Client, GetObjectTorrentCommand } from "@aws-sdk/client-s3"; // ES Modules import * // const { S3Client, GetObjectTorrentCommand } = require("@aws-sdk/client-s3"); // CommonJS import * const client = new S3Client(config); * const input = { // GetObjectTorrentRequest * Bucket: "STRING_VALUE", // required * Key: "STRING_VALUE", // required * RequestPayer: "requester", * ExpectedBucketOwner: "STRING_VALUE", * }; * const command = new GetObjectTorrentCommand(input); * const response = await client.send(command); * ``` * * @param GetObjectTorrentCommandInput - {@link GetObjectTorrentCommandInput} * @returns {@link GetObjectTorrentCommandOutput} * @see {@link GetObjectTorrentCommandInput} for command's `input` shape. * @see {@link GetObjectTorrentCommandOutput} for command's `response` shape. * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape. * * * @example To retrieve torrent files for an object * ```javascript * // The following example retrieves torrent files of an object. * const input = { * "Bucket": "examplebucket", * "Key": "HappyFace.jpg" * }; * const command = new GetObjectTorrentCommand(input); * await client.send(command); * // example id: to-retrieve-torrent-files-for-an-object-1481834115959 * ``` * */ export declare class GetObjectTorrentCommand extends $Command { readonly input: GetObjectTorrentCommandInput; static getEndpointParameterInstructions(): EndpointParameterInstructions; /** * @public */ constructor(input: GetObjectTorrentCommandInput); /** * @internal */ resolveMiddleware(clientStack: MiddlewareStack, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler; /** * @internal */ private serialize; /** * @internal */ private deserialize; }