amazonka-dynamodb-1.6.1: Amazon DynamoDB 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.DynamoDB.Scan

Contents

Description

The Scan operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a FilterExpression operation.

If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a LastEvaluatedKey value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria.

A single Scan operation will read up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using FilterExpression . If LastEvaluatedKey is present in the response, you will need to paginate the result set. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide .

Scan operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel Scan operation by providing the Segment and TotalSegments parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide .

Scan uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the ConsistentRead parameter to true .

This operation returns paginated results.

Synopsis

Creating a Request

scan Source #

Arguments

:: Text

sTableName

-> Scan 

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

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

  • sProjectionExpression - A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide .
  • sScanFilter - This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide .
  • sAttributesToGet - This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide .
  • sTotalSegments - For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a TotalSegments value of 4. The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel. If you specify TotalSegments , you must also specify Segment .
  • sExpressionAttributeNames - One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames : * To access an attribute whose name conflicts with a DynamoDB reserved word. * To create a placeholder for repeating occurrences of an attribute name in an expression. * To prevent special characters in an attribute name from being misinterpreted in an expression. Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name: * Percentile The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide ). To work around this, you could specify the following for ExpressionAttributeNames : * {"#P":Percentile} You could then use this substitution in an expression, as in this example: * #P = :val For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide .
  • sFilterExpression - A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned. For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide .
  • sConsistentRead - A Boolean value that determines the read consistency model during the scan: * If ConsistentRead is false , then the data returned from Scan might not contain the results from other recently completed write operations (PutItem, UpdateItem or DeleteItem). * If ConsistentRead is true , then all of the write operations that completed before the Scan began are guaranteed to be contained in the Scan response. The default setting for ConsistentRead is false . The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException .
  • sExpressionAttributeValues - One or more values that can be substituted in an expression. Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following: Available | Backordered | Discontinued You would first need to specify ExpressionAttributeValues as follows: { ":avail":{S:Available}, ":back":{S:Backordered}, ":disc":{S:Discontinued} } You could then use these values in an expression, such as this: ProductStatus IN (:avail, :back, :disc) For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide .
  • sReturnConsumedCapacity - Undocumented member.
  • sLimit - The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide .
  • sSelect - The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index. * ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required. * ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying ALL_ATTRIBUTES . * COUNT - Returns the number of matching items, rather than the matching items themselves. * SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet . This return value is equivalent to specifying AttributesToGet without specifying any value for Select . If you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency. If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table. If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES . (This usage is equivalent to specifying AttributesToGet without any value for Select .)
  • sSegment - For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker. Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a Segment value of 0, the second thread specifies 1, and so on. The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation. The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments . If you provide Segment , you must also provide TotalSegments .
  • sConditionalOperator - This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide .
  • sExclusiveStartKey - The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation. The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed. In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey .
  • sIndexName - The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the IndexName parameter, you must also provide TableName .
  • sTableName - The name of the table containing the requested items; or, if you provide IndexName , the name of the table to which that index belongs.

data Scan Source #

Represents the input of a Scan operation.

See: scan smart constructor.

Instances
Eq Scan Source # 
Instance details

Defined in Network.AWS.DynamoDB.Scan

Methods

(==) :: Scan -> Scan -> Bool #

(/=) :: Scan -> Scan -> Bool #

Data Scan Source # 
Instance details

Defined in Network.AWS.DynamoDB.Scan

Methods

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

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

toConstr :: Scan -> Constr #

dataTypeOf :: Scan -> DataType #

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

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

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

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

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

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

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

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

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

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

Read Scan Source # 
Instance details

Defined in Network.AWS.DynamoDB.Scan

Show Scan Source # 
Instance details

Defined in Network.AWS.DynamoDB.Scan

Methods

showsPrec :: Int -> Scan -> ShowS #

show :: Scan -> String #

showList :: [Scan] -> ShowS #

Generic Scan Source # 
Instance details

Defined in Network.AWS.DynamoDB.Scan

Associated Types

type Rep Scan :: Type -> Type #

Methods

from :: Scan -> Rep Scan x #

to :: Rep Scan x -> Scan #

Hashable Scan Source # 
Instance details

Defined in Network.AWS.DynamoDB.Scan

Methods

hashWithSalt :: Int -> Scan -> Int #

hash :: Scan -> Int #

ToJSON Scan Source # 
Instance details

Defined in Network.AWS.DynamoDB.Scan

AWSPager Scan Source # 
Instance details

Defined in Network.AWS.DynamoDB.Scan

Methods

page :: Scan -> Rs Scan -> Maybe Scan #

AWSRequest Scan Source # 
Instance details

Defined in Network.AWS.DynamoDB.Scan

Associated Types

type Rs Scan :: Type #

ToHeaders Scan Source # 
Instance details

Defined in Network.AWS.DynamoDB.Scan

Methods

toHeaders :: Scan -> [Header] #

ToPath Scan Source # 
Instance details

Defined in Network.AWS.DynamoDB.Scan

Methods

toPath :: Scan -> ByteString #

ToQuery Scan Source # 
Instance details

Defined in Network.AWS.DynamoDB.Scan

Methods

toQuery :: Scan -> QueryString #

NFData Scan Source # 
Instance details

Defined in Network.AWS.DynamoDB.Scan

Methods

rnf :: Scan -> () #

type Rep Scan Source # 
Instance details

Defined in Network.AWS.DynamoDB.Scan

type Rep Scan = D1 (MetaData "Scan" "Network.AWS.DynamoDB.Scan" "amazonka-dynamodb-1.6.1-FTtIhwsA5vX17zvPeEA8Mr" False) (C1 (MetaCons "Scan'" PrefixI True) ((((S1 (MetaSel (Just "_sProjectionExpression") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_sScanFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Condition)))) :*: (S1 (MetaSel (Just "_sAttributesToGet") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (List1 Text))) :*: S1 (MetaSel (Just "_sTotalSegments") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))) :*: ((S1 (MetaSel (Just "_sExpressionAttributeNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))) :*: S1 (MetaSel (Just "_sFilterExpression") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_sConsistentRead") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_sExpressionAttributeValues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text AttributeValue)))))) :*: (((S1 (MetaSel (Just "_sReturnConsumedCapacity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ReturnConsumedCapacity)) :*: S1 (MetaSel (Just "_sLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) :*: (S1 (MetaSel (Just "_sSelect") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Select)) :*: S1 (MetaSel (Just "_sSegment") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))) :*: ((S1 (MetaSel (Just "_sConditionalOperator") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ConditionalOperator)) :*: S1 (MetaSel (Just "_sExclusiveStartKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text AttributeValue)))) :*: (S1 (MetaSel (Just "_sIndexName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_sTableName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))
type Rs Scan Source # 
Instance details

Defined in Network.AWS.DynamoDB.Scan

Request Lenses

sProjectionExpression :: Lens' Scan (Maybe Text) Source #

A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide .

sScanFilter :: Lens' Scan (HashMap Text Condition) Source #

This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide .

sAttributesToGet :: Lens' Scan (Maybe (NonEmpty Text)) Source #

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide .

sTotalSegments :: Lens' Scan (Maybe Natural) Source #

For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a TotalSegments value of 4. The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel. If you specify TotalSegments , you must also specify Segment .

sExpressionAttributeNames :: Lens' Scan (HashMap Text Text) Source #

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames : * To access an attribute whose name conflicts with a DynamoDB reserved word. * To create a placeholder for repeating occurrences of an attribute name in an expression. * To prevent special characters in an attribute name from being misinterpreted in an expression. Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name: * Percentile The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide ). To work around this, you could specify the following for ExpressionAttributeNames : * {"#P":Percentile} You could then use this substitution in an expression, as in this example: * #P = :val For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide .

sFilterExpression :: Lens' Scan (Maybe Text) Source #

A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned. For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide .

sConsistentRead :: Lens' Scan (Maybe Bool) Source #

A Boolean value that determines the read consistency model during the scan: * If ConsistentRead is false , then the data returned from Scan might not contain the results from other recently completed write operations (PutItem, UpdateItem or DeleteItem). * If ConsistentRead is true , then all of the write operations that completed before the Scan began are guaranteed to be contained in the Scan response. The default setting for ConsistentRead is false . The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException .

sExpressionAttributeValues :: Lens' Scan (HashMap Text AttributeValue) Source #

One or more values that can be substituted in an expression. Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following: Available | Backordered | Discontinued You would first need to specify ExpressionAttributeValues as follows: { ":avail":{S:Available}, ":back":{S:Backordered}, ":disc":{S:Discontinued} } You could then use these values in an expression, such as this: ProductStatus IN (:avail, :back, :disc) For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide .

sLimit :: Lens' Scan (Maybe Natural) Source #

The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide .

sSelect :: Lens' Scan (Maybe Select) Source #

The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index. * ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required. * ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying ALL_ATTRIBUTES . * COUNT - Returns the number of matching items, rather than the matching items themselves. * SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet . This return value is equivalent to specifying AttributesToGet without specifying any value for Select . If you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency. If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table. If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES . (This usage is equivalent to specifying AttributesToGet without any value for Select .)

sSegment :: Lens' Scan (Maybe Natural) Source #

For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker. Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a Segment value of 0, the second thread specifies 1, and so on. The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation. The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments . If you provide Segment , you must also provide TotalSegments .

sConditionalOperator :: Lens' Scan (Maybe ConditionalOperator) Source #

This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide .

sExclusiveStartKey :: Lens' Scan (HashMap Text AttributeValue) Source #

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation. The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed. In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey .

sIndexName :: Lens' Scan (Maybe Text) Source #

The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the IndexName parameter, you must also provide TableName .

sTableName :: Lens' Scan Text Source #

The name of the table containing the requested items; or, if you provide IndexName , the name of the table to which that index belongs.

Destructuring the Response

scanResponse Source #

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

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

  • srsLastEvaluatedKey - The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request. If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved. If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.
  • srsCount - The number of items in the response. If you set ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied. If you did not use a filter in the request, then Count is the same as ScannedCount .
  • srsScannedCount - The number of items evaluated, before any ScanFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide . If you did not use a filter in the request, then ScannedCount is the same as Count .
  • srsItems - An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.
  • srsConsumedCapacity - The capacity units consumed by the Scan operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide .
  • srsResponseStatus - -- | The response status code.

data ScanResponse Source #

Represents the output of a Scan operation.

See: scanResponse smart constructor.

Instances
Eq ScanResponse Source # 
Instance details

Defined in Network.AWS.DynamoDB.Scan

Data ScanResponse Source # 
Instance details

Defined in Network.AWS.DynamoDB.Scan

Methods

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

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

toConstr :: ScanResponse -> Constr #

dataTypeOf :: ScanResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ScanResponse Source # 
Instance details

Defined in Network.AWS.DynamoDB.Scan

Show ScanResponse Source # 
Instance details

Defined in Network.AWS.DynamoDB.Scan

Generic ScanResponse Source # 
Instance details

Defined in Network.AWS.DynamoDB.Scan

Associated Types

type Rep ScanResponse :: Type -> Type #

NFData ScanResponse Source # 
Instance details

Defined in Network.AWS.DynamoDB.Scan

Methods

rnf :: ScanResponse -> () #

type Rep ScanResponse Source # 
Instance details

Defined in Network.AWS.DynamoDB.Scan

type Rep ScanResponse = D1 (MetaData "ScanResponse" "Network.AWS.DynamoDB.Scan" "amazonka-dynamodb-1.6.1-FTtIhwsA5vX17zvPeEA8Mr" False) (C1 (MetaCons "ScanResponse'" PrefixI True) ((S1 (MetaSel (Just "_srsLastEvaluatedKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text AttributeValue))) :*: (S1 (MetaSel (Just "_srsCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)) :*: S1 (MetaSel (Just "_srsScannedCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 (MetaSel (Just "_srsItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Map Text AttributeValue])) :*: (S1 (MetaSel (Just "_srsConsumedCapacity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ConsumedCapacity)) :*: S1 (MetaSel (Just "_srsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

srsLastEvaluatedKey :: Lens' ScanResponse (HashMap Text AttributeValue) Source #

The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request. If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved. If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

srsCount :: Lens' ScanResponse (Maybe Int) Source #

The number of items in the response. If you set ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied. If you did not use a filter in the request, then Count is the same as ScannedCount .

srsScannedCount :: Lens' ScanResponse (Maybe Int) Source #

The number of items evaluated, before any ScanFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide . If you did not use a filter in the request, then ScannedCount is the same as Count .

srsItems :: Lens' ScanResponse [HashMap Text AttributeValue] Source #

An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.

srsConsumedCapacity :: Lens' ScanResponse (Maybe ConsumedCapacity) Source #

The capacity units consumed by the Scan operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide .

srsResponseStatus :: Lens' ScanResponse Int Source #

  • - | The response status code.