Network.AWS.MediaStoreData.GetObject

Downloads the object at the specified path.

Creating a Request

getObject

Arguments

:: Text

goPath

-> GetObject

Creates a value of GetObject with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• goRange - The range bytes of an object to retrieve. For more information about the Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35 .
• goPath - The path (including the file name) where the object is stored in the container. Format: namenamename For example, to upload the file mlaw.avi to the folder path premiumcanada in the container movies , enter the path premiumcanadamlaw.avi . Do not include the container name in this path. If the path includes any folders that don't exist yet, the service creates them. For example, suppose you have an existing premium/usa subfolder. If you specify premium/canada , the service creates a canada subfolder in the premium folder. You then have two subfolders, usa and canada , in the premium folder. There is no correlation between the path to the source and the path (folders) in the container in AWS Elemental MediaStore. For more information about folders and how they exist in a container, see the AWS Elemental MediaStore User Guide . The file name is the name that is assigned to the file that you upload. The file can have the same name inside and outside of AWS Elemental MediaStore, or it can have the same name. The file name can include or omit an extension.

data GetObject

See: getObject smart constructor.

Instances

Eq GetObject

Methods

(==) :: GetObject -> GetObject -> Bool

(/=) :: GetObject -> GetObject -> Bool

Data GetObject

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetObject -> c GetObject

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetObject

toConstr :: GetObject -> Constr

dataTypeOf :: GetObject -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetObject)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetObject)

gmapT :: (forall b. Data b => b -> b) -> GetObject -> GetObject

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetObject -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetObject -> r

gmapQ :: (forall d. Data d => d -> u) -> GetObject -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetObject -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetObject -> m GetObject

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetObject -> m GetObject

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetObject -> m GetObject

Read GetObject

Methods

readsPrec :: Int -> ReadS GetObject

readList :: ReadS [GetObject]

readPrec :: ReadPrec GetObject

readListPrec :: ReadPrec [GetObject]

Show GetObject

Methods

showsPrec :: Int -> GetObject -> ShowS

show :: GetObject -> String

showList :: [GetObject] -> ShowS

Generic GetObject

Associated Types

type Rep GetObject :: * -> *

Methods

from :: GetObject -> Rep GetObject x

to :: Rep GetObject x -> GetObject

Hashable GetObject

Methods

hashWithSalt :: Int -> GetObject -> Int

hash :: GetObject -> Int

NFData GetObject

Methods

rnf :: GetObject -> ()

AWSRequest GetObject

Associated Types

type Rs GetObject :: *

Methods

request :: GetObject -> Request GetObject

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * GetObject -> ClientResponse -> m (Response GetObject)

ToHeaders GetObject

Methods

toHeaders :: GetObject -> [Header]

ToPath GetObject

Methods

toPath :: GetObject -> ByteString

ToQuery GetObject

Methods

toQuery :: GetObject -> QueryString

type Rep GetObject

type Rep GetObject = D1 * (MetaData "GetObject" "Network.AWS.MediaStoreData.GetObject" "amazonka-mediastore-dataplane-1.6.0-Kk3OG8iEUhA6OSUNkx09QK" False) (C1 * (MetaCons "GetObject'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_goRange") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_goPath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))

type Rs GetObject

type Rs GetObject = GetObjectResponse

Request Lenses

goRange :: Lens' GetObject (Maybe Text)

The range bytes of an object to retrieve. For more information about the Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35 .

goPath :: Lens' GetObject Text

The path (including the file name) where the object is stored in the container. Format: namenamename For example, to upload the file mlaw.avi to the folder path premiumcanada in the container movies , enter the path premiumcanadamlaw.avi . Do not include the container name in this path. If the path includes any folders that don't exist yet, the service creates them. For example, suppose you have an existing premium/usa subfolder. If you specify premium/canada , the service creates a canada subfolder in the premium folder. You then have two subfolders, usa and canada , in the premium folder. There is no correlation between the path to the source and the path (folders) in the container in AWS Elemental MediaStore. For more information about folders and how they exist in a container, see the AWS Elemental MediaStore User Guide . The file name is the name that is assigned to the file that you upload. The file can have the same name inside and outside of AWS Elemental MediaStore, or it can have the same name. The file name can include or omit an extension.

Destructuring the Response

getObjectResponse

Arguments

:: Int

gorsStatusCode

-> RsBody

gorsBody

-> GetObjectResponse

Creates a value of GetObjectResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gorsETag - The ETag that represents a unique instance of the object.
• gorsContentLength - The length of the object in bytes.
• gorsCacheControl - An optional CacheControl header that allows the caller to control the object's cache behavior. Headers can be passed in as specified in the HTTP spec at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9 . Headers with a custom user-defined value are also accepted.
• gorsLastModified - The date and time that the object was last modified.
• gorsContentRange - The range of bytes to retrieve.
• gorsContentType - The content type of the object.
• gorsStatusCode - The HTML status code of the request. Status codes ranging from 200 to 299 indicate success. All other status codes indicate the type of error that occurred.
• gorsBody - The bytes of the object.

data GetObjectResponse

See: getObjectResponse smart constructor.

Instances

Show GetObjectResponse

Methods

showsPrec :: Int -> GetObjectResponse -> ShowS

show :: GetObjectResponse -> String

showList :: [GetObjectResponse] -> ShowS

Generic GetObjectResponse

Associated Types

type Rep GetObjectResponse :: * -> *

Methods

from :: GetObjectResponse -> Rep GetObjectResponse x

to :: Rep GetObjectResponse x -> GetObjectResponse

type Rep GetObjectResponse

type Rep GetObjectResponse = D1 * (MetaData "GetObjectResponse" "Network.AWS.MediaStoreData.GetObject" "amazonka-mediastore-dataplane-1.6.0-Kk3OG8iEUhA6OSUNkx09QK" False) (C1 * (MetaCons "GetObjectResponse'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gorsETag") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gorsContentLength") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gorsCacheControl") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gorsLastModified") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gorsContentRange") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gorsContentType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gorsStatusCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_gorsBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * RsBody))))))

Response Lenses

gorsETag :: Lens' GetObjectResponse (Maybe Text)

The ETag that represents a unique instance of the object.

gorsContentLength :: Lens' GetObjectResponse (Maybe Natural)

The length of the object in bytes.

gorsCacheControl :: Lens' GetObjectResponse (Maybe Text)

An optional CacheControl header that allows the caller to control the object's cache behavior. Headers can be passed in as specified in the HTTP spec at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9 . Headers with a custom user-defined value are also accepted.

gorsLastModified :: Lens' GetObjectResponse (Maybe UTCTime)

The date and time that the object was last modified.

gorsContentRange :: Lens' GetObjectResponse (Maybe Text)

The range of bytes to retrieve.

gorsContentType :: Lens' GetObjectResponse (Maybe Text)

The content type of the object.

gorsStatusCode :: Lens' GetObjectResponse Int

The HTML status code of the request. Status codes ranging from 200 to 299 indicate success. All other status codes indicate the type of error that occurred.

gorsBody :: Lens' GetObjectResponse RsBody

The bytes of the object.