Class: Aws::S3::Types::GetObjectTorrentRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass GetObjectTorrentRequest data as a hash:

{
  bucket: "BucketName", # required
  key: "ObjectKey", # required
  request_payer: "requester", # accepts requester
  expected_bucket_owner: "AccountId",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

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

Returns:

  • (String)

6782
6783
6784
6785
6786
6787
6788
6789
# File 'lib/aws-sdk-s3/types.rb', line 6782

class GetObjectTorrentRequest < Struct.new(
  :bucket,
  :key,
  :request_payer,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#expected_bucket_ownerString

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code `403 Forbidden` (access denied).

Returns:

  • (String)

6782
6783
6784
6785
6786
6787
6788
6789
# File 'lib/aws-sdk-s3/types.rb', line 6782

class GetObjectTorrentRequest < Struct.new(
  :bucket,
  :key,
  :request_payer,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#keyString

The object key for which to get the information.

Returns:

  • (String)

6782
6783
6784
6785
6786
6787
6788
6789
# File 'lib/aws-sdk-s3/types.rb', line 6782

class GetObjectTorrentRequest < Struct.new(
  :bucket,
  :key,
  :request_payer,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#request_payerString

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:

  • (String)

6782
6783
6784
6785
6786
6787
6788
6789
# File 'lib/aws-sdk-s3/types.rb', line 6782

class GetObjectTorrentRequest < Struct.new(
  :bucket,
  :key,
  :request_payer,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end