Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SDB.Select

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

The Select operation returns a set of attributes for ItemNames that match the select expression. Select is similar to the standard SQL SELECT statement.

The total size of the response cannot exceed 1 MB in total size. Amazon SimpleDB automatically adjusts the number of items returned per page to enforce this limit. For example, if the client asks to retrieve 2500 items, but each individual item is 10 kB in size, the system returns 100 items and an appropriate NextToken so the client can access the next page of results.

For information on how to construct select expressions, see Using Select to Create Amazon SimpleDB Queries in the Developer Guide.

This operation returns paginated results.

Synopsis

data Select = Select' {
- consistentRead :: Maybe Bool
- nextToken :: Maybe Text
- selectExpression :: Text
}
newSelect :: Text -> Select
select_consistentRead :: Lens' Select (Maybe Bool)
select_nextToken :: Lens' Select (Maybe Text)
select_selectExpression :: Lens' Select Text
data SelectResponse = SelectResponse' {
- items :: Maybe [Item]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newSelectResponse :: Int -> SelectResponse
selectResponse_items :: Lens' SelectResponse (Maybe [Item])
selectResponse_nextToken :: Lens' SelectResponse (Maybe Text)
selectResponse_httpStatus :: Lens' SelectResponse Int

Creating a Request

data Select Source #

See: newSelect smart constructor.

Constructors

Select'

Fields

consistentRead :: Maybe Bool
Determines whether or not strong consistency should be enforced when data is read from SimpleDB. If true, any data previously written to SimpleDB will be returned. Otherwise, results will be consistent eventually, and the client may not see data that was written immediately before your read.
nextToken :: Maybe Text
A string informing Amazon SimpleDB where to start the next list of ItemNames.
selectExpression :: Text
The expression used to query the domain.

Instances

Instances details

Eq Select Source #
Instance details Defined in Amazonka.SDB.Select Methods (==) :: Select -> Select -> Bool # (/=) :: Select -> Select -> Bool #
Read Select Source #
Instance details Defined in Amazonka.SDB.Select Methods readsPrec :: Int -> ReadS Select # readList :: ReadS [Select] # readPrec :: ReadPrec Select # readListPrec :: ReadPrec [Select] #
Show Select Source #
Instance details Defined in Amazonka.SDB.Select Methods showsPrec :: Int -> Select -> ShowS # show :: Select -> String # showList :: [Select] -> ShowS #
Generic Select Source #
Instance details Defined in Amazonka.SDB.Select Associated Types type Rep Select :: Type -> Type # Methods from :: Select -> Rep Select x # to :: Rep Select x -> Select #
NFData Select Source #
Instance details Defined in Amazonka.SDB.Select Methods rnf :: Select -> () #
Hashable Select Source #
Instance details Defined in Amazonka.SDB.Select Methods hashWithSalt :: Int -> Select -> Int # hash :: Select -> Int #
AWSPager Select Source #
Instance details Defined in Amazonka.SDB.Select Methods page :: Select -> AWSResponse Select -> Maybe Select #
AWSRequest Select Source #
Instance details Defined in Amazonka.SDB.Select Associated Types type AWSResponse Select # Methods request :: Select -> Request Select # response :: MonadResource m => Logger -> Service -> Proxy Select -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse Select))) #
ToHeaders Select Source #
Instance details Defined in Amazonka.SDB.Select Methods toHeaders :: Select -> [Header] #
ToPath Select Source #
Instance details Defined in Amazonka.SDB.Select Methods toPath :: Select -> ByteString #
ToQuery Select Source #
Instance details Defined in Amazonka.SDB.Select Methods toQuery :: Select -> QueryString #
type Rep Select Source #
Instance details Defined in Amazonka.SDB.Select type Rep Select = D1 ('MetaData "Select" "Amazonka.SDB.Select" "libZSservicesZSamazonka-sdbZSamazonka-sdb" 'False) (C1 ('MetaCons "Select'" 'PrefixI 'True) (S1 ('MetaSel ('Just "consistentRead") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "selectExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse Select Source #
Instance details Defined in Amazonka.SDB.Select type AWSResponse Select = SelectResponse

newSelect Source #

Arguments

:: Text	`$sel:selectExpression:Select'`
-> Select

Create a value of Select 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:consistentRead:Select', select_consistentRead - Determines whether or not strong consistency should be enforced when data is read from SimpleDB. If true, any data previously written to SimpleDB will be returned. Otherwise, results will be consistent eventually, and the client may not see data that was written immediately before your read.

$sel:nextToken:Select', select_nextToken - A string informing Amazon SimpleDB where to start the next list of ItemNames.

$sel:selectExpression:Select', select_selectExpression - The expression used to query the domain.

Request Lenses

select_consistentRead :: Lens' Select (Maybe Bool) Source #

Determines whether or not strong consistency should be enforced when data is read from SimpleDB. If true, any data previously written to SimpleDB will be returned. Otherwise, results will be consistent eventually, and the client may not see data that was written immediately before your read.

select_nextToken :: Lens' Select (Maybe Text) Source #

A string informing Amazon SimpleDB where to start the next list of ItemNames.

select_selectExpression :: Lens' Select Text Source #

The expression used to query the domain.

Destructuring the Response

data SelectResponse Source #

See: newSelectResponse smart constructor.

Constructors

SelectResponse'
Fields items :: Maybe [Item] A list of items that match the select expression. nextToken :: Maybe Text An opaque token indicating that more items than `MaxNumberOfItems` were matched, the response size exceeded 1 megabyte, or the execution time exceeded 5 seconds. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq SelectResponse Source #
Instance details Defined in Amazonka.SDB.Select Methods (==) :: SelectResponse -> SelectResponse -> Bool # (/=) :: SelectResponse -> SelectResponse -> Bool #
Read SelectResponse Source #
Instance details Defined in Amazonka.SDB.Select Methods readsPrec :: Int -> ReadS SelectResponse # readList :: ReadS [SelectResponse] # readPrec :: ReadPrec SelectResponse # readListPrec :: ReadPrec [SelectResponse] #
Show SelectResponse Source #
Instance details Defined in Amazonka.SDB.Select Methods showsPrec :: Int -> SelectResponse -> ShowS # show :: SelectResponse -> String # showList :: [SelectResponse] -> ShowS #
Generic SelectResponse Source #
Instance details Defined in Amazonka.SDB.Select Associated Types type Rep SelectResponse :: Type -> Type # Methods from :: SelectResponse -> Rep SelectResponse x # to :: Rep SelectResponse x -> SelectResponse #
NFData SelectResponse Source #
Instance details Defined in Amazonka.SDB.Select Methods rnf :: SelectResponse -> () #
type Rep SelectResponse Source #
Instance details Defined in Amazonka.SDB.Select type Rep SelectResponse = D1 ('MetaData "SelectResponse" "Amazonka.SDB.Select" "libZSservicesZSamazonka-sdbZSamazonka-sdb" 'False) (C1 ('MetaCons "SelectResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Item])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSelectResponse Source #

Arguments

:: Int	`$sel:httpStatus:SelectResponse'`
-> SelectResponse

Create a value of SelectResponse 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:items:SelectResponse', selectResponse_items - A list of items that match the select expression.

$sel:nextToken:Select', selectResponse_nextToken - An opaque token indicating that more items than MaxNumberOfItems were matched, the response size exceeded 1 megabyte, or the execution time exceeded 5 seconds.

$sel:httpStatus:SelectResponse', selectResponse_httpStatus - The response's http status code.

Response Lenses

selectResponse_items :: Lens' SelectResponse (Maybe [Item]) Source #

A list of items that match the select expression.

selectResponse_nextToken :: Lens' SelectResponse (Maybe Text) Source #

An opaque token indicating that more items than MaxNumberOfItems were matched, the response size exceeded 1 megabyte, or the execution time exceeded 5 seconds.

selectResponse_httpStatus :: Lens' SelectResponse Int Source #

The response's http status code.