Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.S3.GetObjectTorrent

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

GetObject

Synopsis

data GetObjectTorrent = GetObjectTorrent' {
- expectedBucketOwner :: Maybe Text
- requestPayer :: Maybe RequestPayer
- bucket :: BucketName
- key :: ObjectKey
}
newGetObjectTorrent :: BucketName -> ObjectKey -> GetObjectTorrent
getObjectTorrent_expectedBucketOwner :: Lens' GetObjectTorrent (Maybe Text)
getObjectTorrent_requestPayer :: Lens' GetObjectTorrent (Maybe RequestPayer)
getObjectTorrent_bucket :: Lens' GetObjectTorrent BucketName
getObjectTorrent_key :: Lens' GetObjectTorrent ObjectKey
data GetObjectTorrentResponse = GetObjectTorrentResponse' {
- requestCharged :: Maybe RequestCharged
- httpStatus :: Int
- body :: ResponseBody
}
newGetObjectTorrentResponse :: Int -> ResponseBody -> GetObjectTorrentResponse
getObjectTorrentResponse_requestCharged :: Lens' GetObjectTorrentResponse (Maybe RequestCharged)
getObjectTorrentResponse_httpStatus :: Lens' GetObjectTorrentResponse Int
getObjectTorrentResponse_body :: Lens' GetObjectTorrentResponse ResponseBody

Creating a Request

data GetObjectTorrent Source #

See: newGetObjectTorrent smart constructor.

Constructors

GetObjectTorrent'

Fields

expectedBucketOwner :: Maybe Text
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).
requestPayer :: Maybe RequestPayer
bucket :: BucketName
The name of the bucket containing the object for which to get the torrent files.
key :: ObjectKey
The object key for which to get the information.

Instances

Instances details

ToHeaders GetObjectTorrent Source #
Instance details Defined in Amazonka.S3.GetObjectTorrent Methods toHeaders :: GetObjectTorrent -> [Header] #
ToPath GetObjectTorrent Source #
Instance details Defined in Amazonka.S3.GetObjectTorrent Methods toPath :: GetObjectTorrent -> ByteString #
ToQuery GetObjectTorrent Source #
Instance details Defined in Amazonka.S3.GetObjectTorrent Methods toQuery :: GetObjectTorrent -> QueryString #
AWSRequest GetObjectTorrent Source #
Instance details Defined in Amazonka.S3.GetObjectTorrent Associated Types type AWSResponse GetObjectTorrent # Methods request :: (Service -> Service) -> GetObjectTorrent -> Request GetObjectTorrent # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetObjectTorrent -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetObjectTorrent))) #
Generic GetObjectTorrent Source #
Instance details Defined in Amazonka.S3.GetObjectTorrent Associated Types type Rep GetObjectTorrent :: Type -> Type # Methods from :: GetObjectTorrent -> Rep GetObjectTorrent x # to :: Rep GetObjectTorrent x -> GetObjectTorrent #
Read GetObjectTorrent Source #
Instance details Defined in Amazonka.S3.GetObjectTorrent Methods readsPrec :: Int -> ReadS GetObjectTorrent # readList :: ReadS [GetObjectTorrent] # readPrec :: ReadPrec GetObjectTorrent # readListPrec :: ReadPrec [GetObjectTorrent] #
Show GetObjectTorrent Source #
Instance details Defined in Amazonka.S3.GetObjectTorrent Methods showsPrec :: Int -> GetObjectTorrent -> ShowS # show :: GetObjectTorrent -> String # showList :: [GetObjectTorrent] -> ShowS #
NFData GetObjectTorrent Source #
Instance details Defined in Amazonka.S3.GetObjectTorrent Methods rnf :: GetObjectTorrent -> () #
Eq GetObjectTorrent Source #
Instance details Defined in Amazonka.S3.GetObjectTorrent Methods (==) :: GetObjectTorrent -> GetObjectTorrent -> Bool # (/=) :: GetObjectTorrent -> GetObjectTorrent -> Bool #
Hashable GetObjectTorrent Source #
Instance details Defined in Amazonka.S3.GetObjectTorrent Methods hashWithSalt :: Int -> GetObjectTorrent -> Int # hash :: GetObjectTorrent -> Int #
type AWSResponse GetObjectTorrent Source #
Instance details Defined in Amazonka.S3.GetObjectTorrent type AWSResponse GetObjectTorrent = GetObjectTorrentResponse
type Rep GetObjectTorrent Source #
Instance details Defined in Amazonka.S3.GetObjectTorrent type Rep GetObjectTorrent = D1 ('MetaData "GetObjectTorrent" "Amazonka.S3.GetObjectTorrent" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "GetObjectTorrent'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "expectedBucketOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "requestPayer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestPayer))) :: (S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BucketName) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ObjectKey))))

newGetObjectTorrent Source #

Arguments

:: BucketName	`GetObjectTorrent`
-> ObjectKey	`GetObjectTorrent`
-> GetObjectTorrent

Create a value of GetObjectTorrent with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:expectedBucketOwner:GetObjectTorrent', getObjectTorrent_expectedBucketOwner - 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).

$sel:requestPayer:GetObjectTorrent', getObjectTorrent_requestPayer - Undocumented member.

GetObjectTorrent, getObjectTorrent_bucket - The name of the bucket containing the object for which to get the torrent files.

GetObjectTorrent, getObjectTorrent_key - The object key for which to get the information.

Request Lenses

getObjectTorrent_expectedBucketOwner :: Lens' GetObjectTorrent (Maybe Text) Source #

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).

getObjectTorrent_requestPayer :: Lens' GetObjectTorrent (Maybe RequestPayer) Source #

Undocumented member.

getObjectTorrent_bucket :: Lens' GetObjectTorrent BucketName Source #

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

getObjectTorrent_key :: Lens' GetObjectTorrent ObjectKey Source #

The object key for which to get the information.

Destructuring the Response

data GetObjectTorrentResponse Source #

See: newGetObjectTorrentResponse smart constructor.

Constructors

GetObjectTorrentResponse'
Fields requestCharged :: Maybe RequestCharged httpStatus :: Int The response's http status code. body :: ResponseBody A Bencoded dictionary as defined by the BitTorrent specification

Instances

Instances details

Generic GetObjectTorrentResponse Source #
Instance details Defined in Amazonka.S3.GetObjectTorrent Associated Types type Rep GetObjectTorrentResponse :: Type -> Type # Methods from :: GetObjectTorrentResponse -> Rep GetObjectTorrentResponse x # to :: Rep GetObjectTorrentResponse x -> GetObjectTorrentResponse #
Show GetObjectTorrentResponse Source #
Instance details Defined in Amazonka.S3.GetObjectTorrent Methods showsPrec :: Int -> GetObjectTorrentResponse -> ShowS # show :: GetObjectTorrentResponse -> String # showList :: [GetObjectTorrentResponse] -> ShowS #
type Rep GetObjectTorrentResponse Source #
Instance details Defined in Amazonka.S3.GetObjectTorrent type Rep GetObjectTorrentResponse = D1 ('MetaData "GetObjectTorrentResponse" "Amazonka.S3.GetObjectTorrent" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "GetObjectTorrentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "requestCharged") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestCharged)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResponseBody))))

newGetObjectTorrentResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetObjectTorrentResponse'`
-> ResponseBody	`$sel:body:GetObjectTorrentResponse'`
-> GetObjectTorrentResponse

Create a value of GetObjectTorrentResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:requestCharged:GetObjectTorrentResponse', getObjectTorrentResponse_requestCharged - Undocumented member.

$sel:httpStatus:GetObjectTorrentResponse', getObjectTorrentResponse_httpStatus - The response's http status code.

$sel:body:GetObjectTorrentResponse', getObjectTorrentResponse_body - A Bencoded dictionary as defined by the BitTorrent specification

Response Lenses

getObjectTorrentResponse_requestCharged :: Lens' GetObjectTorrentResponse (Maybe RequestCharged) Source #

Undocumented member.

getObjectTorrentResponse_httpStatus :: Lens' GetObjectTorrentResponse Int Source #

The response's http status code.

getObjectTorrentResponse_body :: Lens' GetObjectTorrentResponse ResponseBody Source #

A Bencoded dictionary as defined by the BitTorrent specification