{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.DynamoDB.Scan
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- 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 dataset 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 reads 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 need to paginate the
-- result set. For more information, see
-- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Pagination 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
-- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.ParallelScan 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.
module Amazonka.DynamoDB.Scan
  ( -- * Creating a Request
    Scan (..),
    newScan,

    -- * Request Lenses
    scan_attributesToGet,
    scan_conditionalOperator,
    scan_consistentRead,
    scan_exclusiveStartKey,
    scan_expressionAttributeNames,
    scan_expressionAttributeValues,
    scan_filterExpression,
    scan_indexName,
    scan_limit,
    scan_projectionExpression,
    scan_returnConsumedCapacity,
    scan_scanFilter,
    scan_segment,
    scan_select,
    scan_totalSegments,
    scan_tableName,

    -- * Destructuring the Response
    ScanResponse (..),
    newScanResponse,

    -- * Response Lenses
    scanResponse_consumedCapacity,
    scanResponse_count,
    scanResponse_items,
    scanResponse_lastEvaluatedKey,
    scanResponse_scannedCount,
    scanResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.DynamoDB.Types
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | Represents the input of a @Scan@ operation.
--
-- /See:/ 'newScan' smart constructor.
data Scan = Scan'
  { -- | This is a legacy parameter. Use @ProjectionExpression@ instead. For more
    -- information, see
    -- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html AttributesToGet>
    -- in the /Amazon DynamoDB Developer Guide/.
    Scan -> Maybe (NonEmpty Text)
attributesToGet :: Prelude.Maybe (Prelude.NonEmpty Prelude.Text),
    -- | This is a legacy parameter. Use @FilterExpression@ instead. For more
    -- information, see
    -- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html ConditionalOperator>
    -- in the /Amazon DynamoDB Developer Guide/.
    Scan -> Maybe ConditionalOperator
conditionalOperator :: Prelude.Maybe ConditionalOperator,
    -- | 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@.
    Scan -> Maybe Bool
consistentRead :: Prelude.Maybe Prelude.Bool,
    -- | 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@.
    Scan -> Maybe (HashMap Text AttributeValue)
exclusiveStartKey :: Prelude.Maybe (Prelude.HashMap Prelude.Text AttributeValue),
    -- | 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
    -- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html 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@
    --
    -- Tokens that begin with the __:__ character are /expression attribute
    -- values/, which are placeholders for the actual value at runtime.
    --
    -- For more information on expression attribute names, see
    -- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html Specifying Item Attributes>
    -- in the /Amazon DynamoDB Developer Guide/.
    Scan -> Maybe (HashMap Text Text)
expressionAttributeNames :: Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text),
    -- | 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
    -- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html Condition Expressions>
    -- in the /Amazon DynamoDB Developer Guide/.
    Scan -> Maybe (HashMap Text AttributeValue)
expressionAttributeValues :: Prelude.Maybe (Prelude.HashMap Prelude.Text AttributeValue),
    -- | 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.
    --
    -- A @FilterExpression@ is applied after the items have already been read;
    -- the process of filtering does not consume any additional read capacity
    -- units.
    --
    -- For more information, see
    -- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Query.FilterExpression Filter Expressions>
    -- in the /Amazon DynamoDB Developer Guide/.
    Scan -> Maybe Text
filterExpression :: Prelude.Maybe Prelude.Text,
    -- | 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@.
    Scan -> Maybe Text
indexName :: Prelude.Maybe Prelude.Text,
    -- | 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 dataset 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
    -- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html Working with Queries>
    -- in the /Amazon DynamoDB Developer Guide/.
    Scan -> Maybe Natural
limit :: Prelude.Maybe Prelude.Natural,
    -- | 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
    -- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html Specifying Item Attributes>
    -- in the /Amazon DynamoDB Developer Guide/.
    Scan -> Maybe Text
projectionExpression :: Prelude.Maybe Prelude.Text,
    Scan -> Maybe ReturnConsumedCapacity
returnConsumedCapacity :: Prelude.Maybe ReturnConsumedCapacity,
    -- | This is a legacy parameter. Use @FilterExpression@ instead. For more
    -- information, see
    -- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html ScanFilter>
    -- in the /Amazon DynamoDB Developer Guide/.
    Scan -> Maybe (HashMap Text Condition)
scanFilter :: Prelude.Maybe (Prelude.HashMap Prelude.Text Condition),
    -- | 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@.
    Scan -> Maybe Natural
segment :: Prelude.Maybe Prelude.Natural,
    -- | 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 fetches 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
    --     @ProjectionExpression@. This return value is equivalent to
    --     specifying @ProjectionExpression@ 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 reads
    --     only the index and not the table. If any of the requested attributes
    --     are not projected into the local secondary index, DynamoDB fetches
    --     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 @ProjectionExpression@ 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 @ProjectionExpression@ together in a single request, unless
    -- the value for @Select@ is @SPECIFIC_ATTRIBUTES@. (This usage is
    -- equivalent to specifying @ProjectionExpression@ without any value for
    -- @Select@.)
    --
    -- If you use the @ProjectionExpression@ parameter, then the value for
    -- @Select@ can only be @SPECIFIC_ATTRIBUTES@. Any other value for @Select@
    -- will return an error.
    Scan -> Maybe Select
select :: Prelude.Maybe Select,
    -- | 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@.
    Scan -> Maybe Natural
totalSegments :: Prelude.Maybe Prelude.Natural,
    -- | The name of the table containing the requested items; or, if you provide
    -- @IndexName@, the name of the table to which that index belongs.
    Scan -> Text
tableName :: Prelude.Text
  }
  deriving (Scan -> Scan -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Scan -> Scan -> Bool
$c/= :: Scan -> Scan -> Bool
== :: Scan -> Scan -> Bool
$c== :: Scan -> Scan -> Bool
Prelude.Eq, ReadPrec [Scan]
ReadPrec Scan
Int -> ReadS Scan
ReadS [Scan]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [Scan]
$creadListPrec :: ReadPrec [Scan]
readPrec :: ReadPrec Scan
$creadPrec :: ReadPrec Scan
readList :: ReadS [Scan]
$creadList :: ReadS [Scan]
readsPrec :: Int -> ReadS Scan
$creadsPrec :: Int -> ReadS Scan
Prelude.Read, Int -> Scan -> ShowS
[Scan] -> ShowS
Scan -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Scan] -> ShowS
$cshowList :: [Scan] -> ShowS
show :: Scan -> String
$cshow :: Scan -> String
showsPrec :: Int -> Scan -> ShowS
$cshowsPrec :: Int -> Scan -> ShowS
Prelude.Show, forall x. Rep Scan x -> Scan
forall x. Scan -> Rep Scan x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Scan x -> Scan
$cfrom :: forall x. Scan -> Rep Scan x
Prelude.Generic)

-- |
-- Create a value of 'Scan' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'attributesToGet', 'scan_attributesToGet' - This is a legacy parameter. Use @ProjectionExpression@ instead. For more
-- information, see
-- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html AttributesToGet>
-- in the /Amazon DynamoDB Developer Guide/.
--
-- 'conditionalOperator', 'scan_conditionalOperator' - This is a legacy parameter. Use @FilterExpression@ instead. For more
-- information, see
-- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html ConditionalOperator>
-- in the /Amazon DynamoDB Developer Guide/.
--
-- 'consistentRead', 'scan_consistentRead' - 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@.
--
-- 'exclusiveStartKey', 'scan_exclusiveStartKey' - 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@.
--
-- 'expressionAttributeNames', 'scan_expressionAttributeNames' - 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
-- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html 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@
--
-- Tokens that begin with the __:__ character are /expression attribute
-- values/, which are placeholders for the actual value at runtime.
--
-- For more information on expression attribute names, see
-- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html Specifying Item Attributes>
-- in the /Amazon DynamoDB Developer Guide/.
--
-- 'expressionAttributeValues', 'scan_expressionAttributeValues' - 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
-- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html Condition Expressions>
-- in the /Amazon DynamoDB Developer Guide/.
--
-- 'filterExpression', 'scan_filterExpression' - 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.
--
-- A @FilterExpression@ is applied after the items have already been read;
-- the process of filtering does not consume any additional read capacity
-- units.
--
-- For more information, see
-- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Query.FilterExpression Filter Expressions>
-- in the /Amazon DynamoDB Developer Guide/.
--
-- 'indexName', 'scan_indexName' - 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@.
--
-- 'limit', 'scan_limit' - 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 dataset 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
-- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html Working with Queries>
-- in the /Amazon DynamoDB Developer Guide/.
--
-- 'projectionExpression', 'scan_projectionExpression' - 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
-- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html Specifying Item Attributes>
-- in the /Amazon DynamoDB Developer Guide/.
--
-- 'returnConsumedCapacity', 'scan_returnConsumedCapacity' - Undocumented member.
--
-- 'scanFilter', 'scan_scanFilter' - This is a legacy parameter. Use @FilterExpression@ instead. For more
-- information, see
-- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html ScanFilter>
-- in the /Amazon DynamoDB Developer Guide/.
--
-- 'segment', 'scan_segment' - 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@.
--
-- 'select', 'scan_select' - 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 fetches 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
--     @ProjectionExpression@. This return value is equivalent to
--     specifying @ProjectionExpression@ 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 reads
--     only the index and not the table. If any of the requested attributes
--     are not projected into the local secondary index, DynamoDB fetches
--     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 @ProjectionExpression@ 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 @ProjectionExpression@ together in a single request, unless
-- the value for @Select@ is @SPECIFIC_ATTRIBUTES@. (This usage is
-- equivalent to specifying @ProjectionExpression@ without any value for
-- @Select@.)
--
-- If you use the @ProjectionExpression@ parameter, then the value for
-- @Select@ can only be @SPECIFIC_ATTRIBUTES@. Any other value for @Select@
-- will return an error.
--
-- 'totalSegments', 'scan_totalSegments' - 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@.
--
-- 'tableName', 'scan_tableName' - The name of the table containing the requested items; or, if you provide
-- @IndexName@, the name of the table to which that index belongs.
newScan ::
  -- | 'tableName'
  Prelude.Text ->
  Scan
newScan :: Text -> Scan
newScan Text
pTableName_ =
  Scan'
    { $sel:attributesToGet:Scan' :: Maybe (NonEmpty Text)
attributesToGet = forall a. Maybe a
Prelude.Nothing,
      $sel:conditionalOperator:Scan' :: Maybe ConditionalOperator
conditionalOperator = forall a. Maybe a
Prelude.Nothing,
      $sel:consistentRead:Scan' :: Maybe Bool
consistentRead = forall a. Maybe a
Prelude.Nothing,
      $sel:exclusiveStartKey:Scan' :: Maybe (HashMap Text AttributeValue)
exclusiveStartKey = forall a. Maybe a
Prelude.Nothing,
      $sel:expressionAttributeNames:Scan' :: Maybe (HashMap Text Text)
expressionAttributeNames = forall a. Maybe a
Prelude.Nothing,
      $sel:expressionAttributeValues:Scan' :: Maybe (HashMap Text AttributeValue)
expressionAttributeValues = forall a. Maybe a
Prelude.Nothing,
      $sel:filterExpression:Scan' :: Maybe Text
filterExpression = forall a. Maybe a
Prelude.Nothing,
      $sel:indexName:Scan' :: Maybe Text
indexName = forall a. Maybe a
Prelude.Nothing,
      $sel:limit:Scan' :: Maybe Natural
limit = forall a. Maybe a
Prelude.Nothing,
      $sel:projectionExpression:Scan' :: Maybe Text
projectionExpression = forall a. Maybe a
Prelude.Nothing,
      $sel:returnConsumedCapacity:Scan' :: Maybe ReturnConsumedCapacity
returnConsumedCapacity = forall a. Maybe a
Prelude.Nothing,
      $sel:scanFilter:Scan' :: Maybe (HashMap Text Condition)
scanFilter = forall a. Maybe a
Prelude.Nothing,
      $sel:segment:Scan' :: Maybe Natural
segment = forall a. Maybe a
Prelude.Nothing,
      $sel:select:Scan' :: Maybe Select
select = forall a. Maybe a
Prelude.Nothing,
      $sel:totalSegments:Scan' :: Maybe Natural
totalSegments = forall a. Maybe a
Prelude.Nothing,
      $sel:tableName:Scan' :: Text
tableName = Text
pTableName_
    }

-- | This is a legacy parameter. Use @ProjectionExpression@ instead. For more
-- information, see
-- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html AttributesToGet>
-- in the /Amazon DynamoDB Developer Guide/.
scan_attributesToGet :: Lens.Lens' Scan (Prelude.Maybe (Prelude.NonEmpty Prelude.Text))
scan_attributesToGet :: Lens' Scan (Maybe (NonEmpty Text))
scan_attributesToGet = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Scan' {Maybe (NonEmpty Text)
attributesToGet :: Maybe (NonEmpty Text)
$sel:attributesToGet:Scan' :: Scan -> Maybe (NonEmpty Text)
attributesToGet} -> Maybe (NonEmpty Text)
attributesToGet) (\s :: Scan
s@Scan' {} Maybe (NonEmpty Text)
a -> Scan
s {$sel:attributesToGet:Scan' :: Maybe (NonEmpty Text)
attributesToGet = Maybe (NonEmpty Text)
a} :: Scan) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | This is a legacy parameter. Use @FilterExpression@ instead. For more
-- information, see
-- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html ConditionalOperator>
-- in the /Amazon DynamoDB Developer Guide/.
scan_conditionalOperator :: Lens.Lens' Scan (Prelude.Maybe ConditionalOperator)
scan_conditionalOperator :: Lens' Scan (Maybe ConditionalOperator)
scan_conditionalOperator = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Scan' {Maybe ConditionalOperator
conditionalOperator :: Maybe ConditionalOperator
$sel:conditionalOperator:Scan' :: Scan -> Maybe ConditionalOperator
conditionalOperator} -> Maybe ConditionalOperator
conditionalOperator) (\s :: Scan
s@Scan' {} Maybe ConditionalOperator
a -> Scan
s {$sel:conditionalOperator:Scan' :: Maybe ConditionalOperator
conditionalOperator = Maybe ConditionalOperator
a} :: Scan)

-- | 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@.
scan_consistentRead :: Lens.Lens' Scan (Prelude.Maybe Prelude.Bool)
scan_consistentRead :: Lens' Scan (Maybe Bool)
scan_consistentRead = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Scan' {Maybe Bool
consistentRead :: Maybe Bool
$sel:consistentRead:Scan' :: Scan -> Maybe Bool
consistentRead} -> Maybe Bool
consistentRead) (\s :: Scan
s@Scan' {} Maybe Bool
a -> Scan
s {$sel:consistentRead:Scan' :: Maybe Bool
consistentRead = Maybe Bool
a} :: Scan)

-- | 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@.
scan_exclusiveStartKey :: Lens.Lens' Scan (Prelude.Maybe (Prelude.HashMap Prelude.Text AttributeValue))
scan_exclusiveStartKey :: Lens' Scan (Maybe (HashMap Text AttributeValue))
scan_exclusiveStartKey = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Scan' {Maybe (HashMap Text AttributeValue)
exclusiveStartKey :: Maybe (HashMap Text AttributeValue)
$sel:exclusiveStartKey:Scan' :: Scan -> Maybe (HashMap Text AttributeValue)
exclusiveStartKey} -> Maybe (HashMap Text AttributeValue)
exclusiveStartKey) (\s :: Scan
s@Scan' {} Maybe (HashMap Text AttributeValue)
a -> Scan
s {$sel:exclusiveStartKey:Scan' :: Maybe (HashMap Text AttributeValue)
exclusiveStartKey = Maybe (HashMap Text AttributeValue)
a} :: Scan) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | 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
-- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html 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@
--
-- Tokens that begin with the __:__ character are /expression attribute
-- values/, which are placeholders for the actual value at runtime.
--
-- For more information on expression attribute names, see
-- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html Specifying Item Attributes>
-- in the /Amazon DynamoDB Developer Guide/.
scan_expressionAttributeNames :: Lens.Lens' Scan (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text))
scan_expressionAttributeNames :: Lens' Scan (Maybe (HashMap Text Text))
scan_expressionAttributeNames = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Scan' {Maybe (HashMap Text Text)
expressionAttributeNames :: Maybe (HashMap Text Text)
$sel:expressionAttributeNames:Scan' :: Scan -> Maybe (HashMap Text Text)
expressionAttributeNames} -> Maybe (HashMap Text Text)
expressionAttributeNames) (\s :: Scan
s@Scan' {} Maybe (HashMap Text Text)
a -> Scan
s {$sel:expressionAttributeNames:Scan' :: Maybe (HashMap Text Text)
expressionAttributeNames = Maybe (HashMap Text Text)
a} :: Scan) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | 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
-- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html Condition Expressions>
-- in the /Amazon DynamoDB Developer Guide/.
scan_expressionAttributeValues :: Lens.Lens' Scan (Prelude.Maybe (Prelude.HashMap Prelude.Text AttributeValue))
scan_expressionAttributeValues :: Lens' Scan (Maybe (HashMap Text AttributeValue))
scan_expressionAttributeValues = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Scan' {Maybe (HashMap Text AttributeValue)
expressionAttributeValues :: Maybe (HashMap Text AttributeValue)
$sel:expressionAttributeValues:Scan' :: Scan -> Maybe (HashMap Text AttributeValue)
expressionAttributeValues} -> Maybe (HashMap Text AttributeValue)
expressionAttributeValues) (\s :: Scan
s@Scan' {} Maybe (HashMap Text AttributeValue)
a -> Scan
s {$sel:expressionAttributeValues:Scan' :: Maybe (HashMap Text AttributeValue)
expressionAttributeValues = Maybe (HashMap Text AttributeValue)
a} :: Scan) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | 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.
--
-- A @FilterExpression@ is applied after the items have already been read;
-- the process of filtering does not consume any additional read capacity
-- units.
--
-- For more information, see
-- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Query.FilterExpression Filter Expressions>
-- in the /Amazon DynamoDB Developer Guide/.
scan_filterExpression :: Lens.Lens' Scan (Prelude.Maybe Prelude.Text)
scan_filterExpression :: Lens' Scan (Maybe Text)
scan_filterExpression = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Scan' {Maybe Text
filterExpression :: Maybe Text
$sel:filterExpression:Scan' :: Scan -> Maybe Text
filterExpression} -> Maybe Text
filterExpression) (\s :: Scan
s@Scan' {} Maybe Text
a -> Scan
s {$sel:filterExpression:Scan' :: Maybe Text
filterExpression = Maybe Text
a} :: Scan)

-- | 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@.
scan_indexName :: Lens.Lens' Scan (Prelude.Maybe Prelude.Text)
scan_indexName :: Lens' Scan (Maybe Text)
scan_indexName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Scan' {Maybe Text
indexName :: Maybe Text
$sel:indexName:Scan' :: Scan -> Maybe Text
indexName} -> Maybe Text
indexName) (\s :: Scan
s@Scan' {} Maybe Text
a -> Scan
s {$sel:indexName:Scan' :: Maybe Text
indexName = Maybe Text
a} :: Scan)

-- | 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 dataset 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
-- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html Working with Queries>
-- in the /Amazon DynamoDB Developer Guide/.
scan_limit :: Lens.Lens' Scan (Prelude.Maybe Prelude.Natural)
scan_limit :: Lens' Scan (Maybe Natural)
scan_limit = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Scan' {Maybe Natural
limit :: Maybe Natural
$sel:limit:Scan' :: Scan -> Maybe Natural
limit} -> Maybe Natural
limit) (\s :: Scan
s@Scan' {} Maybe Natural
a -> Scan
s {$sel:limit:Scan' :: Maybe Natural
limit = Maybe Natural
a} :: Scan)

-- | 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
-- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html Specifying Item Attributes>
-- in the /Amazon DynamoDB Developer Guide/.
scan_projectionExpression :: Lens.Lens' Scan (Prelude.Maybe Prelude.Text)
scan_projectionExpression :: Lens' Scan (Maybe Text)
scan_projectionExpression = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Scan' {Maybe Text
projectionExpression :: Maybe Text
$sel:projectionExpression:Scan' :: Scan -> Maybe Text
projectionExpression} -> Maybe Text
projectionExpression) (\s :: Scan
s@Scan' {} Maybe Text
a -> Scan
s {$sel:projectionExpression:Scan' :: Maybe Text
projectionExpression = Maybe Text
a} :: Scan)

-- | Undocumented member.
scan_returnConsumedCapacity :: Lens.Lens' Scan (Prelude.Maybe ReturnConsumedCapacity)
scan_returnConsumedCapacity :: Lens' Scan (Maybe ReturnConsumedCapacity)
scan_returnConsumedCapacity = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Scan' {Maybe ReturnConsumedCapacity
returnConsumedCapacity :: Maybe ReturnConsumedCapacity
$sel:returnConsumedCapacity:Scan' :: Scan -> Maybe ReturnConsumedCapacity
returnConsumedCapacity} -> Maybe ReturnConsumedCapacity
returnConsumedCapacity) (\s :: Scan
s@Scan' {} Maybe ReturnConsumedCapacity
a -> Scan
s {$sel:returnConsumedCapacity:Scan' :: Maybe ReturnConsumedCapacity
returnConsumedCapacity = Maybe ReturnConsumedCapacity
a} :: Scan)

-- | This is a legacy parameter. Use @FilterExpression@ instead. For more
-- information, see
-- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html ScanFilter>
-- in the /Amazon DynamoDB Developer Guide/.
scan_scanFilter :: Lens.Lens' Scan (Prelude.Maybe (Prelude.HashMap Prelude.Text Condition))
scan_scanFilter :: Lens' Scan (Maybe (HashMap Text Condition))
scan_scanFilter = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Scan' {Maybe (HashMap Text Condition)
scanFilter :: Maybe (HashMap Text Condition)
$sel:scanFilter:Scan' :: Scan -> Maybe (HashMap Text Condition)
scanFilter} -> Maybe (HashMap Text Condition)
scanFilter) (\s :: Scan
s@Scan' {} Maybe (HashMap Text Condition)
a -> Scan
s {$sel:scanFilter:Scan' :: Maybe (HashMap Text Condition)
scanFilter = Maybe (HashMap Text Condition)
a} :: Scan) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | 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@.
scan_segment :: Lens.Lens' Scan (Prelude.Maybe Prelude.Natural)
scan_segment :: Lens' Scan (Maybe Natural)
scan_segment = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Scan' {Maybe Natural
segment :: Maybe Natural
$sel:segment:Scan' :: Scan -> Maybe Natural
segment} -> Maybe Natural
segment) (\s :: Scan
s@Scan' {} Maybe Natural
a -> Scan
s {$sel:segment:Scan' :: Maybe Natural
segment = Maybe Natural
a} :: Scan)

-- | 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 fetches 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
--     @ProjectionExpression@. This return value is equivalent to
--     specifying @ProjectionExpression@ 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 reads
--     only the index and not the table. If any of the requested attributes
--     are not projected into the local secondary index, DynamoDB fetches
--     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 @ProjectionExpression@ 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 @ProjectionExpression@ together in a single request, unless
-- the value for @Select@ is @SPECIFIC_ATTRIBUTES@. (This usage is
-- equivalent to specifying @ProjectionExpression@ without any value for
-- @Select@.)
--
-- If you use the @ProjectionExpression@ parameter, then the value for
-- @Select@ can only be @SPECIFIC_ATTRIBUTES@. Any other value for @Select@
-- will return an error.
scan_select :: Lens.Lens' Scan (Prelude.Maybe Select)
scan_select :: Lens' Scan (Maybe Select)
scan_select = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Scan' {Maybe Select
select :: Maybe Select
$sel:select:Scan' :: Scan -> Maybe Select
select} -> Maybe Select
select) (\s :: Scan
s@Scan' {} Maybe Select
a -> Scan
s {$sel:select:Scan' :: Maybe Select
select = Maybe Select
a} :: Scan)

-- | 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@.
scan_totalSegments :: Lens.Lens' Scan (Prelude.Maybe Prelude.Natural)
scan_totalSegments :: Lens' Scan (Maybe Natural)
scan_totalSegments = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Scan' {Maybe Natural
totalSegments :: Maybe Natural
$sel:totalSegments:Scan' :: Scan -> Maybe Natural
totalSegments} -> Maybe Natural
totalSegments) (\s :: Scan
s@Scan' {} Maybe Natural
a -> Scan
s {$sel:totalSegments:Scan' :: Maybe Natural
totalSegments = Maybe Natural
a} :: Scan)

-- | The name of the table containing the requested items; or, if you provide
-- @IndexName@, the name of the table to which that index belongs.
scan_tableName :: Lens.Lens' Scan Prelude.Text
scan_tableName :: Lens' Scan Text
scan_tableName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Scan' {Text
tableName :: Text
$sel:tableName:Scan' :: Scan -> Text
tableName} -> Text
tableName) (\s :: Scan
s@Scan' {} Text
a -> Scan
s {$sel:tableName:Scan' :: Text
tableName = Text
a} :: Scan)

instance Core.AWSPager Scan where
  page :: Scan -> AWSResponse Scan -> Maybe Scan
page Scan
rq AWSResponse Scan
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse Scan
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ScanResponse (Maybe (HashMap Text AttributeValue))
scanResponse_lastEvaluatedKey
            forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
        forall a. Maybe a
Prelude.Nothing
    | Bool
Prelude.otherwise =
        forall a. a -> Maybe a
Prelude.Just
          forall a b. (a -> b) -> a -> b
Prelude.$ Scan
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' Scan (Maybe (HashMap Text AttributeValue))
scan_exclusiveStartKey
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse Scan
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ScanResponse (Maybe (HashMap Text AttributeValue))
scanResponse_lastEvaluatedKey
          forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just

instance Core.AWSRequest Scan where
  type AWSResponse Scan = ScanResponse
  request :: (Service -> Service) -> Scan -> Request Scan
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy Scan
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse Scan)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe ConsumedCapacity
-> Maybe Int
-> Maybe [HashMap Text AttributeValue]
-> Maybe (HashMap Text AttributeValue)
-> Maybe Int
-> Int
-> ScanResponse
ScanResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"ConsumedCapacity")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"Count")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"Items" forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ( Object
x
                            forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"LastEvaluatedKey"
                            forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty
                        )
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"ScannedCount")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable Scan where
  hashWithSalt :: Int -> Scan -> Int
hashWithSalt Int
_salt Scan' {Maybe Bool
Maybe Natural
Maybe (NonEmpty Text)
Maybe Text
Maybe (HashMap Text Text)
Maybe (HashMap Text AttributeValue)
Maybe (HashMap Text Condition)
Maybe Select
Maybe ReturnConsumedCapacity
Maybe ConditionalOperator
Text
tableName :: Text
totalSegments :: Maybe Natural
select :: Maybe Select
segment :: Maybe Natural
scanFilter :: Maybe (HashMap Text Condition)
returnConsumedCapacity :: Maybe ReturnConsumedCapacity
projectionExpression :: Maybe Text
limit :: Maybe Natural
indexName :: Maybe Text
filterExpression :: Maybe Text
expressionAttributeValues :: Maybe (HashMap Text AttributeValue)
expressionAttributeNames :: Maybe (HashMap Text Text)
exclusiveStartKey :: Maybe (HashMap Text AttributeValue)
consistentRead :: Maybe Bool
conditionalOperator :: Maybe ConditionalOperator
attributesToGet :: Maybe (NonEmpty Text)
$sel:tableName:Scan' :: Scan -> Text
$sel:totalSegments:Scan' :: Scan -> Maybe Natural
$sel:select:Scan' :: Scan -> Maybe Select
$sel:segment:Scan' :: Scan -> Maybe Natural
$sel:scanFilter:Scan' :: Scan -> Maybe (HashMap Text Condition)
$sel:returnConsumedCapacity:Scan' :: Scan -> Maybe ReturnConsumedCapacity
$sel:projectionExpression:Scan' :: Scan -> Maybe Text
$sel:limit:Scan' :: Scan -> Maybe Natural
$sel:indexName:Scan' :: Scan -> Maybe Text
$sel:filterExpression:Scan' :: Scan -> Maybe Text
$sel:expressionAttributeValues:Scan' :: Scan -> Maybe (HashMap Text AttributeValue)
$sel:expressionAttributeNames:Scan' :: Scan -> Maybe (HashMap Text Text)
$sel:exclusiveStartKey:Scan' :: Scan -> Maybe (HashMap Text AttributeValue)
$sel:consistentRead:Scan' :: Scan -> Maybe Bool
$sel:conditionalOperator:Scan' :: Scan -> Maybe ConditionalOperator
$sel:attributesToGet:Scan' :: Scan -> Maybe (NonEmpty Text)
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (NonEmpty Text)
attributesToGet
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ConditionalOperator
conditionalOperator
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
consistentRead
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (HashMap Text AttributeValue)
exclusiveStartKey
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (HashMap Text Text)
expressionAttributeNames
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (HashMap Text AttributeValue)
expressionAttributeValues
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
filterExpression
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
indexName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
limit
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
projectionExpression
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ReturnConsumedCapacity
returnConsumedCapacity
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (HashMap Text Condition)
scanFilter
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
segment
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Select
select
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
totalSegments
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
tableName

instance Prelude.NFData Scan where
  rnf :: Scan -> ()
rnf Scan' {Maybe Bool
Maybe Natural
Maybe (NonEmpty Text)
Maybe Text
Maybe (HashMap Text Text)
Maybe (HashMap Text AttributeValue)
Maybe (HashMap Text Condition)
Maybe Select
Maybe ReturnConsumedCapacity
Maybe ConditionalOperator
Text
tableName :: Text
totalSegments :: Maybe Natural
select :: Maybe Select
segment :: Maybe Natural
scanFilter :: Maybe (HashMap Text Condition)
returnConsumedCapacity :: Maybe ReturnConsumedCapacity
projectionExpression :: Maybe Text
limit :: Maybe Natural
indexName :: Maybe Text
filterExpression :: Maybe Text
expressionAttributeValues :: Maybe (HashMap Text AttributeValue)
expressionAttributeNames :: Maybe (HashMap Text Text)
exclusiveStartKey :: Maybe (HashMap Text AttributeValue)
consistentRead :: Maybe Bool
conditionalOperator :: Maybe ConditionalOperator
attributesToGet :: Maybe (NonEmpty Text)
$sel:tableName:Scan' :: Scan -> Text
$sel:totalSegments:Scan' :: Scan -> Maybe Natural
$sel:select:Scan' :: Scan -> Maybe Select
$sel:segment:Scan' :: Scan -> Maybe Natural
$sel:scanFilter:Scan' :: Scan -> Maybe (HashMap Text Condition)
$sel:returnConsumedCapacity:Scan' :: Scan -> Maybe ReturnConsumedCapacity
$sel:projectionExpression:Scan' :: Scan -> Maybe Text
$sel:limit:Scan' :: Scan -> Maybe Natural
$sel:indexName:Scan' :: Scan -> Maybe Text
$sel:filterExpression:Scan' :: Scan -> Maybe Text
$sel:expressionAttributeValues:Scan' :: Scan -> Maybe (HashMap Text AttributeValue)
$sel:expressionAttributeNames:Scan' :: Scan -> Maybe (HashMap Text Text)
$sel:exclusiveStartKey:Scan' :: Scan -> Maybe (HashMap Text AttributeValue)
$sel:consistentRead:Scan' :: Scan -> Maybe Bool
$sel:conditionalOperator:Scan' :: Scan -> Maybe ConditionalOperator
$sel:attributesToGet:Scan' :: Scan -> Maybe (NonEmpty Text)
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe (NonEmpty Text)
attributesToGet
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ConditionalOperator
conditionalOperator
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
consistentRead
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (HashMap Text AttributeValue)
exclusiveStartKey
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (HashMap Text Text)
expressionAttributeNames
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (HashMap Text AttributeValue)
expressionAttributeValues
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
filterExpression
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
indexName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
limit
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
projectionExpression
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ReturnConsumedCapacity
returnConsumedCapacity
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (HashMap Text Condition)
scanFilter
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
segment
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Select
select
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
totalSegments
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
tableName

instance Data.ToHeaders Scan where
  toHeaders :: Scan -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"X-Amz-Target"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# (ByteString
"DynamoDB_20120810.Scan" :: Prelude.ByteString),
            HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.0" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON Scan where
  toJSON :: Scan -> Value
toJSON Scan' {Maybe Bool
Maybe Natural
Maybe (NonEmpty Text)
Maybe Text
Maybe (HashMap Text Text)
Maybe (HashMap Text AttributeValue)
Maybe (HashMap Text Condition)
Maybe Select
Maybe ReturnConsumedCapacity
Maybe ConditionalOperator
Text
tableName :: Text
totalSegments :: Maybe Natural
select :: Maybe Select
segment :: Maybe Natural
scanFilter :: Maybe (HashMap Text Condition)
returnConsumedCapacity :: Maybe ReturnConsumedCapacity
projectionExpression :: Maybe Text
limit :: Maybe Natural
indexName :: Maybe Text
filterExpression :: Maybe Text
expressionAttributeValues :: Maybe (HashMap Text AttributeValue)
expressionAttributeNames :: Maybe (HashMap Text Text)
exclusiveStartKey :: Maybe (HashMap Text AttributeValue)
consistentRead :: Maybe Bool
conditionalOperator :: Maybe ConditionalOperator
attributesToGet :: Maybe (NonEmpty Text)
$sel:tableName:Scan' :: Scan -> Text
$sel:totalSegments:Scan' :: Scan -> Maybe Natural
$sel:select:Scan' :: Scan -> Maybe Select
$sel:segment:Scan' :: Scan -> Maybe Natural
$sel:scanFilter:Scan' :: Scan -> Maybe (HashMap Text Condition)
$sel:returnConsumedCapacity:Scan' :: Scan -> Maybe ReturnConsumedCapacity
$sel:projectionExpression:Scan' :: Scan -> Maybe Text
$sel:limit:Scan' :: Scan -> Maybe Natural
$sel:indexName:Scan' :: Scan -> Maybe Text
$sel:filterExpression:Scan' :: Scan -> Maybe Text
$sel:expressionAttributeValues:Scan' :: Scan -> Maybe (HashMap Text AttributeValue)
$sel:expressionAttributeNames:Scan' :: Scan -> Maybe (HashMap Text Text)
$sel:exclusiveStartKey:Scan' :: Scan -> Maybe (HashMap Text AttributeValue)
$sel:consistentRead:Scan' :: Scan -> Maybe Bool
$sel:conditionalOperator:Scan' :: Scan -> Maybe ConditionalOperator
$sel:attributesToGet:Scan' :: Scan -> Maybe (NonEmpty Text)
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"AttributesToGet" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe (NonEmpty Text)
attributesToGet,
            (Key
"ConditionalOperator" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe ConditionalOperator
conditionalOperator,
            (Key
"ConsistentRead" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
consistentRead,
            (Key
"ExclusiveStartKey" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe (HashMap Text AttributeValue)
exclusiveStartKey,
            (Key
"ExpressionAttributeNames" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe (HashMap Text Text)
expressionAttributeNames,
            (Key
"ExpressionAttributeValues" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe (HashMap Text AttributeValue)
expressionAttributeValues,
            (Key
"FilterExpression" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
filterExpression,
            (Key
"IndexName" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
indexName,
            (Key
"Limit" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Natural
limit,
            (Key
"ProjectionExpression" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
projectionExpression,
            (Key
"ReturnConsumedCapacity" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe ReturnConsumedCapacity
returnConsumedCapacity,
            (Key
"ScanFilter" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe (HashMap Text Condition)
scanFilter,
            (Key
"Segment" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Natural
segment,
            (Key
"Select" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Select
select,
            (Key
"TotalSegments" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Natural
totalSegments,
            forall a. a -> Maybe a
Prelude.Just (Key
"TableName" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
tableName)
          ]
      )

instance Data.ToPath Scan where
  toPath :: Scan -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance Data.ToQuery Scan where
  toQuery :: Scan -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

-- | Represents the output of a @Scan@ operation.
--
-- /See:/ 'newScanResponse' smart constructor.
data ScanResponse = ScanResponse'
  { -- | 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
    -- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html Provisioned Throughput>
    -- in the /Amazon DynamoDB Developer Guide/.
    ScanResponse -> Maybe ConsumedCapacity
consumedCapacity :: Prelude.Maybe ConsumedCapacity,
    -- | 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@.
    ScanResponse -> Maybe Int
count :: Prelude.Maybe Prelude.Int,
    -- | 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.
    ScanResponse -> Maybe [HashMap Text AttributeValue]
items :: Prelude.Maybe [Prelude.HashMap Prelude.Text AttributeValue],
    -- | 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.
    ScanResponse -> Maybe (HashMap Text AttributeValue)
lastEvaluatedKey :: Prelude.Maybe (Prelude.HashMap Prelude.Text AttributeValue),
    -- | 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
    -- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count 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@.
    ScanResponse -> Maybe Int
scannedCount :: Prelude.Maybe Prelude.Int,
    -- | The response's http status code.
    ScanResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (ScanResponse -> ScanResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ScanResponse -> ScanResponse -> Bool
$c/= :: ScanResponse -> ScanResponse -> Bool
== :: ScanResponse -> ScanResponse -> Bool
$c== :: ScanResponse -> ScanResponse -> Bool
Prelude.Eq, ReadPrec [ScanResponse]
ReadPrec ScanResponse
Int -> ReadS ScanResponse
ReadS [ScanResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ScanResponse]
$creadListPrec :: ReadPrec [ScanResponse]
readPrec :: ReadPrec ScanResponse
$creadPrec :: ReadPrec ScanResponse
readList :: ReadS [ScanResponse]
$creadList :: ReadS [ScanResponse]
readsPrec :: Int -> ReadS ScanResponse
$creadsPrec :: Int -> ReadS ScanResponse
Prelude.Read, Int -> ScanResponse -> ShowS
[ScanResponse] -> ShowS
ScanResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ScanResponse] -> ShowS
$cshowList :: [ScanResponse] -> ShowS
show :: ScanResponse -> String
$cshow :: ScanResponse -> String
showsPrec :: Int -> ScanResponse -> ShowS
$cshowsPrec :: Int -> ScanResponse -> ShowS
Prelude.Show, forall x. Rep ScanResponse x -> ScanResponse
forall x. ScanResponse -> Rep ScanResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ScanResponse x -> ScanResponse
$cfrom :: forall x. ScanResponse -> Rep ScanResponse x
Prelude.Generic)

-- |
-- Create a value of 'ScanResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'consumedCapacity', 'scanResponse_consumedCapacity' - 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
-- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html Provisioned Throughput>
-- in the /Amazon DynamoDB Developer Guide/.
--
-- 'count', 'scanResponse_count' - 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@.
--
-- 'items', 'scanResponse_items' - 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.
--
-- 'lastEvaluatedKey', 'scanResponse_lastEvaluatedKey' - 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.
--
-- 'scannedCount', 'scanResponse_scannedCount' - 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
-- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count 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@.
--
-- 'httpStatus', 'scanResponse_httpStatus' - The response's http status code.
newScanResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ScanResponse
newScanResponse :: Int -> ScanResponse
newScanResponse Int
pHttpStatus_ =
  ScanResponse'
    { $sel:consumedCapacity:ScanResponse' :: Maybe ConsumedCapacity
consumedCapacity = forall a. Maybe a
Prelude.Nothing,
      $sel:count:ScanResponse' :: Maybe Int
count = forall a. Maybe a
Prelude.Nothing,
      $sel:items:ScanResponse' :: Maybe [HashMap Text AttributeValue]
items = forall a. Maybe a
Prelude.Nothing,
      $sel:lastEvaluatedKey:ScanResponse' :: Maybe (HashMap Text AttributeValue)
lastEvaluatedKey = forall a. Maybe a
Prelude.Nothing,
      $sel:scannedCount:ScanResponse' :: Maybe Int
scannedCount = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ScanResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | 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
-- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html Provisioned Throughput>
-- in the /Amazon DynamoDB Developer Guide/.
scanResponse_consumedCapacity :: Lens.Lens' ScanResponse (Prelude.Maybe ConsumedCapacity)
scanResponse_consumedCapacity :: Lens' ScanResponse (Maybe ConsumedCapacity)
scanResponse_consumedCapacity = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ScanResponse' {Maybe ConsumedCapacity
consumedCapacity :: Maybe ConsumedCapacity
$sel:consumedCapacity:ScanResponse' :: ScanResponse -> Maybe ConsumedCapacity
consumedCapacity} -> Maybe ConsumedCapacity
consumedCapacity) (\s :: ScanResponse
s@ScanResponse' {} Maybe ConsumedCapacity
a -> ScanResponse
s {$sel:consumedCapacity:ScanResponse' :: Maybe ConsumedCapacity
consumedCapacity = Maybe ConsumedCapacity
a} :: ScanResponse)

-- | 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@.
scanResponse_count :: Lens.Lens' ScanResponse (Prelude.Maybe Prelude.Int)
scanResponse_count :: Lens' ScanResponse (Maybe Int)
scanResponse_count = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ScanResponse' {Maybe Int
count :: Maybe Int
$sel:count:ScanResponse' :: ScanResponse -> Maybe Int
count} -> Maybe Int
count) (\s :: ScanResponse
s@ScanResponse' {} Maybe Int
a -> ScanResponse
s {$sel:count:ScanResponse' :: Maybe Int
count = Maybe Int
a} :: ScanResponse)

-- | 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.
scanResponse_items :: Lens.Lens' ScanResponse (Prelude.Maybe [Prelude.HashMap Prelude.Text AttributeValue])
scanResponse_items :: Lens' ScanResponse (Maybe [HashMap Text AttributeValue])
scanResponse_items = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ScanResponse' {Maybe [HashMap Text AttributeValue]
items :: Maybe [HashMap Text AttributeValue]
$sel:items:ScanResponse' :: ScanResponse -> Maybe [HashMap Text AttributeValue]
items} -> Maybe [HashMap Text AttributeValue]
items) (\s :: ScanResponse
s@ScanResponse' {} Maybe [HashMap Text AttributeValue]
a -> ScanResponse
s {$sel:items:ScanResponse' :: Maybe [HashMap Text AttributeValue]
items = Maybe [HashMap Text AttributeValue]
a} :: ScanResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | 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.
scanResponse_lastEvaluatedKey :: Lens.Lens' ScanResponse (Prelude.Maybe (Prelude.HashMap Prelude.Text AttributeValue))
scanResponse_lastEvaluatedKey :: Lens' ScanResponse (Maybe (HashMap Text AttributeValue))
scanResponse_lastEvaluatedKey = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ScanResponse' {Maybe (HashMap Text AttributeValue)
lastEvaluatedKey :: Maybe (HashMap Text AttributeValue)
$sel:lastEvaluatedKey:ScanResponse' :: ScanResponse -> Maybe (HashMap Text AttributeValue)
lastEvaluatedKey} -> Maybe (HashMap Text AttributeValue)
lastEvaluatedKey) (\s :: ScanResponse
s@ScanResponse' {} Maybe (HashMap Text AttributeValue)
a -> ScanResponse
s {$sel:lastEvaluatedKey:ScanResponse' :: Maybe (HashMap Text AttributeValue)
lastEvaluatedKey = Maybe (HashMap Text AttributeValue)
a} :: ScanResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | 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
-- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count 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@.
scanResponse_scannedCount :: Lens.Lens' ScanResponse (Prelude.Maybe Prelude.Int)
scanResponse_scannedCount :: Lens' ScanResponse (Maybe Int)
scanResponse_scannedCount = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ScanResponse' {Maybe Int
scannedCount :: Maybe Int
$sel:scannedCount:ScanResponse' :: ScanResponse -> Maybe Int
scannedCount} -> Maybe Int
scannedCount) (\s :: ScanResponse
s@ScanResponse' {} Maybe Int
a -> ScanResponse
s {$sel:scannedCount:ScanResponse' :: Maybe Int
scannedCount = Maybe Int
a} :: ScanResponse)

-- | The response's http status code.
scanResponse_httpStatus :: Lens.Lens' ScanResponse Prelude.Int
scanResponse_httpStatus :: Lens' ScanResponse Int
scanResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ScanResponse' {Int
httpStatus :: Int
$sel:httpStatus:ScanResponse' :: ScanResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: ScanResponse
s@ScanResponse' {} Int
a -> ScanResponse
s {$sel:httpStatus:ScanResponse' :: Int
httpStatus = Int
a} :: ScanResponse)

instance Prelude.NFData ScanResponse where
  rnf :: ScanResponse -> ()
rnf ScanResponse' {Int
Maybe Int
Maybe [HashMap Text AttributeValue]
Maybe (HashMap Text AttributeValue)
Maybe ConsumedCapacity
httpStatus :: Int
scannedCount :: Maybe Int
lastEvaluatedKey :: Maybe (HashMap Text AttributeValue)
items :: Maybe [HashMap Text AttributeValue]
count :: Maybe Int
consumedCapacity :: Maybe ConsumedCapacity
$sel:httpStatus:ScanResponse' :: ScanResponse -> Int
$sel:scannedCount:ScanResponse' :: ScanResponse -> Maybe Int
$sel:lastEvaluatedKey:ScanResponse' :: ScanResponse -> Maybe (HashMap Text AttributeValue)
$sel:items:ScanResponse' :: ScanResponse -> Maybe [HashMap Text AttributeValue]
$sel:count:ScanResponse' :: ScanResponse -> Maybe Int
$sel:consumedCapacity:ScanResponse' :: ScanResponse -> Maybe ConsumedCapacity
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe ConsumedCapacity
consumedCapacity
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
count
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [HashMap Text AttributeValue]
items
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (HashMap Text AttributeValue)
lastEvaluatedKey
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
scannedCount
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus