amazonka-s3-1.6.0: Amazon Simple Storage Service 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.S3.SelectObjectContent

Contents

Description

This operation filters the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. In the request, along with the SQL expression, you must also specify a data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response.

Synopsis

Creating a Request

selectObjectContent #

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

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

data SelectObjectContent #

Instances

Eq SelectObjectContent # 
Data SelectObjectContent # 

Methods

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

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

toConstr :: SelectObjectContent -> Constr #

dataTypeOf :: SelectObjectContent -> DataType #

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

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

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

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

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

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

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

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

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

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

Show SelectObjectContent # 
Generic SelectObjectContent # 
Hashable SelectObjectContent # 
NFData SelectObjectContent # 

Methods

rnf :: SelectObjectContent -> () #

AWSRequest SelectObjectContent # 
ToElement SelectObjectContent # 
ToXML SelectObjectContent # 
ToHeaders SelectObjectContent # 
ToPath SelectObjectContent # 
ToQuery SelectObjectContent # 
type Rep SelectObjectContent # 
type Rep SelectObjectContent = D1 * (MetaData "SelectObjectContent" "Network.AWS.S3.SelectObjectContent" "amazonka-s3-1.6.0-7IU4ob52e2UJs8PzXUUtYL" False) (C1 * (MetaCons "SelectObjectContent'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_socSSECustomerAlgorithm") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_socSSECustomerKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Sensitive Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_socRequestProgress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe RequestProgress))) ((:*:) * (S1 * (MetaSel (Just Symbol "_socSSECustomerKeyMD5") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_socBucket") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * BucketName))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_socKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ObjectKey)) (S1 * (MetaSel (Just Symbol "_socExpression") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_socExpressionType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ExpressionType)) ((:*:) * (S1 * (MetaSel (Just Symbol "_socInputSerialization") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * InputSerialization)) (S1 * (MetaSel (Just Symbol "_socOutputSerialization") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * OutputSerialization)))))))
type Rs SelectObjectContent # 

Request Lenses

socRequestProgress :: Lens' SelectObjectContent (Maybe RequestProgress) #

Specifies if periodic request progress information should be enabled.

socExpression :: Lens' SelectObjectContent Text #

The expression that is used to query the object.

socExpressionType :: Lens' SelectObjectContent ExpressionType #

The type of the provided expression (e.g., SQL).

socInputSerialization :: Lens' SelectObjectContent InputSerialization #

Describes the format of the data in the object that is being queried.

socOutputSerialization :: Lens' SelectObjectContent OutputSerialization #

Describes the format of the data that you want Amazon S3 to return in response.

Destructuring the Response

selectObjectContentResponse #

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

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

data SelectObjectContentResponse #

See: selectObjectContentResponse smart constructor.

Instances

Eq SelectObjectContentResponse # 
Data SelectObjectContentResponse # 

Methods

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

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

toConstr :: SelectObjectContentResponse -> Constr #

dataTypeOf :: SelectObjectContentResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read SelectObjectContentResponse # 
Show SelectObjectContentResponse # 
Generic SelectObjectContentResponse # 
NFData SelectObjectContentResponse # 
type Rep SelectObjectContentResponse # 
type Rep SelectObjectContentResponse = D1 * (MetaData "SelectObjectContentResponse" "Network.AWS.S3.SelectObjectContent" "amazonka-s3-1.6.0-7IU4ob52e2UJs8PzXUUtYL" False) (C1 * (MetaCons "SelectObjectContentResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_socrsPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe SelectObjectContentEventStream))) (S1 * (MetaSel (Just Symbol "_socrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses