Network.AWS.S3.SelectObjectContent

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.

Creating a Request

selectObjectContent

Arguments

:: BucketName

socBucket

-> ObjectKey

socKey

-> Text

socExpression

-> ExpressionType

socExpressionType

-> InputSerialization

socInputSerialization

-> OutputSerialization

socOutputSerialization

-> 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:

• socSSECustomerAlgorithm - Server-Side Encryption (Using Customer-Provided Encryption Keys
• socSSECustomerKey - Server-Side Encryption (Using Customer-Provided Encryption Keys
• socRequestProgress - Specifies if periodic request progress information should be enabled.
• socSSECustomerKeyMD5 - Server-Side Encryption (Using Customer-Provided Encryption Keys
• socBucket - The S3 Bucket.
• socKey - The Object Key.
• socExpression - The expression that is used to query the object.
• socExpressionType - The type of the provided expression (e.g., SQL).
• socInputSerialization - Describes the format of the data in the object that is being queried.
• socOutputSerialization - Describes the format of the data that you want Amazon S3 to return in response.

data SelectObjectContent

S3Select API Documentation

See: selectObjectContent smart constructor.

Instances

Eq SelectObjectContent

Methods

(==) :: SelectObjectContent -> SelectObjectContent -> Bool

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

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

Methods

showsPrec :: Int -> SelectObjectContent -> ShowS

show :: SelectObjectContent -> String

showList :: [SelectObjectContent] -> ShowS

Generic SelectObjectContent

Associated Types

type Rep SelectObjectContent :: * -> *

Methods

from :: SelectObjectContent -> Rep SelectObjectContent x

to :: Rep SelectObjectContent x -> SelectObjectContent

Hashable SelectObjectContent

Methods

hashWithSalt :: Int -> SelectObjectContent -> Int

hash :: SelectObjectContent -> Int

NFData SelectObjectContent

Methods

rnf :: SelectObjectContent -> ()

AWSRequest SelectObjectContent

Associated Types

type Rs SelectObjectContent :: *

Methods

request :: SelectObjectContent -> Request SelectObjectContent

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

ToElement SelectObjectContent

Methods

toElement :: SelectObjectContent -> Element

ToXML SelectObjectContent

Methods

toXML :: SelectObjectContent -> XML

ToHeaders SelectObjectContent

Methods

toHeaders :: SelectObjectContent -> [Header]

ToPath SelectObjectContent

Methods

toPath :: SelectObjectContent -> ByteString

ToQuery SelectObjectContent

Methods

toQuery :: SelectObjectContent -> QueryString

type Rep SelectObjectContent

type Rep SelectObjectContent = D1 * (MetaData "SelectObjectContent" "Network.AWS.S3.SelectObjectContent" "amazonka-s3-1.6.0-AdElsico9UIGqHgrDvALBR" 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

type Rs SelectObjectContent = SelectObjectContentResponse

Request Lenses

socSSECustomerAlgorithm :: Lens' SelectObjectContent (Maybe Text)

Server-Side Encryption (Using Customer-Provided Encryption Keys

socSSECustomerKey :: Lens' SelectObjectContent (Maybe Text)

Server-Side Encryption (Using Customer-Provided Encryption Keys

socRequestProgress :: Lens' SelectObjectContent (Maybe RequestProgress)

Specifies if periodic request progress information should be enabled.

socSSECustomerKeyMD5 :: Lens' SelectObjectContent (Maybe Text)

Server-Side Encryption (Using Customer-Provided Encryption Keys

socBucket :: Lens' SelectObjectContent BucketName

The S3 Bucket.

socKey :: Lens' SelectObjectContent ObjectKey

The Object Key.

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

Arguments

:: Int

socrsResponseStatus

-> 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:

• socrsPayload - Undocumented member.
• socrsResponseStatus - -- | The response status code.

data SelectObjectContentResponse

See: selectObjectContentResponse smart constructor.

Instances

Eq SelectObjectContentResponse

Methods

(==) :: SelectObjectContentResponse -> SelectObjectContentResponse -> Bool

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

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

Methods

readsPrec :: Int -> ReadS SelectObjectContentResponse

readList :: ReadS [SelectObjectContentResponse]

readPrec :: ReadPrec SelectObjectContentResponse

readListPrec :: ReadPrec [SelectObjectContentResponse]

Show SelectObjectContentResponse

Methods

showsPrec :: Int -> SelectObjectContentResponse -> ShowS

show :: SelectObjectContentResponse -> String

showList :: [SelectObjectContentResponse] -> ShowS

Generic SelectObjectContentResponse

Associated Types

type Rep SelectObjectContentResponse :: * -> *

Methods

from :: SelectObjectContentResponse -> Rep SelectObjectContentResponse x

to :: Rep SelectObjectContentResponse x -> SelectObjectContentResponse

NFData SelectObjectContentResponse

Methods

rnf :: SelectObjectContentResponse -> ()

type Rep SelectObjectContentResponse

type Rep SelectObjectContentResponse = D1 * (MetaData "SelectObjectContentResponse" "Network.AWS.S3.SelectObjectContent" "amazonka-s3-1.6.0-AdElsico9UIGqHgrDvALBR" 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

socrsPayload :: Lens' SelectObjectContentResponse (Maybe SelectObjectContentEventStream)

Undocumented member.

socrsResponseStatus :: Lens' SelectObjectContentResponse Int

• - | The response status code.