{-# 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.Query -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- You must provide the name of the partition key attribute and a single -- value for that attribute. @Query@ returns all items with that partition -- key value. Optionally, you can provide a sort key attribute and use a -- comparison operator to refine the search results. -- -- Use the @KeyConditionExpression@ parameter to provide a specific value -- for the partition key. The @Query@ operation will return all of the -- items from the table or index with that partition key value. You can -- optionally narrow the scope of the @Query@ operation by specifying a -- sort key value and a comparison operator in @KeyConditionExpression@. To -- further refine the @Query@ results, you can optionally provide a -- @FilterExpression@. A @FilterExpression@ determines which items within -- the results should be returned to you. All of the other results are -- discarded. -- -- A @Query@ operation always returns a result set. If no matching items -- are found, the result set will be empty. Queries that do not return -- results consume the minimum number of read capacity units for that type -- of read operation. -- -- DynamoDB calculates the number of read capacity units consumed based on -- item size, not on the amount of data that is returned to an application. -- The number of capacity units consumed will be the same whether you -- request all of the attributes (the default behavior) or just some of -- them (using a projection expression). The number will also be the same -- whether or not you use a @FilterExpression@. -- -- @Query@ results are always sorted by the sort key value. If the data -- type of the sort key is Number, the results are returned in numeric -- order; otherwise, the results are returned in order of UTF-8 bytes. By -- default, the sort order is ascending. To reverse the order, set the -- @ScanIndexForward@ parameter to false. -- -- A single @Query@ 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 -- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.Pagination Paginating the Results> -- in the /Amazon DynamoDB Developer Guide/. -- -- @FilterExpression@ is applied after a @Query@ finishes, but before the -- results are returned. A @FilterExpression@ cannot contain partition key -- or sort key attributes. You need to specify those attributes in the -- @KeyConditionExpression@. -- -- A @Query@ operation can return an empty result set and a -- @LastEvaluatedKey@ if all the items read for the page of results are -- filtered out. -- -- You can query a table, a local secondary index, or a global secondary -- index. For a query on a table or on a local secondary index, you can set -- the @ConsistentRead@ parameter to @true@ and obtain a strongly -- consistent result. Global secondary indexes support eventually -- consistent reads only, so do not specify @ConsistentRead@ when querying -- a global secondary index. -- -- This operation returns paginated results. module Amazonka.DynamoDB.Query ( -- * Creating a Request Query (..), newQuery, -- * Request Lenses query_attributesToGet, query_conditionalOperator, query_consistentRead, query_exclusiveStartKey, query_expressionAttributeNames, query_expressionAttributeValues, query_filterExpression, query_indexName, query_keyConditionExpression, query_keyConditions, query_limit, query_projectionExpression, query_queryFilter, query_returnConsumedCapacity, query_scanIndexForward, query_select, query_tableName, -- * Destructuring the Response QueryResponse (..), newQueryResponse, -- * Response Lenses queryResponse_consumedCapacity, queryResponse_count, queryResponse_lastEvaluatedKey, queryResponse_scannedCount, queryResponse_httpStatus, queryResponse_items, ) 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 @Query@ operation. -- -- /See:/ 'newQuery' smart constructor. data Query = Query' { -- | 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/. Query -> 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/. Query -> Maybe ConditionalOperator conditionalOperator :: Prelude.Maybe ConditionalOperator, -- | Determines the read consistency model: If set to @true@, then the -- operation uses strongly consistent reads; otherwise, the operation uses -- eventually consistent reads. -- -- Strongly consistent reads are not supported on global secondary indexes. -- If you query a global secondary index with @ConsistentRead@ set to -- @true@, you will receive a @ValidationException@. Query -> 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. Query -> 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/. Query -> 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 Specifying Conditions> -- in the /Amazon DynamoDB Developer Guide/. Query -> Maybe (HashMap Text AttributeValue) expressionAttributeValues :: Prelude.Maybe (Prelude.HashMap Prelude.Text AttributeValue), -- | A string that contains conditions that DynamoDB applies after the -- @Query@ operation, but before the data is returned to you. Items that do -- not satisfy the @FilterExpression@ criteria are not returned. -- -- A @FilterExpression@ does not allow key attributes. You cannot define a -- filter expression based on a partition key or a sort key. -- -- 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/. Query -> Maybe Text filterExpression :: Prelude.Maybe Prelude.Text, -- | The name of an index to query. This index can be any local secondary -- index or global secondary index on the table. Note that if you use the -- @IndexName@ parameter, you must also provide @TableName.@ Query -> Maybe Text indexName :: Prelude.Maybe Prelude.Text, -- | The condition that specifies the key values for items to be retrieved by -- the @Query@ action. -- -- The condition must perform an equality test on a single partition key -- value. -- -- The condition can optionally perform one of several comparison tests on -- a single sort key value. This allows @Query@ to retrieve one item with a -- given partition key value and sort key value, or several items that have -- the same partition key value but different sort key values. -- -- The partition key equality test is required, and must be specified in -- the following format: -- -- @partitionKeyName@ /=/ @:partitionkeyval@ -- -- If you also want to provide a condition for the sort key, it must be -- combined using @AND@ with the condition for the sort key. Following is -- an example, using the __=__ comparison operator for the sort key: -- -- @partitionKeyName@ @=@ @:partitionkeyval@ @AND@ @sortKeyName@ @=@ -- @:sortkeyval@ -- -- Valid comparisons for the sort key condition are as follows: -- -- - @sortKeyName@ @=@ @:sortkeyval@ - true if the sort key value is -- equal to @:sortkeyval@. -- -- - @sortKeyName@ @\<@ @:sortkeyval@ - true if the sort key value is -- less than @:sortkeyval@. -- -- - @sortKeyName@ @\<=@ @:sortkeyval@ - true if the sort key value is -- less than or equal to @:sortkeyval@. -- -- - @sortKeyName@ @>@ @:sortkeyval@ - true if the sort key value is -- greater than @:sortkeyval@. -- -- - @sortKeyName@ @>= @ @:sortkeyval@ - true if the sort key value is -- greater than or equal to @:sortkeyval@. -- -- - @sortKeyName@ @BETWEEN@ @:sortkeyval1@ @AND@ @:sortkeyval2@ - true -- if the sort key value is greater than or equal to @:sortkeyval1@, -- and less than or equal to @:sortkeyval2@. -- -- - @begins_with (@ @sortKeyName@, @:sortkeyval@ @)@ - true if the sort -- key value begins with a particular operand. (You cannot use this -- function with a sort key that is of type Number.) Note that the -- function name @begins_with@ is case-sensitive. -- -- Use the @ExpressionAttributeValues@ parameter to replace tokens such as -- @:partitionval@ and @:sortval@ with actual values at runtime. -- -- You can optionally use the @ExpressionAttributeNames@ parameter to -- replace the names of the partition key and sort key with placeholder -- tokens. This option might be necessary if an attribute name conflicts -- with a DynamoDB reserved word. For example, the following -- @KeyConditionExpression@ parameter causes an error because /Size/ is a -- reserved word: -- -- - @Size = :myval@ -- -- To work around this, define a placeholder (such a @#S@) to represent the -- attribute name /Size/. @KeyConditionExpression@ then is as follows: -- -- - @#S = :myval@ -- -- For a list of reserved words, see -- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html Reserved Words> -- in the /Amazon DynamoDB Developer Guide/. -- -- For more information on @ExpressionAttributeNames@ and -- @ExpressionAttributeValues@, see -- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ExpressionPlaceholders.html Using Placeholders for Attribute Names and Values> -- in the /Amazon DynamoDB Developer Guide/. Query -> Maybe Text keyConditionExpression :: Prelude.Maybe Prelude.Text, -- | This is a legacy parameter. Use @KeyConditionExpression@ instead. For -- more information, see -- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.KeyConditions.html KeyConditions> -- in the /Amazon DynamoDB Developer Guide/. Query -> Maybe (HashMap Text Condition) keyConditions :: Prelude.Maybe (Prelude.HashMap Prelude.Text Condition), -- | 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 Query and Scan> -- in the /Amazon DynamoDB Developer Guide/. Query -> Maybe Natural limit :: Prelude.Maybe Prelude.Natural, -- | A string that identifies one or more attributes to retrieve from the -- table. 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 Accessing Item Attributes> -- in the /Amazon DynamoDB Developer Guide/. Query -> Maybe Text projectionExpression :: Prelude.Maybe Prelude.Text, -- | This is a legacy parameter. Use @FilterExpression@ instead. For more -- information, see -- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.QueryFilter.html QueryFilter> -- in the /Amazon DynamoDB Developer Guide/. Query -> Maybe (HashMap Text Condition) queryFilter :: Prelude.Maybe (Prelude.HashMap Prelude.Text Condition), Query -> Maybe ReturnConsumedCapacity returnConsumedCapacity :: Prelude.Maybe ReturnConsumedCapacity, -- | Specifies the order for index traversal: If @true@ (default), the -- traversal is performed in ascending order; if @false@, the traversal is -- performed in descending order. -- -- Items with the same partition key value are stored in sorted order by -- sort key. If the sort key data type is Number, the results are stored in -- numeric order. For type String, the results are stored in order of UTF-8 -- bytes. For type Binary, DynamoDB treats each byte of the binary data as -- unsigned. -- -- If @ScanIndexForward@ is @true@, DynamoDB returns the results in the -- order in which they are stored (by sort key value). This is the default -- behavior. If @ScanIndexForward@ is @false@, DynamoDB reads the results -- in reverse order by sort key value, and then returns the results to the -- client. Query -> Maybe Bool scanIndexForward :: Prelude.Maybe Prelude.Bool, -- | 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 will -- read 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. Query -> Maybe Select select :: Prelude.Maybe Select, -- | The name of the table containing the requested items. Query -> Text tableName :: Prelude.Text } deriving (Query -> Query -> Bool forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a /= :: Query -> Query -> Bool $c/= :: Query -> Query -> Bool == :: Query -> Query -> Bool $c== :: Query -> Query -> Bool Prelude.Eq, ReadPrec [Query] ReadPrec Query Int -> ReadS Query ReadS [Query] forall a. (Int -> ReadS a) -> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a readListPrec :: ReadPrec [Query] $creadListPrec :: ReadPrec [Query] readPrec :: ReadPrec Query $creadPrec :: ReadPrec Query readList :: ReadS [Query] $creadList :: ReadS [Query] readsPrec :: Int -> ReadS Query $creadsPrec :: Int -> ReadS Query Prelude.Read, Int -> Query -> ShowS [Query] -> ShowS Query -> String forall a. (Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a showList :: [Query] -> ShowS $cshowList :: [Query] -> ShowS show :: Query -> String $cshow :: Query -> String showsPrec :: Int -> Query -> ShowS $cshowsPrec :: Int -> Query -> ShowS Prelude.Show, forall x. Rep Query x -> Query forall x. Query -> Rep Query x forall a. (forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a $cto :: forall x. Rep Query x -> Query $cfrom :: forall x. Query -> Rep Query x Prelude.Generic) -- | -- Create a value of 'Query' 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', 'query_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', 'query_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', 'query_consistentRead' - Determines the read consistency model: If set to @true@, then the -- operation uses strongly consistent reads; otherwise, the operation uses -- eventually consistent reads. -- -- Strongly consistent reads are not supported on global secondary indexes. -- If you query a global secondary index with @ConsistentRead@ set to -- @true@, you will receive a @ValidationException@. -- -- 'exclusiveStartKey', 'query_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. -- -- 'expressionAttributeNames', 'query_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', 'query_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 Specifying Conditions> -- in the /Amazon DynamoDB Developer Guide/. -- -- 'filterExpression', 'query_filterExpression' - A string that contains conditions that DynamoDB applies after the -- @Query@ operation, but before the data is returned to you. Items that do -- not satisfy the @FilterExpression@ criteria are not returned. -- -- A @FilterExpression@ does not allow key attributes. You cannot define a -- filter expression based on a partition key or a sort key. -- -- 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', 'query_indexName' - The name of an index to query. This index can be any local secondary -- index or global secondary index on the table. Note that if you use the -- @IndexName@ parameter, you must also provide @TableName.@ -- -- 'keyConditionExpression', 'query_keyConditionExpression' - The condition that specifies the key values for items to be retrieved by -- the @Query@ action. -- -- The condition must perform an equality test on a single partition key -- value. -- -- The condition can optionally perform one of several comparison tests on -- a single sort key value. This allows @Query@ to retrieve one item with a -- given partition key value and sort key value, or several items that have -- the same partition key value but different sort key values. -- -- The partition key equality test is required, and must be specified in -- the following format: -- -- @partitionKeyName@ /=/ @:partitionkeyval@ -- -- If you also want to provide a condition for the sort key, it must be -- combined using @AND@ with the condition for the sort key. Following is -- an example, using the __=__ comparison operator for the sort key: -- -- @partitionKeyName@ @=@ @:partitionkeyval@ @AND@ @sortKeyName@ @=@ -- @:sortkeyval@ -- -- Valid comparisons for the sort key condition are as follows: -- -- - @sortKeyName@ @=@ @:sortkeyval@ - true if the sort key value is -- equal to @:sortkeyval@. -- -- - @sortKeyName@ @\<@ @:sortkeyval@ - true if the sort key value is -- less than @:sortkeyval@. -- -- - @sortKeyName@ @\<=@ @:sortkeyval@ - true if the sort key value is -- less than or equal to @:sortkeyval@. -- -- - @sortKeyName@ @>@ @:sortkeyval@ - true if the sort key value is -- greater than @:sortkeyval@. -- -- - @sortKeyName@ @>= @ @:sortkeyval@ - true if the sort key value is -- greater than or equal to @:sortkeyval@. -- -- - @sortKeyName@ @BETWEEN@ @:sortkeyval1@ @AND@ @:sortkeyval2@ - true -- if the sort key value is greater than or equal to @:sortkeyval1@, -- and less than or equal to @:sortkeyval2@. -- -- - @begins_with (@ @sortKeyName@, @:sortkeyval@ @)@ - true if the sort -- key value begins with a particular operand. (You cannot use this -- function with a sort key that is of type Number.) Note that the -- function name @begins_with@ is case-sensitive. -- -- Use the @ExpressionAttributeValues@ parameter to replace tokens such as -- @:partitionval@ and @:sortval@ with actual values at runtime. -- -- You can optionally use the @ExpressionAttributeNames@ parameter to -- replace the names of the partition key and sort key with placeholder -- tokens. This option might be necessary if an attribute name conflicts -- with a DynamoDB reserved word. For example, the following -- @KeyConditionExpression@ parameter causes an error because /Size/ is a -- reserved word: -- -- - @Size = :myval@ -- -- To work around this, define a placeholder (such a @#S@) to represent the -- attribute name /Size/. @KeyConditionExpression@ then is as follows: -- -- - @#S = :myval@ -- -- For a list of reserved words, see -- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html Reserved Words> -- in the /Amazon DynamoDB Developer Guide/. -- -- For more information on @ExpressionAttributeNames@ and -- @ExpressionAttributeValues@, see -- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ExpressionPlaceholders.html Using Placeholders for Attribute Names and Values> -- in the /Amazon DynamoDB Developer Guide/. -- -- 'keyConditions', 'query_keyConditions' - This is a legacy parameter. Use @KeyConditionExpression@ instead. For -- more information, see -- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.KeyConditions.html KeyConditions> -- in the /Amazon DynamoDB Developer Guide/. -- -- 'limit', 'query_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 Query and Scan> -- in the /Amazon DynamoDB Developer Guide/. -- -- 'projectionExpression', 'query_projectionExpression' - A string that identifies one or more attributes to retrieve from the -- table. 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 Accessing Item Attributes> -- in the /Amazon DynamoDB Developer Guide/. -- -- 'queryFilter', 'query_queryFilter' - This is a legacy parameter. Use @FilterExpression@ instead. For more -- information, see -- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.QueryFilter.html QueryFilter> -- in the /Amazon DynamoDB Developer Guide/. -- -- 'returnConsumedCapacity', 'query_returnConsumedCapacity' - Undocumented member. -- -- 'scanIndexForward', 'query_scanIndexForward' - Specifies the order for index traversal: If @true@ (default), the -- traversal is performed in ascending order; if @false@, the traversal is -- performed in descending order. -- -- Items with the same partition key value are stored in sorted order by -- sort key. If the sort key data type is Number, the results are stored in -- numeric order. For type String, the results are stored in order of UTF-8 -- bytes. For type Binary, DynamoDB treats each byte of the binary data as -- unsigned. -- -- If @ScanIndexForward@ is @true@, DynamoDB returns the results in the -- order in which they are stored (by sort key value). This is the default -- behavior. If @ScanIndexForward@ is @false@, DynamoDB reads the results -- in reverse order by sort key value, and then returns the results to the -- client. -- -- 'select', 'query_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 will -- read 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. -- -- 'tableName', 'query_tableName' - The name of the table containing the requested items. newQuery :: -- | 'tableName' Prelude.Text -> Query newQuery :: Text -> Query newQuery Text pTableName_ = Query' { $sel:attributesToGet:Query' :: Maybe (NonEmpty Text) attributesToGet = forall a. Maybe a Prelude.Nothing, $sel:conditionalOperator:Query' :: Maybe ConditionalOperator conditionalOperator = forall a. Maybe a Prelude.Nothing, $sel:consistentRead:Query' :: Maybe Bool consistentRead = forall a. Maybe a Prelude.Nothing, $sel:exclusiveStartKey:Query' :: Maybe (HashMap Text AttributeValue) exclusiveStartKey = forall a. Maybe a Prelude.Nothing, $sel:expressionAttributeNames:Query' :: Maybe (HashMap Text Text) expressionAttributeNames = forall a. Maybe a Prelude.Nothing, $sel:expressionAttributeValues:Query' :: Maybe (HashMap Text AttributeValue) expressionAttributeValues = forall a. Maybe a Prelude.Nothing, $sel:filterExpression:Query' :: Maybe Text filterExpression = forall a. Maybe a Prelude.Nothing, $sel:indexName:Query' :: Maybe Text indexName = forall a. Maybe a Prelude.Nothing, $sel:keyConditionExpression:Query' :: Maybe Text keyConditionExpression = forall a. Maybe a Prelude.Nothing, $sel:keyConditions:Query' :: Maybe (HashMap Text Condition) keyConditions = forall a. Maybe a Prelude.Nothing, $sel:limit:Query' :: Maybe Natural limit = forall a. Maybe a Prelude.Nothing, $sel:projectionExpression:Query' :: Maybe Text projectionExpression = forall a. Maybe a Prelude.Nothing, $sel:queryFilter:Query' :: Maybe (HashMap Text Condition) queryFilter = forall a. Maybe a Prelude.Nothing, $sel:returnConsumedCapacity:Query' :: Maybe ReturnConsumedCapacity returnConsumedCapacity = forall a. Maybe a Prelude.Nothing, $sel:scanIndexForward:Query' :: Maybe Bool scanIndexForward = forall a. Maybe a Prelude.Nothing, $sel:select:Query' :: Maybe Select select = forall a. Maybe a Prelude.Nothing, $sel:tableName:Query' :: 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/. query_attributesToGet :: Lens.Lens' Query (Prelude.Maybe (Prelude.NonEmpty Prelude.Text)) query_attributesToGet :: Lens' Query (Maybe (NonEmpty Text)) query_attributesToGet = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\Query' {Maybe (NonEmpty Text) attributesToGet :: Maybe (NonEmpty Text) $sel:attributesToGet:Query' :: Query -> Maybe (NonEmpty Text) attributesToGet} -> Maybe (NonEmpty Text) attributesToGet) (\s :: Query s@Query' {} Maybe (NonEmpty Text) a -> Query s {$sel:attributesToGet:Query' :: Maybe (NonEmpty Text) attributesToGet = Maybe (NonEmpty Text) a} :: Query) 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/. query_conditionalOperator :: Lens.Lens' Query (Prelude.Maybe ConditionalOperator) query_conditionalOperator :: Lens' Query (Maybe ConditionalOperator) query_conditionalOperator = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\Query' {Maybe ConditionalOperator conditionalOperator :: Maybe ConditionalOperator $sel:conditionalOperator:Query' :: Query -> Maybe ConditionalOperator conditionalOperator} -> Maybe ConditionalOperator conditionalOperator) (\s :: Query s@Query' {} Maybe ConditionalOperator a -> Query s {$sel:conditionalOperator:Query' :: Maybe ConditionalOperator conditionalOperator = Maybe ConditionalOperator a} :: Query) -- | Determines the read consistency model: If set to @true@, then the -- operation uses strongly consistent reads; otherwise, the operation uses -- eventually consistent reads. -- -- Strongly consistent reads are not supported on global secondary indexes. -- If you query a global secondary index with @ConsistentRead@ set to -- @true@, you will receive a @ValidationException@. query_consistentRead :: Lens.Lens' Query (Prelude.Maybe Prelude.Bool) query_consistentRead :: Lens' Query (Maybe Bool) query_consistentRead = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\Query' {Maybe Bool consistentRead :: Maybe Bool $sel:consistentRead:Query' :: Query -> Maybe Bool consistentRead} -> Maybe Bool consistentRead) (\s :: Query s@Query' {} Maybe Bool a -> Query s {$sel:consistentRead:Query' :: Maybe Bool consistentRead = Maybe Bool a} :: Query) -- | 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. query_exclusiveStartKey :: Lens.Lens' Query (Prelude.Maybe (Prelude.HashMap Prelude.Text AttributeValue)) query_exclusiveStartKey :: Lens' Query (Maybe (HashMap Text AttributeValue)) query_exclusiveStartKey = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\Query' {Maybe (HashMap Text AttributeValue) exclusiveStartKey :: Maybe (HashMap Text AttributeValue) $sel:exclusiveStartKey:Query' :: Query -> Maybe (HashMap Text AttributeValue) exclusiveStartKey} -> Maybe (HashMap Text AttributeValue) exclusiveStartKey) (\s :: Query s@Query' {} Maybe (HashMap Text AttributeValue) a -> Query s {$sel:exclusiveStartKey:Query' :: Maybe (HashMap Text AttributeValue) exclusiveStartKey = Maybe (HashMap Text AttributeValue) a} :: Query) 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/. query_expressionAttributeNames :: Lens.Lens' Query (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text)) query_expressionAttributeNames :: Lens' Query (Maybe (HashMap Text Text)) query_expressionAttributeNames = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\Query' {Maybe (HashMap Text Text) expressionAttributeNames :: Maybe (HashMap Text Text) $sel:expressionAttributeNames:Query' :: Query -> Maybe (HashMap Text Text) expressionAttributeNames} -> Maybe (HashMap Text Text) expressionAttributeNames) (\s :: Query s@Query' {} Maybe (HashMap Text Text) a -> Query s {$sel:expressionAttributeNames:Query' :: Maybe (HashMap Text Text) expressionAttributeNames = Maybe (HashMap Text Text) a} :: Query) 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 Specifying Conditions> -- in the /Amazon DynamoDB Developer Guide/. query_expressionAttributeValues :: Lens.Lens' Query (Prelude.Maybe (Prelude.HashMap Prelude.Text AttributeValue)) query_expressionAttributeValues :: Lens' Query (Maybe (HashMap Text AttributeValue)) query_expressionAttributeValues = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\Query' {Maybe (HashMap Text AttributeValue) expressionAttributeValues :: Maybe (HashMap Text AttributeValue) $sel:expressionAttributeValues:Query' :: Query -> Maybe (HashMap Text AttributeValue) expressionAttributeValues} -> Maybe (HashMap Text AttributeValue) expressionAttributeValues) (\s :: Query s@Query' {} Maybe (HashMap Text AttributeValue) a -> Query s {$sel:expressionAttributeValues:Query' :: Maybe (HashMap Text AttributeValue) expressionAttributeValues = Maybe (HashMap Text AttributeValue) a} :: Query) 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 -- @Query@ operation, but before the data is returned to you. Items that do -- not satisfy the @FilterExpression@ criteria are not returned. -- -- A @FilterExpression@ does not allow key attributes. You cannot define a -- filter expression based on a partition key or a sort key. -- -- 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/. query_filterExpression :: Lens.Lens' Query (Prelude.Maybe Prelude.Text) query_filterExpression :: Lens' Query (Maybe Text) query_filterExpression = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\Query' {Maybe Text filterExpression :: Maybe Text $sel:filterExpression:Query' :: Query -> Maybe Text filterExpression} -> Maybe Text filterExpression) (\s :: Query s@Query' {} Maybe Text a -> Query s {$sel:filterExpression:Query' :: Maybe Text filterExpression = Maybe Text a} :: Query) -- | The name of an index to query. This index can be any local secondary -- index or global secondary index on the table. Note that if you use the -- @IndexName@ parameter, you must also provide @TableName.@ query_indexName :: Lens.Lens' Query (Prelude.Maybe Prelude.Text) query_indexName :: Lens' Query (Maybe Text) query_indexName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\Query' {Maybe Text indexName :: Maybe Text $sel:indexName:Query' :: Query -> Maybe Text indexName} -> Maybe Text indexName) (\s :: Query s@Query' {} Maybe Text a -> Query s {$sel:indexName:Query' :: Maybe Text indexName = Maybe Text a} :: Query) -- | The condition that specifies the key values for items to be retrieved by -- the @Query@ action. -- -- The condition must perform an equality test on a single partition key -- value. -- -- The condition can optionally perform one of several comparison tests on -- a single sort key value. This allows @Query@ to retrieve one item with a -- given partition key value and sort key value, or several items that have -- the same partition key value but different sort key values. -- -- The partition key equality test is required, and must be specified in -- the following format: -- -- @partitionKeyName@ /=/ @:partitionkeyval@ -- -- If you also want to provide a condition for the sort key, it must be -- combined using @AND@ with the condition for the sort key. Following is -- an example, using the __=__ comparison operator for the sort key: -- -- @partitionKeyName@ @=@ @:partitionkeyval@ @AND@ @sortKeyName@ @=@ -- @:sortkeyval@ -- -- Valid comparisons for the sort key condition are as follows: -- -- - @sortKeyName@ @=@ @:sortkeyval@ - true if the sort key value is -- equal to @:sortkeyval@. -- -- - @sortKeyName@ @\<@ @:sortkeyval@ - true if the sort key value is -- less than @:sortkeyval@. -- -- - @sortKeyName@ @\<=@ @:sortkeyval@ - true if the sort key value is -- less than or equal to @:sortkeyval@. -- -- - @sortKeyName@ @>@ @:sortkeyval@ - true if the sort key value is -- greater than @:sortkeyval@. -- -- - @sortKeyName@ @>= @ @:sortkeyval@ - true if the sort key value is -- greater than or equal to @:sortkeyval@. -- -- - @sortKeyName@ @BETWEEN@ @:sortkeyval1@ @AND@ @:sortkeyval2@ - true -- if the sort key value is greater than or equal to @:sortkeyval1@, -- and less than or equal to @:sortkeyval2@. -- -- - @begins_with (@ @sortKeyName@, @:sortkeyval@ @)@ - true if the sort -- key value begins with a particular operand. (You cannot use this -- function with a sort key that is of type Number.) Note that the -- function name @begins_with@ is case-sensitive. -- -- Use the @ExpressionAttributeValues@ parameter to replace tokens such as -- @:partitionval@ and @:sortval@ with actual values at runtime. -- -- You can optionally use the @ExpressionAttributeNames@ parameter to -- replace the names of the partition key and sort key with placeholder -- tokens. This option might be necessary if an attribute name conflicts -- with a DynamoDB reserved word. For example, the following -- @KeyConditionExpression@ parameter causes an error because /Size/ is a -- reserved word: -- -- - @Size = :myval@ -- -- To work around this, define a placeholder (such a @#S@) to represent the -- attribute name /Size/. @KeyConditionExpression@ then is as follows: -- -- - @#S = :myval@ -- -- For a list of reserved words, see -- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html Reserved Words> -- in the /Amazon DynamoDB Developer Guide/. -- -- For more information on @ExpressionAttributeNames@ and -- @ExpressionAttributeValues@, see -- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ExpressionPlaceholders.html Using Placeholders for Attribute Names and Values> -- in the /Amazon DynamoDB Developer Guide/. query_keyConditionExpression :: Lens.Lens' Query (Prelude.Maybe Prelude.Text) query_keyConditionExpression :: Lens' Query (Maybe Text) query_keyConditionExpression = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\Query' {Maybe Text keyConditionExpression :: Maybe Text $sel:keyConditionExpression:Query' :: Query -> Maybe Text keyConditionExpression} -> Maybe Text keyConditionExpression) (\s :: Query s@Query' {} Maybe Text a -> Query s {$sel:keyConditionExpression:Query' :: Maybe Text keyConditionExpression = Maybe Text a} :: Query) -- | This is a legacy parameter. Use @KeyConditionExpression@ instead. For -- more information, see -- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.KeyConditions.html KeyConditions> -- in the /Amazon DynamoDB Developer Guide/. query_keyConditions :: Lens.Lens' Query (Prelude.Maybe (Prelude.HashMap Prelude.Text Condition)) query_keyConditions :: Lens' Query (Maybe (HashMap Text Condition)) query_keyConditions = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\Query' {Maybe (HashMap Text Condition) keyConditions :: Maybe (HashMap Text Condition) $sel:keyConditions:Query' :: Query -> Maybe (HashMap Text Condition) keyConditions} -> Maybe (HashMap Text Condition) keyConditions) (\s :: Query s@Query' {} Maybe (HashMap Text Condition) a -> Query s {$sel:keyConditions:Query' :: Maybe (HashMap Text Condition) keyConditions = Maybe (HashMap Text Condition) a} :: Query) 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 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 Query and Scan> -- in the /Amazon DynamoDB Developer Guide/. query_limit :: Lens.Lens' Query (Prelude.Maybe Prelude.Natural) query_limit :: Lens' Query (Maybe Natural) query_limit = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\Query' {Maybe Natural limit :: Maybe Natural $sel:limit:Query' :: Query -> Maybe Natural limit} -> Maybe Natural limit) (\s :: Query s@Query' {} Maybe Natural a -> Query s {$sel:limit:Query' :: Maybe Natural limit = Maybe Natural a} :: Query) -- | A string that identifies one or more attributes to retrieve from the -- table. 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 Accessing Item Attributes> -- in the /Amazon DynamoDB Developer Guide/. query_projectionExpression :: Lens.Lens' Query (Prelude.Maybe Prelude.Text) query_projectionExpression :: Lens' Query (Maybe Text) query_projectionExpression = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\Query' {Maybe Text projectionExpression :: Maybe Text $sel:projectionExpression:Query' :: Query -> Maybe Text projectionExpression} -> Maybe Text projectionExpression) (\s :: Query s@Query' {} Maybe Text a -> Query s {$sel:projectionExpression:Query' :: Maybe Text projectionExpression = Maybe Text a} :: Query) -- | This is a legacy parameter. Use @FilterExpression@ instead. For more -- information, see -- <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.QueryFilter.html QueryFilter> -- in the /Amazon DynamoDB Developer Guide/. query_queryFilter :: Lens.Lens' Query (Prelude.Maybe (Prelude.HashMap Prelude.Text Condition)) query_queryFilter :: Lens' Query (Maybe (HashMap Text Condition)) query_queryFilter = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\Query' {Maybe (HashMap Text Condition) queryFilter :: Maybe (HashMap Text Condition) $sel:queryFilter:Query' :: Query -> Maybe (HashMap Text Condition) queryFilter} -> Maybe (HashMap Text Condition) queryFilter) (\s :: Query s@Query' {} Maybe (HashMap Text Condition) a -> Query s {$sel:queryFilter:Query' :: Maybe (HashMap Text Condition) queryFilter = Maybe (HashMap Text Condition) a} :: Query) 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 -- | Undocumented member. query_returnConsumedCapacity :: Lens.Lens' Query (Prelude.Maybe ReturnConsumedCapacity) query_returnConsumedCapacity :: Lens' Query (Maybe ReturnConsumedCapacity) query_returnConsumedCapacity = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\Query' {Maybe ReturnConsumedCapacity returnConsumedCapacity :: Maybe ReturnConsumedCapacity $sel:returnConsumedCapacity:Query' :: Query -> Maybe ReturnConsumedCapacity returnConsumedCapacity} -> Maybe ReturnConsumedCapacity returnConsumedCapacity) (\s :: Query s@Query' {} Maybe ReturnConsumedCapacity a -> Query s {$sel:returnConsumedCapacity:Query' :: Maybe ReturnConsumedCapacity returnConsumedCapacity = Maybe ReturnConsumedCapacity a} :: Query) -- | Specifies the order for index traversal: If @true@ (default), the -- traversal is performed in ascending order; if @false@, the traversal is -- performed in descending order. -- -- Items with the same partition key value are stored in sorted order by -- sort key. If the sort key data type is Number, the results are stored in -- numeric order. For type String, the results are stored in order of UTF-8 -- bytes. For type Binary, DynamoDB treats each byte of the binary data as -- unsigned. -- -- If @ScanIndexForward@ is @true@, DynamoDB returns the results in the -- order in which they are stored (by sort key value). This is the default -- behavior. If @ScanIndexForward@ is @false@, DynamoDB reads the results -- in reverse order by sort key value, and then returns the results to the -- client. query_scanIndexForward :: Lens.Lens' Query (Prelude.Maybe Prelude.Bool) query_scanIndexForward :: Lens' Query (Maybe Bool) query_scanIndexForward = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\Query' {Maybe Bool scanIndexForward :: Maybe Bool $sel:scanIndexForward:Query' :: Query -> Maybe Bool scanIndexForward} -> Maybe Bool scanIndexForward) (\s :: Query s@Query' {} Maybe Bool a -> Query s {$sel:scanIndexForward:Query' :: Maybe Bool scanIndexForward = Maybe Bool a} :: Query) -- | 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 will -- read 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. query_select :: Lens.Lens' Query (Prelude.Maybe Select) query_select :: Lens' Query (Maybe Select) query_select = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\Query' {Maybe Select select :: Maybe Select $sel:select:Query' :: Query -> Maybe Select select} -> Maybe Select select) (\s :: Query s@Query' {} Maybe Select a -> Query s {$sel:select:Query' :: Maybe Select select = Maybe Select a} :: Query) -- | The name of the table containing the requested items. query_tableName :: Lens.Lens' Query Prelude.Text query_tableName :: Lens' Query Text query_tableName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\Query' {Text tableName :: Text $sel:tableName:Query' :: Query -> Text tableName} -> Text tableName) (\s :: Query s@Query' {} Text a -> Query s {$sel:tableName:Query' :: Text tableName = Text a} :: Query) instance Core.AWSPager Query where page :: Query -> AWSResponse Query -> Maybe Query page Query rq AWSResponse Query rs | forall a. AWSTruncated a => a -> Bool Core.stop ( AWSResponse Query rs forall s a. s -> Getting (First a) s a -> Maybe a Lens.^? Lens' QueryResponse (Maybe (HashMap Text AttributeValue)) queryResponse_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.$ Query rq forall a b. a -> (a -> b) -> b Prelude.& Lens' Query (Maybe (HashMap Text AttributeValue)) query_exclusiveStartKey forall s t a b. ASetter s t a b -> b -> s -> t Lens..~ AWSResponse Query rs forall s a. s -> Getting (First a) s a -> Maybe a Lens.^? Lens' QueryResponse (Maybe (HashMap Text AttributeValue)) queryResponse_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 Query where type AWSResponse Query = QueryResponse request :: (Service -> Service) -> Query -> Request Query 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 Query -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse Query))) 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 Int -> Int -> [HashMap Text AttributeValue] -> QueryResponse QueryResponse' 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 "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)) 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) ) instance Prelude.Hashable Query where hashWithSalt :: Int -> Query -> Int hashWithSalt Int _salt Query' {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 select :: Maybe Select scanIndexForward :: Maybe Bool returnConsumedCapacity :: Maybe ReturnConsumedCapacity queryFilter :: Maybe (HashMap Text Condition) projectionExpression :: Maybe Text limit :: Maybe Natural keyConditions :: Maybe (HashMap Text Condition) keyConditionExpression :: Maybe Text 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:Query' :: Query -> Text $sel:select:Query' :: Query -> Maybe Select $sel:scanIndexForward:Query' :: Query -> Maybe Bool $sel:returnConsumedCapacity:Query' :: Query -> Maybe ReturnConsumedCapacity $sel:queryFilter:Query' :: Query -> Maybe (HashMap Text Condition) $sel:projectionExpression:Query' :: Query -> Maybe Text $sel:limit:Query' :: Query -> Maybe Natural $sel:keyConditions:Query' :: Query -> Maybe (HashMap Text Condition) $sel:keyConditionExpression:Query' :: Query -> Maybe Text $sel:indexName:Query' :: Query -> Maybe Text $sel:filterExpression:Query' :: Query -> Maybe Text $sel:expressionAttributeValues:Query' :: Query -> Maybe (HashMap Text AttributeValue) $sel:expressionAttributeNames:Query' :: Query -> Maybe (HashMap Text Text) $sel:exclusiveStartKey:Query' :: Query -> Maybe (HashMap Text AttributeValue) $sel:consistentRead:Query' :: Query -> Maybe Bool $sel:conditionalOperator:Query' :: Query -> Maybe ConditionalOperator $sel:attributesToGet:Query' :: Query -> 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 Text keyConditionExpression forall a. Hashable a => Int -> a -> Int `Prelude.hashWithSalt` Maybe (HashMap Text Condition) keyConditions 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 (HashMap Text Condition) queryFilter forall a. Hashable a => Int -> a -> Int `Prelude.hashWithSalt` Maybe ReturnConsumedCapacity returnConsumedCapacity forall a. Hashable a => Int -> a -> Int `Prelude.hashWithSalt` Maybe Bool scanIndexForward forall a. Hashable a => Int -> a -> Int `Prelude.hashWithSalt` Maybe Select select forall a. Hashable a => Int -> a -> Int `Prelude.hashWithSalt` Text tableName instance Prelude.NFData Query where rnf :: Query -> () rnf Query' {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 select :: Maybe Select scanIndexForward :: Maybe Bool returnConsumedCapacity :: Maybe ReturnConsumedCapacity queryFilter :: Maybe (HashMap Text Condition) projectionExpression :: Maybe Text limit :: Maybe Natural keyConditions :: Maybe (HashMap Text Condition) keyConditionExpression :: Maybe Text 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:Query' :: Query -> Text $sel:select:Query' :: Query -> Maybe Select $sel:scanIndexForward:Query' :: Query -> Maybe Bool $sel:returnConsumedCapacity:Query' :: Query -> Maybe ReturnConsumedCapacity $sel:queryFilter:Query' :: Query -> Maybe (HashMap Text Condition) $sel:projectionExpression:Query' :: Query -> Maybe Text $sel:limit:Query' :: Query -> Maybe Natural $sel:keyConditions:Query' :: Query -> Maybe (HashMap Text Condition) $sel:keyConditionExpression:Query' :: Query -> Maybe Text $sel:indexName:Query' :: Query -> Maybe Text $sel:filterExpression:Query' :: Query -> Maybe Text $sel:expressionAttributeValues:Query' :: Query -> Maybe (HashMap Text AttributeValue) $sel:expressionAttributeNames:Query' :: Query -> Maybe (HashMap Text Text) $sel:exclusiveStartKey:Query' :: Query -> Maybe (HashMap Text AttributeValue) $sel:consistentRead:Query' :: Query -> Maybe Bool $sel:conditionalOperator:Query' :: Query -> Maybe ConditionalOperator $sel:attributesToGet:Query' :: Query -> 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 Text keyConditionExpression seq :: forall a b. a -> b -> b `Prelude.seq` forall a. NFData a => a -> () Prelude.rnf Maybe (HashMap Text Condition) keyConditions 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 (HashMap Text Condition) queryFilter 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 Bool scanIndexForward 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 Text tableName instance Data.ToHeaders Query where toHeaders :: Query -> 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.Query" :: 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 Query where toJSON :: Query -> Value toJSON Query' {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 select :: Maybe Select scanIndexForward :: Maybe Bool returnConsumedCapacity :: Maybe ReturnConsumedCapacity queryFilter :: Maybe (HashMap Text Condition) projectionExpression :: Maybe Text limit :: Maybe Natural keyConditions :: Maybe (HashMap Text Condition) keyConditionExpression :: Maybe Text 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:Query' :: Query -> Text $sel:select:Query' :: Query -> Maybe Select $sel:scanIndexForward:Query' :: Query -> Maybe Bool $sel:returnConsumedCapacity:Query' :: Query -> Maybe ReturnConsumedCapacity $sel:queryFilter:Query' :: Query -> Maybe (HashMap Text Condition) $sel:projectionExpression:Query' :: Query -> Maybe Text $sel:limit:Query' :: Query -> Maybe Natural $sel:keyConditions:Query' :: Query -> Maybe (HashMap Text Condition) $sel:keyConditionExpression:Query' :: Query -> Maybe Text $sel:indexName:Query' :: Query -> Maybe Text $sel:filterExpression:Query' :: Query -> Maybe Text $sel:expressionAttributeValues:Query' :: Query -> Maybe (HashMap Text AttributeValue) $sel:expressionAttributeNames:Query' :: Query -> Maybe (HashMap Text Text) $sel:exclusiveStartKey:Query' :: Query -> Maybe (HashMap Text AttributeValue) $sel:consistentRead:Query' :: Query -> Maybe Bool $sel:conditionalOperator:Query' :: Query -> Maybe ConditionalOperator $sel:attributesToGet:Query' :: Query -> 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 "KeyConditionExpression" 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 keyConditionExpression, (Key "KeyConditions" 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) keyConditions, (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 "QueryFilter" 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) queryFilter, (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 "ScanIndexForward" 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 scanIndexForward, (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, 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 Query where toPath :: Query -> ByteString toPath = forall a b. a -> b -> a Prelude.const ByteString "/" instance Data.ToQuery Query where toQuery :: Query -> QueryString toQuery = forall a b. a -> b -> a Prelude.const forall a. Monoid a => a Prelude.mempty -- | Represents the output of a @Query@ operation. -- -- /See:/ 'newQueryResponse' smart constructor. data QueryResponse = QueryResponse' { -- | The capacity units consumed by the @Query@ 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/. QueryResponse -> Maybe ConsumedCapacity consumedCapacity :: Prelude.Maybe ConsumedCapacity, -- | The number of items in the response. -- -- If you used a @QueryFilter@ 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@ and -- @ScannedCount@ are the same. QueryResponse -> Maybe Int count :: Prelude.Maybe Prelude.Int, -- | 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. QueryResponse -> Maybe (HashMap Text AttributeValue) lastEvaluatedKey :: Prelude.Maybe (Prelude.HashMap Prelude.Text AttributeValue), -- | The number of items evaluated, before any @QueryFilter@ is applied. A -- high @ScannedCount@ value with few, or no, @Count@ results indicates an -- inefficient @Query@ 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@. QueryResponse -> Maybe Int scannedCount :: Prelude.Maybe Prelude.Int, -- | The response's http status code. QueryResponse -> Int httpStatus :: Prelude.Int, -- | An array of item attributes that match the query criteria. Each element -- in this array consists of an attribute name and the value for that -- attribute. QueryResponse -> [HashMap Text AttributeValue] items :: [Prelude.HashMap Prelude.Text AttributeValue] } deriving (QueryResponse -> QueryResponse -> Bool forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a /= :: QueryResponse -> QueryResponse -> Bool $c/= :: QueryResponse -> QueryResponse -> Bool == :: QueryResponse -> QueryResponse -> Bool $c== :: QueryResponse -> QueryResponse -> Bool Prelude.Eq, ReadPrec [QueryResponse] ReadPrec QueryResponse Int -> ReadS QueryResponse ReadS [QueryResponse] forall a. (Int -> ReadS a) -> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a readListPrec :: ReadPrec [QueryResponse] $creadListPrec :: ReadPrec [QueryResponse] readPrec :: ReadPrec QueryResponse $creadPrec :: ReadPrec QueryResponse readList :: ReadS [QueryResponse] $creadList :: ReadS [QueryResponse] readsPrec :: Int -> ReadS QueryResponse $creadsPrec :: Int -> ReadS QueryResponse Prelude.Read, Int -> QueryResponse -> ShowS [QueryResponse] -> ShowS QueryResponse -> String forall a. (Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a showList :: [QueryResponse] -> ShowS $cshowList :: [QueryResponse] -> ShowS show :: QueryResponse -> String $cshow :: QueryResponse -> String showsPrec :: Int -> QueryResponse -> ShowS $cshowsPrec :: Int -> QueryResponse -> ShowS Prelude.Show, forall x. Rep QueryResponse x -> QueryResponse forall x. QueryResponse -> Rep QueryResponse x forall a. (forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a $cto :: forall x. Rep QueryResponse x -> QueryResponse $cfrom :: forall x. QueryResponse -> Rep QueryResponse x Prelude.Generic) -- | -- Create a value of 'QueryResponse' 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', 'queryResponse_consumedCapacity' - The capacity units consumed by the @Query@ 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', 'queryResponse_count' - The number of items in the response. -- -- If you used a @QueryFilter@ 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@ and -- @ScannedCount@ are the same. -- -- 'lastEvaluatedKey', 'queryResponse_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', 'queryResponse_scannedCount' - The number of items evaluated, before any @QueryFilter@ is applied. A -- high @ScannedCount@ value with few, or no, @Count@ results indicates an -- inefficient @Query@ 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', 'queryResponse_httpStatus' - The response's http status code. -- -- 'items', 'queryResponse_items' - An array of item attributes that match the query criteria. Each element -- in this array consists of an attribute name and the value for that -- attribute. newQueryResponse :: -- | 'httpStatus' Prelude.Int -> QueryResponse newQueryResponse :: Int -> QueryResponse newQueryResponse Int pHttpStatus_ = QueryResponse' { $sel:consumedCapacity:QueryResponse' :: Maybe ConsumedCapacity consumedCapacity = forall a. Maybe a Prelude.Nothing, $sel:count:QueryResponse' :: Maybe Int count = forall a. Maybe a Prelude.Nothing, $sel:lastEvaluatedKey:QueryResponse' :: Maybe (HashMap Text AttributeValue) lastEvaluatedKey = forall a. Maybe a Prelude.Nothing, $sel:scannedCount:QueryResponse' :: Maybe Int scannedCount = forall a. Maybe a Prelude.Nothing, $sel:httpStatus:QueryResponse' :: Int httpStatus = Int pHttpStatus_, $sel:items:QueryResponse' :: [HashMap Text AttributeValue] items = forall a. Monoid a => a Prelude.mempty } -- | The capacity units consumed by the @Query@ 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/. queryResponse_consumedCapacity :: Lens.Lens' QueryResponse (Prelude.Maybe ConsumedCapacity) queryResponse_consumedCapacity :: Lens' QueryResponse (Maybe ConsumedCapacity) queryResponse_consumedCapacity = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\QueryResponse' {Maybe ConsumedCapacity consumedCapacity :: Maybe ConsumedCapacity $sel:consumedCapacity:QueryResponse' :: QueryResponse -> Maybe ConsumedCapacity consumedCapacity} -> Maybe ConsumedCapacity consumedCapacity) (\s :: QueryResponse s@QueryResponse' {} Maybe ConsumedCapacity a -> QueryResponse s {$sel:consumedCapacity:QueryResponse' :: Maybe ConsumedCapacity consumedCapacity = Maybe ConsumedCapacity a} :: QueryResponse) -- | The number of items in the response. -- -- If you used a @QueryFilter@ 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@ and -- @ScannedCount@ are the same. queryResponse_count :: Lens.Lens' QueryResponse (Prelude.Maybe Prelude.Int) queryResponse_count :: Lens' QueryResponse (Maybe Int) queryResponse_count = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\QueryResponse' {Maybe Int count :: Maybe Int $sel:count:QueryResponse' :: QueryResponse -> Maybe Int count} -> Maybe Int count) (\s :: QueryResponse s@QueryResponse' {} Maybe Int a -> QueryResponse s {$sel:count:QueryResponse' :: Maybe Int count = Maybe Int a} :: QueryResponse) -- | 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. queryResponse_lastEvaluatedKey :: Lens.Lens' QueryResponse (Prelude.Maybe (Prelude.HashMap Prelude.Text AttributeValue)) queryResponse_lastEvaluatedKey :: Lens' QueryResponse (Maybe (HashMap Text AttributeValue)) queryResponse_lastEvaluatedKey = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\QueryResponse' {Maybe (HashMap Text AttributeValue) lastEvaluatedKey :: Maybe (HashMap Text AttributeValue) $sel:lastEvaluatedKey:QueryResponse' :: QueryResponse -> Maybe (HashMap Text AttributeValue) lastEvaluatedKey} -> Maybe (HashMap Text AttributeValue) lastEvaluatedKey) (\s :: QueryResponse s@QueryResponse' {} Maybe (HashMap Text AttributeValue) a -> QueryResponse s {$sel:lastEvaluatedKey:QueryResponse' :: Maybe (HashMap Text AttributeValue) lastEvaluatedKey = Maybe (HashMap Text AttributeValue) a} :: QueryResponse) 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 @QueryFilter@ is applied. A -- high @ScannedCount@ value with few, or no, @Count@ results indicates an -- inefficient @Query@ 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@. queryResponse_scannedCount :: Lens.Lens' QueryResponse (Prelude.Maybe Prelude.Int) queryResponse_scannedCount :: Lens' QueryResponse (Maybe Int) queryResponse_scannedCount = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\QueryResponse' {Maybe Int scannedCount :: Maybe Int $sel:scannedCount:QueryResponse' :: QueryResponse -> Maybe Int scannedCount} -> Maybe Int scannedCount) (\s :: QueryResponse s@QueryResponse' {} Maybe Int a -> QueryResponse s {$sel:scannedCount:QueryResponse' :: Maybe Int scannedCount = Maybe Int a} :: QueryResponse) -- | The response's http status code. queryResponse_httpStatus :: Lens.Lens' QueryResponse Prelude.Int queryResponse_httpStatus :: Lens' QueryResponse Int queryResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\QueryResponse' {Int httpStatus :: Int $sel:httpStatus:QueryResponse' :: QueryResponse -> Int httpStatus} -> Int httpStatus) (\s :: QueryResponse s@QueryResponse' {} Int a -> QueryResponse s {$sel:httpStatus:QueryResponse' :: Int httpStatus = Int a} :: QueryResponse) -- | An array of item attributes that match the query criteria. Each element -- in this array consists of an attribute name and the value for that -- attribute. queryResponse_items :: Lens.Lens' QueryResponse [Prelude.HashMap Prelude.Text AttributeValue] queryResponse_items :: Lens' QueryResponse [HashMap Text AttributeValue] queryResponse_items = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\QueryResponse' {[HashMap Text AttributeValue] items :: [HashMap Text AttributeValue] $sel:items:QueryResponse' :: QueryResponse -> [HashMap Text AttributeValue] items} -> [HashMap Text AttributeValue] items) (\s :: QueryResponse s@QueryResponse' {} [HashMap Text AttributeValue] a -> QueryResponse s {$sel:items:QueryResponse' :: [HashMap Text AttributeValue] items = [HashMap Text AttributeValue] a} :: QueryResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b Lens.coerced instance Prelude.NFData QueryResponse where rnf :: QueryResponse -> () rnf QueryResponse' {Int [HashMap Text AttributeValue] Maybe Int Maybe (HashMap Text AttributeValue) Maybe ConsumedCapacity items :: [HashMap Text AttributeValue] httpStatus :: Int scannedCount :: Maybe Int lastEvaluatedKey :: Maybe (HashMap Text AttributeValue) count :: Maybe Int consumedCapacity :: Maybe ConsumedCapacity $sel:items:QueryResponse' :: QueryResponse -> [HashMap Text AttributeValue] $sel:httpStatus:QueryResponse' :: QueryResponse -> Int $sel:scannedCount:QueryResponse' :: QueryResponse -> Maybe Int $sel:lastEvaluatedKey:QueryResponse' :: QueryResponse -> Maybe (HashMap Text AttributeValue) $sel:count:QueryResponse' :: QueryResponse -> Maybe Int $sel:consumedCapacity:QueryResponse' :: QueryResponse -> 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) 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 seq :: forall a b. a -> b -> b `Prelude.seq` forall a. NFData a => a -> () Prelude.rnf [HashMap Text AttributeValue] items