amazonka-mediastore-dataplane-1.6.0: Amazon Elemental MediaStore Data Plane SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.MediaStoreData.PutObject

Contents

Description

Uploads an object to the specified path. Object sizes are limited to 10 MB.

Synopsis

Creating a Request

putObject Source #

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

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

  • poStorageClass - Indicates the storage class of a Put request. Defaults to high-performance temporal storage class, and objects are persisted into durable storage shortly after being received.
  • poCacheControl - 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 at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9 . Headers with a custom user-defined value are also accepted.
  • poContentType - The content type of the object.
  • poPath - 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.
  • poBody - The bytes to be stored.

data PutObject Source #

See: putObject smart constructor.

Instances

Show PutObject Source # 
Generic PutObject Source # 

Associated Types

type Rep PutObject :: * -> * #

AWSRequest PutObject Source # 
ToBody PutObject Source # 

Methods

toBody :: PutObject -> RqBody #

ToHeaders PutObject Source # 

Methods

toHeaders :: PutObject -> [Header] #

ToPath PutObject Source # 
ToQuery PutObject Source # 
type Rep PutObject Source # 
type Rep PutObject = D1 * (MetaData "PutObject" "Network.AWS.MediaStoreData.PutObject" "amazonka-mediastore-dataplane-1.6.0-Kk3OG8iEUhA6OSUNkx09QK" False) (C1 * (MetaCons "PutObject'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_poStorageClass") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe StorageClass))) (S1 * (MetaSel (Just Symbol "_poCacheControl") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_poContentType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_poPath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_poBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * HashedBody))))))
type Rs PutObject Source # 

Request Lenses

poStorageClass :: Lens' PutObject (Maybe StorageClass) Source #

Indicates the storage class of a Put request. Defaults to high-performance temporal storage class, and objects are persisted into durable storage shortly after being received.

poCacheControl :: Lens' PutObject (Maybe Text) Source #

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 at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9 . Headers with a custom user-defined value are also accepted.

poContentType :: Lens' PutObject (Maybe Text) Source #

The content type of the object.

poPath :: Lens' PutObject Text Source #

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.

poBody :: Lens' PutObject HashedBody Source #

The bytes to be stored.

Destructuring the Response

putObjectResponse Source #

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

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

data PutObjectResponse Source #

See: putObjectResponse smart constructor.

Instances

Eq PutObjectResponse Source # 
Data PutObjectResponse Source # 

Methods

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

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

toConstr :: PutObjectResponse -> Constr #

dataTypeOf :: PutObjectResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> PutObjectResponse -> PutObjectResponse #

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

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

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

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

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

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

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

Read PutObjectResponse Source # 
Show PutObjectResponse Source # 
Generic PutObjectResponse Source # 
NFData PutObjectResponse Source # 

Methods

rnf :: PutObjectResponse -> () #

type Rep PutObjectResponse Source # 
type Rep PutObjectResponse = D1 * (MetaData "PutObjectResponse" "Network.AWS.MediaStoreData.PutObject" "amazonka-mediastore-dataplane-1.6.0-Kk3OG8iEUhA6OSUNkx09QK" False) (C1 * (MetaCons "PutObjectResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_porsETag") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_porsStorageClass") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe StorageClass)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_porsContentSHA256") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_porsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

porsETag :: Lens' PutObjectResponse (Maybe Text) Source #

Unique identifier of the object in the container.

porsStorageClass :: Lens' PutObjectResponse (Maybe StorageClass) Source #

The storage class where the object was persisted. Should be “Temporal”.

porsContentSHA256 :: Lens' PutObjectResponse (Maybe Text) Source #

The SHA256 digest of the object that is persisted.

porsResponseStatus :: Lens' PutObjectResponse Int Source #

  • - | The response status code.