diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ ## Version -`1.4.5` +`1.5.0` ## Description diff --git a/amazonka-dynamodb.cabal b/amazonka-dynamodb.cabal --- a/amazonka-dynamodb.cabal +++ b/amazonka-dynamodb.cabal @@ -1,13 +1,13 @@ name: amazonka-dynamodb -version: 1.4.5 +version: 1.5.0 synopsis: Amazon DynamoDB SDK. homepage: https://github.com/brendanhay/amazonka bug-reports: https://github.com/brendanhay/amazonka/issues -license: OtherLicense +license: MPL-2.0 license-file: LICENSE author: Brendan Hay -maintainer: Brendan Hay -copyright: Copyright (c) 2013-2016 Brendan Hay +maintainer: Brendan Hay +copyright: Copyright (c) 2013-2017 Brendan Hay category: Network, AWS, Cloud, Distributed Computing build-type: Simple cabal-version: >= 1.10 @@ -29,14 +29,19 @@ to get started. source-repository head - type: git - location: git://github.com/brendanhay/amazonka.git + type: git + location: git://github.com/brendanhay/amazonka.git + subdir: amazonka-dynamodb library default-language: Haskell2010 hs-source-dirs: src gen - ghc-options: -Wall + ghc-options: + -Wall + -fwarn-incomplete-uni-patterns + -fwarn-incomplete-record-updates + -funbox-strict-fields exposed-modules: Network.AWS.DynamoDB @@ -47,14 +52,19 @@ , Network.AWS.DynamoDB.DeleteTable , Network.AWS.DynamoDB.DescribeLimits , Network.AWS.DynamoDB.DescribeTable + , Network.AWS.DynamoDB.DescribeTimeToLive , Network.AWS.DynamoDB.GetItem , Network.AWS.DynamoDB.ListTables + , Network.AWS.DynamoDB.ListTagsOfResource , Network.AWS.DynamoDB.PutItem , Network.AWS.DynamoDB.Query , Network.AWS.DynamoDB.Scan + , Network.AWS.DynamoDB.TagResource , Network.AWS.DynamoDB.Types + , Network.AWS.DynamoDB.UntagResource , Network.AWS.DynamoDB.UpdateItem , Network.AWS.DynamoDB.UpdateTable + , Network.AWS.DynamoDB.UpdateTimeToLive , Network.AWS.DynamoDB.Waiters other-modules: @@ -62,7 +72,7 @@ , Network.AWS.DynamoDB.Types.Sum build-depends: - amazonka-core == 1.4.5.* + amazonka-core == 1.5.0.* , base >= 4.7 && < 5 test-suite amazonka-dynamodb-test @@ -82,9 +92,9 @@ , Test.AWS.DynamoDB.Internal build-depends: - amazonka-core == 1.4.5.* - , amazonka-test == 1.4.5.* - , amazonka-dynamodb == 1.4.5.* + amazonka-core == 1.5.0.* + , amazonka-test == 1.5.0.* + , amazonka-dynamodb , base , bytestring , tasty diff --git a/fixture/DescribeTimeToLive.yaml b/fixture/DescribeTimeToLive.yaml new file mode 100644 --- /dev/null +++ b/fixture/DescribeTimeToLive.yaml @@ -0,0 +1,10 @@ +--- +method: POST +headers: + Authorization: AWS4-HMAC-SHA256 Credential=access/20091028/us-east-1/dynamodb/aws4_request, SignedHeaders=content-type;host;x-amz-content-sha256;x-amz-date, Signature=? + Host: dynamodb.us-east-1.amazonaws.com + Content-Type: application/x-www-form-urlencoded; charset=utf-8 + X-Amz-Content-SHA256: abcdef + X-Amz-Date: 20091028T223200Z +body: + '' diff --git a/fixture/DescribeTimeToLiveResponse.proto b/fixture/DescribeTimeToLiveResponse.proto new file mode 100644 --- /dev/null +++ b/fixture/DescribeTimeToLiveResponse.proto diff --git a/fixture/ListTagsOfResource.yaml b/fixture/ListTagsOfResource.yaml new file mode 100644 --- /dev/null +++ b/fixture/ListTagsOfResource.yaml @@ -0,0 +1,10 @@ +--- +method: POST +headers: + Authorization: AWS4-HMAC-SHA256 Credential=access/20091028/us-east-1/dynamodb/aws4_request, SignedHeaders=content-type;host;x-amz-content-sha256;x-amz-date, Signature=? + Host: dynamodb.us-east-1.amazonaws.com + Content-Type: application/x-www-form-urlencoded; charset=utf-8 + X-Amz-Content-SHA256: abcdef + X-Amz-Date: 20091028T223200Z +body: + '' diff --git a/fixture/ListTagsOfResourceResponse.proto b/fixture/ListTagsOfResourceResponse.proto new file mode 100644 --- /dev/null +++ b/fixture/ListTagsOfResourceResponse.proto diff --git a/fixture/TagResource.yaml b/fixture/TagResource.yaml new file mode 100644 --- /dev/null +++ b/fixture/TagResource.yaml @@ -0,0 +1,10 @@ +--- +method: POST +headers: + Authorization: AWS4-HMAC-SHA256 Credential=access/20091028/us-east-1/dynamodb/aws4_request, SignedHeaders=content-type;host;x-amz-content-sha256;x-amz-date, Signature=? + Host: dynamodb.us-east-1.amazonaws.com + Content-Type: application/x-www-form-urlencoded; charset=utf-8 + X-Amz-Content-SHA256: abcdef + X-Amz-Date: 20091028T223200Z +body: + '' diff --git a/fixture/TagResourceResponse.proto b/fixture/TagResourceResponse.proto new file mode 100644 --- /dev/null +++ b/fixture/TagResourceResponse.proto diff --git a/fixture/UntagResource.yaml b/fixture/UntagResource.yaml new file mode 100644 --- /dev/null +++ b/fixture/UntagResource.yaml @@ -0,0 +1,10 @@ +--- +method: POST +headers: + Authorization: AWS4-HMAC-SHA256 Credential=access/20091028/us-east-1/dynamodb/aws4_request, SignedHeaders=content-type;host;x-amz-content-sha256;x-amz-date, Signature=? + Host: dynamodb.us-east-1.amazonaws.com + Content-Type: application/x-www-form-urlencoded; charset=utf-8 + X-Amz-Content-SHA256: abcdef + X-Amz-Date: 20091028T223200Z +body: + '' diff --git a/fixture/UntagResourceResponse.proto b/fixture/UntagResourceResponse.proto new file mode 100644 --- /dev/null +++ b/fixture/UntagResourceResponse.proto diff --git a/fixture/UpdateTimeToLive.yaml b/fixture/UpdateTimeToLive.yaml new file mode 100644 --- /dev/null +++ b/fixture/UpdateTimeToLive.yaml @@ -0,0 +1,10 @@ +--- +method: POST +headers: + Authorization: AWS4-HMAC-SHA256 Credential=access/20091028/us-east-1/dynamodb/aws4_request, SignedHeaders=content-type;host;x-amz-content-sha256;x-amz-date, Signature=? + Host: dynamodb.us-east-1.amazonaws.com + Content-Type: application/x-www-form-urlencoded; charset=utf-8 + X-Amz-Content-SHA256: abcdef + X-Amz-Date: 20091028T223200Z +body: + '' diff --git a/fixture/UpdateTimeToLiveResponse.proto b/fixture/UpdateTimeToLiveResponse.proto new file mode 100644 --- /dev/null +++ b/fixture/UpdateTimeToLiveResponse.proto diff --git a/gen/Network/AWS/DynamoDB.hs b/gen/Network/AWS/DynamoDB.hs --- a/gen/Network/AWS/DynamoDB.hs +++ b/gen/Network/AWS/DynamoDB.hs @@ -5,75 +5,19 @@ -- | -- Module : Network.AWS.DynamoDB --- Copyright : (c) 2013-2016 Brendan Hay +-- Copyright : (c) 2013-2017 Brendan Hay -- License : Mozilla Public License, v. 2.0. --- Maintainer : Brendan Hay +-- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- __Amazon DynamoDB__ -- --- This is the Amazon DynamoDB API Reference. This guide provides descriptions of the low-level DynamoDB API. --- --- This guide is intended for use with the following DynamoDB documentation: --- --- * - provides hands-on exercises that help you learn the basics of working with DynamoDB. /If you are new to DynamoDB, we recommend that you begin with the Getting Started Guide./ --- --- * - contains detailed information about DynamoDB concepts, usage, and best practices. --- --- * - provides descriptions and samples of the DynamoDB Streams API. (For more information, see in the Amazon DynamoDB Developer Guide.) --- --- --- --- Instead of making the requests to the low-level DynamoDB API directly from your application, we recommend that you use the AWS Software Development Kits (SDKs). The easy-to-use libraries in the AWS SDKs make it unnecessary to call the low-level DynamoDB API directly from your application. The libraries take care of request authentication, serialization, and connection management. For more information, see in the Amazon DynamoDB Developer Guide. --- --- If you decide to code against the low-level DynamoDB API directly, you will need to write the necessary code to authenticate your requests. For more information on signing your requests, see in the /Amazon DynamoDB Developer Guide/ . --- --- The following are short descriptions of each low-level API action, organized by function. --- --- __Managing Tables__ --- --- * /CreateTable/ - Creates a table with user-specified provisioned throughput settings. You must define a primary key for the table - either a simple primary key (partition key), or a composite primary key (partition key and sort key). Optionally, you can create one or more secondary indexes, which provide fast data access using non-key attributes. --- --- * /DescribeTable/ - Returns metadata for a table, such as table size, status, and index information. --- --- * /UpdateTable/ - Modifies the provisioned throughput settings for a table. Optionally, you can modify the provisioned throughput settings for global secondary indexes on the table. --- --- * /ListTables/ - Returns a list of all tables associated with the current AWS account and endpoint. --- --- * /DeleteTable/ - Deletes a table and all of its indexes. --- --- --- --- For conceptual information about managing tables, see in the /Amazon DynamoDB Developer Guide/ . --- --- __Reading Data__ --- --- * /GetItem/ - Returns a set of attributes for the item that has a given primary key. By default, /GetItem/ performs an eventually consistent read; however, applications can request a strongly consistent read instead. --- --- * /BatchGetItem/ - Performs multiple /GetItem/ requests for data items using their primary keys, from one table or multiple tables. The response from /BatchGetItem/ has a size limit of 16 MB and returns a maximum of 100 items. Both eventually consistent and strongly consistent reads can be used. --- --- * /Query/ - Returns one or more items from a table or a secondary index. You must provide a specific value for the partition key. You can narrow the scope of the query using comparison operators against a sort key value, or on the index key. /Query/ supports either eventual or strong consistency. A single response has a size limit of 1 MB. --- --- * /Scan/ - Reads every item in a table; the result set is eventually consistent. You can limit the number of items returned by filtering the data attributes, using conditional expressions. /Scan/ can be used to enable ad-hoc querying of a table against non-key attributes; however, since this is a full table scan without using an index, /Scan/ should not be used for any application query use case that requires predictable performance. --- --- --- --- For conceptual information about reading data, see and in the /Amazon DynamoDB Developer Guide/ . --- --- __Modifying Data__ --- --- * /PutItem/ - Creates a new item, or replaces an existing item with a new item (including all the attributes). By default, if an item in the table already exists with the same primary key, the new item completely replaces the existing item. You can use conditional operators to replace an item only if its attribute values match certain conditions, or to insert a new item only if that item doesn't already exist. --- --- * /UpdateItem/ - Modifies the attributes of an existing item. You can also use conditional operators to perform an update only if the item's attribute values match certain conditions. --- --- * /DeleteItem/ - Deletes an item in a table by primary key. You can use conditional operators to perform a delete an item only if the item's attribute values match certain conditions. --- --- * /BatchWriteItem/ - Performs multiple /PutItem/ and /DeleteItem/ requests across multiple tables in a single request. A failure of any request(s) in the batch will not cause the entire /BatchWriteItem/ operation to fail. Supports batches of up to 25 items to put or delete, with a maximum total request size of 16 MB. --- +-- Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. DynamoDB lets you offload the administrative burdens of operating and scaling a distributed database, so that you don't have to worry about hardware provisioning, setup and configuration, replication, software patching, or cluster scaling. -- +-- With DynamoDB, you can create database tables that can store and retrieve any amount of data, and serve any level of request traffic. You can scale up or scale down your tables' throughput capacity without downtime or performance degradation, and use the AWS Management Console to monitor resource utilization and performance metrics. -- --- For conceptual information about modifying data, see and in the /Amazon DynamoDB Developer Guide/ . +-- DynamoDB automatically spreads the data and traffic for your tables over a sufficient number of servers to handle your throughput and storage requirements, while maintaining consistent and fast performance. All of your data is stored on solid state disks (SSDs) and automatically replicated across multiple Availability Zones in an AWS region, providing built-in high availability and data durability. -- module Network.AWS.DynamoDB ( @@ -134,6 +78,9 @@ -- ** BatchGetItem , module Network.AWS.DynamoDB.BatchGetItem + -- ** ListTagsOfResource + , module Network.AWS.DynamoDB.ListTagsOfResource + -- ** DescribeTable , module Network.AWS.DynamoDB.DescribeTable @@ -158,6 +105,18 @@ -- ** CreateTable , module Network.AWS.DynamoDB.CreateTable + -- ** DescribeTimeToLive + , module Network.AWS.DynamoDB.DescribeTimeToLive + + -- ** TagResource + , module Network.AWS.DynamoDB.TagResource + + -- ** UntagResource + , module Network.AWS.DynamoDB.UntagResource + + -- ** UpdateTimeToLive + , module Network.AWS.DynamoDB.UpdateTimeToLive + -- * Types -- ** AttributeAction @@ -199,6 +158,9 @@ -- ** TableStatus , TableStatus (..) + -- ** TimeToLiveStatus + , TimeToLiveStatus (..) + -- ** AttributeDefinition , AttributeDefinition , attributeDefinition @@ -387,6 +349,24 @@ , tdTableName , tdStreamSpecification + -- ** Tag + , Tag + , tag + , tagKey + , tagValue + + -- ** TimeToLiveDescription + , TimeToLiveDescription + , timeToLiveDescription + , ttldTimeToLiveStatus + , ttldAttributeName + + -- ** TimeToLiveSpecification + , TimeToLiveSpecification + , timeToLiveSpecification + , ttlsEnabled + , ttlsAttributeName + -- ** UpdateGlobalSecondaryIndexAction , UpdateGlobalSecondaryIndexAction , updateGlobalSecondaryIndexAction @@ -400,22 +380,27 @@ , wrPutRequest ) where -import Network.AWS.DynamoDB.BatchGetItem -import Network.AWS.DynamoDB.BatchWriteItem -import Network.AWS.DynamoDB.CreateTable -import Network.AWS.DynamoDB.DeleteItem -import Network.AWS.DynamoDB.DeleteTable -import Network.AWS.DynamoDB.DescribeLimits -import Network.AWS.DynamoDB.DescribeTable -import Network.AWS.DynamoDB.GetItem -import Network.AWS.DynamoDB.ListTables -import Network.AWS.DynamoDB.PutItem -import Network.AWS.DynamoDB.Query -import Network.AWS.DynamoDB.Scan -import Network.AWS.DynamoDB.Types -import Network.AWS.DynamoDB.UpdateItem -import Network.AWS.DynamoDB.UpdateTable -import Network.AWS.DynamoDB.Waiters +import Network.AWS.DynamoDB.BatchGetItem +import Network.AWS.DynamoDB.BatchWriteItem +import Network.AWS.DynamoDB.CreateTable +import Network.AWS.DynamoDB.DeleteItem +import Network.AWS.DynamoDB.DeleteTable +import Network.AWS.DynamoDB.DescribeLimits +import Network.AWS.DynamoDB.DescribeTable +import Network.AWS.DynamoDB.DescribeTimeToLive +import Network.AWS.DynamoDB.GetItem +import Network.AWS.DynamoDB.ListTables +import Network.AWS.DynamoDB.ListTagsOfResource +import Network.AWS.DynamoDB.PutItem +import Network.AWS.DynamoDB.Query +import Network.AWS.DynamoDB.Scan +import Network.AWS.DynamoDB.TagResource +import Network.AWS.DynamoDB.Types +import Network.AWS.DynamoDB.UntagResource +import Network.AWS.DynamoDB.UpdateItem +import Network.AWS.DynamoDB.UpdateTable +import Network.AWS.DynamoDB.UpdateTimeToLive +import Network.AWS.DynamoDB.Waiters {- $errors Error matchers are designed for use with the functions provided by diff --git a/gen/Network/AWS/DynamoDB/BatchGetItem.hs b/gen/Network/AWS/DynamoDB/BatchGetItem.hs --- a/gen/Network/AWS/DynamoDB/BatchGetItem.hs +++ b/gen/Network/AWS/DynamoDB/BatchGetItem.hs @@ -12,32 +12,32 @@ -- | -- Module : Network.AWS.DynamoDB.BatchGetItem --- Copyright : (c) 2013-2016 Brendan Hay +-- Copyright : (c) 2013-2017 Brendan Hay -- License : Mozilla Public License, v. 2.0. --- Maintainer : Brendan Hay +-- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- The /BatchGetItem/ operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key. +-- The @BatchGetItem@ operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key. -- -- --- A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. /BatchGetItem/ will return a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for /UnprocessedKeys/ . You can use this value to retry the operation starting with the next item to get. +-- A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. @BatchGetItem@ will return a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for @UnprocessedKeys@ . You can use this value to retry the operation starting with the next item to get. -- --- /Important:/ If you request more than 100 items /BatchGetItem/ will return a /ValidationException/ with the message "Too many items requested for the BatchGetItem call". +-- /Important:/ If you request more than 100 items @BatchGetItem@ will return a @ValidationException@ with the message "Too many items requested for the BatchGetItem call". -- --- For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate /UnprocessedKeys/ value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one data set. +-- For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate @UnprocessedKeys@ value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one data set. -- --- If /none/ of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then /BatchGetItem/ will return a /ProvisionedThroughputExceededException/ . If /at least one/ of the items is successfully processed, then /BatchGetItem/ completes successfully, while returning the keys of the unread items in /UnprocessedKeys/ . +-- If /none/ of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then @BatchGetItem@ will return a @ProvisionedThroughputExceededException@ . If /at least one/ of the items is successfully processed, then @BatchGetItem@ completes successfully, while returning the keys of the unread items in @UnprocessedKeys@ . -- -- /Important:/ If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, /we strongly recommend that you use an exponential backoff algorithm/ . If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. -- -- For more information, see in the /Amazon DynamoDB Developer Guide/ . -- --- By default, /BatchGetItem/ performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set /ConsistentRead/ to @true@ for any or all tables. +-- By default, @BatchGetItem@ performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set @ConsistentRead@ to @true@ for any or all tables. -- --- In order to minimize response latency, /BatchGetItem/ retrieves items in parallel. +-- In order to minimize response latency, @BatchGetItem@ retrieves items in parallel. -- --- When designing your application, keep in mind that DynamoDB does not return items in any particular order. To help parse the response by item, include the primary key values for the items in your request in the /AttributesToGet/ parameter. +-- When designing your application, keep in mind that DynamoDB does not return items in any particular order. To help parse the response by item, include the primary key values for the items in your request in the @ProjectionExpression@ parameter. -- -- If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see in the /Amazon DynamoDB Developer Guide/ . -- @@ -60,43 +60,43 @@ , bgirsResponseStatus ) where -import Network.AWS.DynamoDB.Types -import Network.AWS.DynamoDB.Types.Product -import Network.AWS.Lens -import Network.AWS.Prelude -import Network.AWS.Request -import Network.AWS.Response +import Network.AWS.DynamoDB.Types +import Network.AWS.DynamoDB.Types.Product +import Network.AWS.Lens +import Network.AWS.Prelude +import Network.AWS.Request +import Network.AWS.Response --- | Represents the input of a /BatchGetItem/ operation. +-- | Represents the input of a @BatchGetItem@ operation. -- -- -- -- /See:/ 'batchGetItem' smart constructor. data BatchGetItem = BatchGetItem' - { _bgiReturnConsumedCapacity :: !(Maybe ReturnConsumedCapacity) - , _bgiRequestItems :: !(Map Text KeysAndAttributes) - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _bgiReturnConsumedCapacity :: !(Maybe ReturnConsumedCapacity) + , _bgiRequestItems :: !(Map Text KeysAndAttributes) + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'BatchGetItem' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- * 'bgiReturnConsumedCapacity' - Undocumented member. -- --- * 'bgiRequestItems' - A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per /BatchGetItem/ request. Each element in the map of items to retrieve consists of the following: * /ConsistentRead/ - If @true@ , a strongly consistent read is used; if @false@ (the default), an eventually consistent read is used. * /ExpressionAttributeNames/ - One or more substitution tokens for attribute names in the /ProjectionExpression/ parameter. 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for /ExpressionAttributeNames/ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . * /Keys/ - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide /all/ of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide /both/ the partition key value and the sort key value. * /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 in the /Amazon DynamoDB Developer Guide/ . * /AttributesToGet/ - /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /ProjectionExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map. The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. Note that /AttributesToGet/ has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application. +-- * 'bgiRequestItems' - A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per @BatchGetItem@ request. Each element in the map of items to retrieve consists of the following: * @ConsistentRead@ - If @true@ , a strongly consistent read is used; if @false@ (the default), an eventually consistent read is used. * @ExpressionAttributeNames@ - One or more substitution tokens for attribute names in the @ProjectionExpression@ parameter. 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for @ExpressionAttributeNames@ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . * @Keys@ - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide /all/ of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide /both/ the partition key value and the sort key value. * @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 in the /Amazon DynamoDB Developer Guide/ . * @AttributesToGet@ - This is a legacy parameter. Use @ProjectionExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . batchGetItem :: BatchGetItem batchGetItem = - BatchGetItem' - { _bgiReturnConsumedCapacity = Nothing - , _bgiRequestItems = mempty - } + BatchGetItem' + {_bgiReturnConsumedCapacity = Nothing, _bgiRequestItems = mempty} + -- | Undocumented member. bgiReturnConsumedCapacity :: Lens' BatchGetItem (Maybe ReturnConsumedCapacity) bgiReturnConsumedCapacity = lens _bgiReturnConsumedCapacity (\ s a -> s{_bgiReturnConsumedCapacity = a}); --- | A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per /BatchGetItem/ request. Each element in the map of items to retrieve consists of the following: * /ConsistentRead/ - If @true@ , a strongly consistent read is used; if @false@ (the default), an eventually consistent read is used. * /ExpressionAttributeNames/ - One or more substitution tokens for attribute names in the /ProjectionExpression/ parameter. 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for /ExpressionAttributeNames/ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . * /Keys/ - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide /all/ of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide /both/ the partition key value and the sort key value. * /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 in the /Amazon DynamoDB Developer Guide/ . * /AttributesToGet/ - /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /ProjectionExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map. The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. Note that /AttributesToGet/ has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application. +-- | A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per @BatchGetItem@ request. Each element in the map of items to retrieve consists of the following: * @ConsistentRead@ - If @true@ , a strongly consistent read is used; if @false@ (the default), an eventually consistent read is used. * @ExpressionAttributeNames@ - One or more substitution tokens for attribute names in the @ProjectionExpression@ parameter. 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for @ExpressionAttributeNames@ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . * @Keys@ - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide /all/ of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide /both/ the partition key value and the sort key value. * @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 in the /Amazon DynamoDB Developer Guide/ . * @AttributesToGet@ - This is a legacy parameter. Use @ProjectionExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . bgiRequestItems :: Lens' BatchGetItem (HashMap Text KeysAndAttributes) bgiRequestItems = lens _bgiRequestItems (\ s a -> s{_bgiRequestItems = a}) . _Map; @@ -112,9 +112,9 @@ <*> (x .?> "ConsumedCapacity" .!@ mempty) <*> (pure (fromEnum s))) -instance Hashable BatchGetItem +instance Hashable BatchGetItem where -instance NFData BatchGetItem +instance NFData BatchGetItem where instance ToHeaders BatchGetItem where toHeaders @@ -139,49 +139,51 @@ instance ToQuery BatchGetItem where toQuery = const mempty --- | Represents the output of a /BatchGetItem/ operation. +-- | Represents the output of a @BatchGetItem@ operation. -- -- -- -- /See:/ 'batchGetItemResponse' smart constructor. data BatchGetItemResponse = BatchGetItemResponse' - { _bgirsUnprocessedKeys :: !(Maybe (Map Text KeysAndAttributes)) - , _bgirsResponses :: !(Maybe (Map Text [Map Text AttributeValue])) - , _bgirsConsumedCapacity :: !(Maybe [ConsumedCapacity]) - , _bgirsResponseStatus :: !Int - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _bgirsUnprocessedKeys :: !(Maybe (Map Text KeysAndAttributes)) + , _bgirsResponses :: !(Maybe (Map Text [Map Text AttributeValue])) + , _bgirsConsumedCapacity :: !(Maybe [ConsumedCapacity]) + , _bgirsResponseStatus :: !Int + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'BatchGetItemResponse' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'bgirsUnprocessedKeys' - A map of tables and their respective keys that were not processed with the current response. The /UnprocessedKeys/ value is in the same form as /RequestItems/ , so the value can be provided directly to a subsequent /BatchGetItem/ operation. For more information, see /RequestItems/ in the Request Parameters section. Each element consists of: * /Keys/ - An array of primary key attribute values that define specific items in the table. * /AttributesToGet/ - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result. * /ConsistentRead/ - The consistency of a read operation. If set to @true@ , then a strongly consistent read is used; otherwise, an eventually consistent read is used. If there are no unprocessed keys remaining, the response contains an empty /UnprocessedKeys/ map. +-- * 'bgirsUnprocessedKeys' - A map of tables and their respective keys that were not processed with the current response. The @UnprocessedKeys@ value is in the same form as @RequestItems@ , so the value can be provided directly to a subsequent @BatchGetItem@ operation. For more information, see @RequestItems@ in the Request Parameters section. Each element consists of: * @Keys@ - An array of primary key attribute values that define specific items in the table. * @ProjectionExpression@ - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result. * @ConsistentRead@ - The consistency of a read operation. If set to @true@ , then a strongly consistent read is used; otherwise, an eventually consistent read is used. If there are no unprocessed keys remaining, the response contains an empty @UnprocessedKeys@ map. -- --- * 'bgirsResponses' - A map of table name to a list of items. Each object in /Responses/ consists of a table name, along with a map of attribute data consisting of the data type and attribute value. +-- * 'bgirsResponses' - A map of table name to a list of items. Each object in @Responses@ consists of a table name, along with a map of attribute data consisting of the data type and attribute value. -- --- * 'bgirsConsumedCapacity' - The read capacity units consumed by the operation. Each element consists of: * /TableName/ - The table that consumed the provisioned throughput. * /CapacityUnits/ - The total number of capacity units consumed. +-- * 'bgirsConsumedCapacity' - The read capacity units consumed by the entire @BatchGetItem@ operation. Each element consists of: * @TableName@ - The table that consumed the provisioned throughput. * @CapacityUnits@ - The total number of capacity units consumed. -- -- * 'bgirsResponseStatus' - -- | The response status code. batchGetItemResponse :: Int -- ^ 'bgirsResponseStatus' -> BatchGetItemResponse batchGetItemResponse pResponseStatus_ = - BatchGetItemResponse' - { _bgirsUnprocessedKeys = Nothing - , _bgirsResponses = Nothing - , _bgirsConsumedCapacity = Nothing - , _bgirsResponseStatus = pResponseStatus_ - } + BatchGetItemResponse' + { _bgirsUnprocessedKeys = Nothing + , _bgirsResponses = Nothing + , _bgirsConsumedCapacity = Nothing + , _bgirsResponseStatus = pResponseStatus_ + } --- | A map of tables and their respective keys that were not processed with the current response. The /UnprocessedKeys/ value is in the same form as /RequestItems/ , so the value can be provided directly to a subsequent /BatchGetItem/ operation. For more information, see /RequestItems/ in the Request Parameters section. Each element consists of: * /Keys/ - An array of primary key attribute values that define specific items in the table. * /AttributesToGet/ - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result. * /ConsistentRead/ - The consistency of a read operation. If set to @true@ , then a strongly consistent read is used; otherwise, an eventually consistent read is used. If there are no unprocessed keys remaining, the response contains an empty /UnprocessedKeys/ map. + +-- | A map of tables and their respective keys that were not processed with the current response. The @UnprocessedKeys@ value is in the same form as @RequestItems@ , so the value can be provided directly to a subsequent @BatchGetItem@ operation. For more information, see @RequestItems@ in the Request Parameters section. Each element consists of: * @Keys@ - An array of primary key attribute values that define specific items in the table. * @ProjectionExpression@ - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result. * @ConsistentRead@ - The consistency of a read operation. If set to @true@ , then a strongly consistent read is used; otherwise, an eventually consistent read is used. If there are no unprocessed keys remaining, the response contains an empty @UnprocessedKeys@ map. bgirsUnprocessedKeys :: Lens' BatchGetItemResponse (HashMap Text KeysAndAttributes) bgirsUnprocessedKeys = lens _bgirsUnprocessedKeys (\ s a -> s{_bgirsUnprocessedKeys = a}) . _Default . _Map; --- | A map of table name to a list of items. Each object in /Responses/ consists of a table name, along with a map of attribute data consisting of the data type and attribute value. +-- | A map of table name to a list of items. Each object in @Responses@ consists of a table name, along with a map of attribute data consisting of the data type and attribute value. bgirsResponses :: Lens' BatchGetItemResponse (HashMap Text [HashMap Text AttributeValue]) bgirsResponses = lens _bgirsResponses (\ s a -> s{_bgirsResponses = a}) . _Default . _Map; --- | The read capacity units consumed by the operation. Each element consists of: * /TableName/ - The table that consumed the provisioned throughput. * /CapacityUnits/ - The total number of capacity units consumed. +-- | The read capacity units consumed by the entire @BatchGetItem@ operation. Each element consists of: * @TableName@ - The table that consumed the provisioned throughput. * @CapacityUnits@ - The total number of capacity units consumed. bgirsConsumedCapacity :: Lens' BatchGetItemResponse [ConsumedCapacity] bgirsConsumedCapacity = lens _bgirsConsumedCapacity (\ s a -> s{_bgirsConsumedCapacity = a}) . _Default . _Coerce; @@ -189,4 +191,4 @@ bgirsResponseStatus :: Lens' BatchGetItemResponse Int bgirsResponseStatus = lens _bgirsResponseStatus (\ s a -> s{_bgirsResponseStatus = a}); -instance NFData BatchGetItemResponse +instance NFData BatchGetItemResponse where diff --git a/gen/Network/AWS/DynamoDB/BatchWriteItem.hs b/gen/Network/AWS/DynamoDB/BatchWriteItem.hs --- a/gen/Network/AWS/DynamoDB/BatchWriteItem.hs +++ b/gen/Network/AWS/DynamoDB/BatchWriteItem.hs @@ -12,36 +12,36 @@ -- | -- Module : Network.AWS.DynamoDB.BatchWriteItem --- Copyright : (c) 2013-2016 Brendan Hay +-- Copyright : (c) 2013-2017 Brendan Hay -- License : Mozilla Public License, v. 2.0. --- Maintainer : Brendan Hay +-- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- The /BatchWriteItem/ operation puts or deletes multiple items in one or more tables. A single call to /BatchWriteItem/ can write up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 400 KB. +-- The @BatchWriteItem@ operation puts or deletes multiple items in one or more tables. A single call to @BatchWriteItem@ can write up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 400 KB. -- -- --- The individual /PutItem/ and /DeleteItem/ operations specified in /BatchWriteItem/ are atomic; however /BatchWriteItem/ as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the /UnprocessedItems/ response parameter. You can investigate and optionally resend the requests. Typically, you would call /BatchWriteItem/ in a loop. Each iteration would check for unprocessed items and submit a new /BatchWriteItem/ request with those unprocessed items until all items have been processed. +-- The individual @PutItem@ and @DeleteItem@ operations specified in @BatchWriteItem@ are atomic; however @BatchWriteItem@ as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the @UnprocessedItems@ response parameter. You can investigate and optionally resend the requests. Typically, you would call @BatchWriteItem@ in a loop. Each iteration would check for unprocessed items and submit a new @BatchWriteItem@ request with those unprocessed items until all items have been processed. -- --- Note that if /none/ of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then /BatchWriteItem/ will return a /ProvisionedThroughputExceededException/ . +-- Note that if /none/ of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then @BatchWriteItem@ will return a @ProvisionedThroughputExceededException@ . -- -- /Important:/ If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, /we strongly recommend that you use an exponential backoff algorithm/ . If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. -- -- For more information, see in the /Amazon DynamoDB Developer Guide/ . -- --- With /BatchWriteItem/ , you can efficiently write or delete large amounts of data, such as from Amazon Elastic MapReduce (EMR), or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, /BatchWriteItem/ does not behave in the same way as individual /PutItem/ and /DeleteItem/ calls would. For example, you cannot specify conditions on individual put and delete requests, and /BatchWriteItem/ does not return deleted items in the response. +-- With @BatchWriteItem@ , you can efficiently write or delete large amounts of data, such as from Amazon Elastic MapReduce (EMR), or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, @BatchWriteItem@ does not behave in the same way as individual @PutItem@ and @DeleteItem@ calls would. For example, you cannot specify conditions on individual put and delete requests, and @BatchWriteItem@ does not return deleted items in the response. -- --- If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, /BatchWriteItem/ provides an alternative where the API performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application. +-- If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, @BatchWriteItem@ performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application. -- -- Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit. -- -- If one or more of the following is true, DynamoDB rejects the entire batch write operation: -- --- * One or more tables specified in the /BatchWriteItem/ request does not exist. +-- * One or more tables specified in the @BatchWriteItem@ request does not exist. -- -- * Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema. -- --- * You try to perform multiple operations on the same item in the same /BatchWriteItem/ request. For example, you cannot put and delete the same item in the same /BatchWriteItem/ request. +-- * You try to perform multiple operations on the same item in the same @BatchWriteItem@ request. For example, you cannot put and delete the same item in the same @BatchWriteItem@ request. -- -- * There are more than 25 requests in the batch. -- @@ -71,24 +71,25 @@ , bwirsResponseStatus ) where -import Network.AWS.DynamoDB.Types -import Network.AWS.DynamoDB.Types.Product -import Network.AWS.Lens -import Network.AWS.Prelude -import Network.AWS.Request -import Network.AWS.Response +import Network.AWS.DynamoDB.Types +import Network.AWS.DynamoDB.Types.Product +import Network.AWS.Lens +import Network.AWS.Prelude +import Network.AWS.Request +import Network.AWS.Response --- | Represents the input of a /BatchWriteItem/ operation. +-- | Represents the input of a @BatchWriteItem@ operation. -- -- -- -- /See:/ 'batchWriteItem' smart constructor. data BatchWriteItem = BatchWriteItem' - { _bwiReturnConsumedCapacity :: !(Maybe ReturnConsumedCapacity) - , _bwiReturnItemCollectionMetrics :: !(Maybe ReturnItemCollectionMetrics) - , _bwiRequestItems :: !(Map Text (List1 WriteRequest)) - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _bwiReturnConsumedCapacity :: !(Maybe ReturnConsumedCapacity) + , _bwiReturnItemCollectionMetrics :: !(Maybe ReturnItemCollectionMetrics) + , _bwiRequestItems :: !(Map Text (List1 WriteRequest)) + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'BatchWriteItem' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -97,16 +98,17 @@ -- -- * 'bwiReturnItemCollectionMetrics' - Determines whether item collection metrics are returned. If set to @SIZE@ , the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to @NONE@ (the default), no statistics are returned. -- --- * 'bwiRequestItems' - A map of one or more table names and, for each table, a list of operations to be performed (/DeleteRequest/ or /PutRequest/ ). Each element in the map consists of the following: * /DeleteRequest/ - Perform a /DeleteItem/ operation on the specified item. The item to be deleted is identified by a /Key/ subelement: * /Key/ - A map of primary key attribute values that uniquely identify the ! item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide /all/ of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for /both/ the partition key and the sort key. * /PutRequest/ - Perform a /PutItem/ operation on the specified item. The item to be put is identified by an /Item/ subelement: * /Item/ - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a /ValidationException/ exception. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. +-- * 'bwiRequestItems' - A map of one or more table names and, for each table, a list of operations to be performed (@DeleteRequest@ or @PutRequest@ ). Each element in the map consists of the following: * @DeleteRequest@ - Perform a @DeleteItem@ operation on the specified item. The item to be deleted is identified by a @Key@ subelement: * @Key@ - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide /all/ of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for /both/ the partition key and the sort key. * @PutRequest@ - Perform a @PutItem@ operation on the specified item. The item to be put is identified by an @Item@ subelement: * @Item@ - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a @ValidationException@ exception. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. batchWriteItem :: BatchWriteItem batchWriteItem = - BatchWriteItem' - { _bwiReturnConsumedCapacity = Nothing - , _bwiReturnItemCollectionMetrics = Nothing - , _bwiRequestItems = mempty - } + BatchWriteItem' + { _bwiReturnConsumedCapacity = Nothing + , _bwiReturnItemCollectionMetrics = Nothing + , _bwiRequestItems = mempty + } + -- | Undocumented member. bwiReturnConsumedCapacity :: Lens' BatchWriteItem (Maybe ReturnConsumedCapacity) bwiReturnConsumedCapacity = lens _bwiReturnConsumedCapacity (\ s a -> s{_bwiReturnConsumedCapacity = a}); @@ -115,7 +117,7 @@ bwiReturnItemCollectionMetrics :: Lens' BatchWriteItem (Maybe ReturnItemCollectionMetrics) bwiReturnItemCollectionMetrics = lens _bwiReturnItemCollectionMetrics (\ s a -> s{_bwiReturnItemCollectionMetrics = a}); --- | A map of one or more table names and, for each table, a list of operations to be performed (/DeleteRequest/ or /PutRequest/ ). Each element in the map consists of the following: * /DeleteRequest/ - Perform a /DeleteItem/ operation on the specified item. The item to be deleted is identified by a /Key/ subelement: * /Key/ - A map of primary key attribute values that uniquely identify the ! item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide /all/ of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for /both/ the partition key and the sort key. * /PutRequest/ - Perform a /PutItem/ operation on the specified item. The item to be put is identified by an /Item/ subelement: * /Item/ - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a /ValidationException/ exception. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. +-- | A map of one or more table names and, for each table, a list of operations to be performed (@DeleteRequest@ or @PutRequest@ ). Each element in the map consists of the following: * @DeleteRequest@ - Perform a @DeleteItem@ operation on the specified item. The item to be deleted is identified by a @Key@ subelement: * @Key@ - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide /all/ of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for /both/ the partition key and the sort key. * @PutRequest@ - Perform a @PutItem@ operation on the specified item. The item to be put is identified by an @Item@ subelement: * @Item@ - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a @ValidationException@ exception. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. bwiRequestItems :: Lens' BatchWriteItem (HashMap Text (NonEmpty WriteRequest)) bwiRequestItems = lens _bwiRequestItems (\ s a -> s{_bwiRequestItems = a}) . _Map; @@ -131,9 +133,9 @@ <*> (x .?> "UnprocessedItems" .!@ mempty) <*> (pure (fromEnum s))) -instance Hashable BatchWriteItem +instance Hashable BatchWriteItem where -instance NFData BatchWriteItem +instance NFData BatchWriteItem where instance ToHeaders BatchWriteItem where toHeaders @@ -160,49 +162,51 @@ instance ToQuery BatchWriteItem where toQuery = const mempty --- | Represents the output of a /BatchWriteItem/ operation. +-- | Represents the output of a @BatchWriteItem@ operation. -- -- -- -- /See:/ 'batchWriteItemResponse' smart constructor. data BatchWriteItemResponse = BatchWriteItemResponse' - { _bwirsItemCollectionMetrics :: !(Maybe (Map Text [ItemCollectionMetrics])) - , _bwirsConsumedCapacity :: !(Maybe [ConsumedCapacity]) - , _bwirsUnprocessedItems :: !(Maybe (Map Text (List1 WriteRequest))) - , _bwirsResponseStatus :: !Int - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _bwirsItemCollectionMetrics :: !(Maybe (Map Text [ItemCollectionMetrics])) + , _bwirsConsumedCapacity :: !(Maybe [ConsumedCapacity]) + , _bwirsUnprocessedItems :: !(Maybe (Map Text (List1 WriteRequest))) + , _bwirsResponseStatus :: !Int + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'BatchWriteItemResponse' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'bwirsItemCollectionMetrics' - A list of tables that were processed by /BatchWriteItem/ and, for each table, information about any item collections that were affected by individual /DeleteItem/ or /PutItem/ operations. Each entry consists of the following subelements: * /ItemCollectionKey/ - The partition key value of the item collection. This is the same as the partition key value of the item. * /SizeEstimateRange/ - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. +-- * 'bwirsItemCollectionMetrics' - A list of tables that were processed by @BatchWriteItem@ and, for each table, information about any item collections that were affected by individual @DeleteItem@ or @PutItem@ operations. Each entry consists of the following subelements: * @ItemCollectionKey@ - The partition key value of the item collection. This is the same as the partition key value of the item. * @SizeEstimateRange@ - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. -- --- * 'bwirsConsumedCapacity' - The capacity units consumed by the operation. Each element consists of: * /TableName/ - The table that consumed the provisioned throughput. * /CapacityUnits/ - The total number of capacity units consumed. +-- * 'bwirsConsumedCapacity' - The capacity units consumed by the entire @BatchWriteItem@ operation. Each element consists of: * @TableName@ - The table that consumed the provisioned throughput. * @CapacityUnits@ - The total number of capacity units consumed. -- --- * 'bwirsUnprocessedItems' - A map of tables and requests against those tables that were not processed. The /UnprocessedItems/ value is in the same form as /RequestItems/ , so you can provide this value directly to a subsequent /BatchGetItem/ operation. For more information, see /RequestItems/ in the Request Parameters section. Each /UnprocessedItems/ entry consists of a table name and, for that table, a list of operations to perform (/DeleteRequest/ or /PutRequest/ ). * /DeleteRequest/ - Perform a /DeleteItem/ operation on the specified item. The item to be deleted is identified by a /Key/ subelement: * /Key/ - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value. * /PutRequest/ - Perform a /PutItem/ operation on the specified item. The item to be put is identified by an /Item/ subelement: * /Item/ - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a /ValidationException/ exception. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. If there are no unprocessed items remaining, the response contains an empty /UnprocessedItems/ map. +-- * 'bwirsUnprocessedItems' - A map of tables and requests against those tables that were not processed. The @UnprocessedItems@ value is in the same form as @RequestItems@ , so you can provide this value directly to a subsequent @BatchGetItem@ operation. For more information, see @RequestItems@ in the Request Parameters section. Each @UnprocessedItems@ entry consists of a table name and, for that table, a list of operations to perform (@DeleteRequest@ or @PutRequest@ ). * @DeleteRequest@ - Perform a @DeleteItem@ operation on the specified item. The item to be deleted is identified by a @Key@ subelement: * @Key@ - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value. * @PutRequest@ - Perform a @PutItem@ operation on the specified item. The item to be put is identified by an @Item@ subelement: * @Item@ - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a @ValidationException@ exception. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. If there are no unprocessed items remaining, the response contains an empty @UnprocessedItems@ map. -- -- * 'bwirsResponseStatus' - -- | The response status code. batchWriteItemResponse :: Int -- ^ 'bwirsResponseStatus' -> BatchWriteItemResponse batchWriteItemResponse pResponseStatus_ = - BatchWriteItemResponse' - { _bwirsItemCollectionMetrics = Nothing - , _bwirsConsumedCapacity = Nothing - , _bwirsUnprocessedItems = Nothing - , _bwirsResponseStatus = pResponseStatus_ - } + BatchWriteItemResponse' + { _bwirsItemCollectionMetrics = Nothing + , _bwirsConsumedCapacity = Nothing + , _bwirsUnprocessedItems = Nothing + , _bwirsResponseStatus = pResponseStatus_ + } --- | A list of tables that were processed by /BatchWriteItem/ and, for each table, information about any item collections that were affected by individual /DeleteItem/ or /PutItem/ operations. Each entry consists of the following subelements: * /ItemCollectionKey/ - The partition key value of the item collection. This is the same as the partition key value of the item. * /SizeEstimateRange/ - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. + +-- | A list of tables that were processed by @BatchWriteItem@ and, for each table, information about any item collections that were affected by individual @DeleteItem@ or @PutItem@ operations. Each entry consists of the following subelements: * @ItemCollectionKey@ - The partition key value of the item collection. This is the same as the partition key value of the item. * @SizeEstimateRange@ - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. bwirsItemCollectionMetrics :: Lens' BatchWriteItemResponse (HashMap Text [ItemCollectionMetrics]) bwirsItemCollectionMetrics = lens _bwirsItemCollectionMetrics (\ s a -> s{_bwirsItemCollectionMetrics = a}) . _Default . _Map; --- | The capacity units consumed by the operation. Each element consists of: * /TableName/ - The table that consumed the provisioned throughput. * /CapacityUnits/ - The total number of capacity units consumed. +-- | The capacity units consumed by the entire @BatchWriteItem@ operation. Each element consists of: * @TableName@ - The table that consumed the provisioned throughput. * @CapacityUnits@ - The total number of capacity units consumed. bwirsConsumedCapacity :: Lens' BatchWriteItemResponse [ConsumedCapacity] bwirsConsumedCapacity = lens _bwirsConsumedCapacity (\ s a -> s{_bwirsConsumedCapacity = a}) . _Default . _Coerce; --- | A map of tables and requests against those tables that were not processed. The /UnprocessedItems/ value is in the same form as /RequestItems/ , so you can provide this value directly to a subsequent /BatchGetItem/ operation. For more information, see /RequestItems/ in the Request Parameters section. Each /UnprocessedItems/ entry consists of a table name and, for that table, a list of operations to perform (/DeleteRequest/ or /PutRequest/ ). * /DeleteRequest/ - Perform a /DeleteItem/ operation on the specified item. The item to be deleted is identified by a /Key/ subelement: * /Key/ - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value. * /PutRequest/ - Perform a /PutItem/ operation on the specified item. The item to be put is identified by an /Item/ subelement: * /Item/ - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a /ValidationException/ exception. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. If there are no unprocessed items remaining, the response contains an empty /UnprocessedItems/ map. +-- | A map of tables and requests against those tables that were not processed. The @UnprocessedItems@ value is in the same form as @RequestItems@ , so you can provide this value directly to a subsequent @BatchGetItem@ operation. For more information, see @RequestItems@ in the Request Parameters section. Each @UnprocessedItems@ entry consists of a table name and, for that table, a list of operations to perform (@DeleteRequest@ or @PutRequest@ ). * @DeleteRequest@ - Perform a @DeleteItem@ operation on the specified item. The item to be deleted is identified by a @Key@ subelement: * @Key@ - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value. * @PutRequest@ - Perform a @PutItem@ operation on the specified item. The item to be put is identified by an @Item@ subelement: * @Item@ - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a @ValidationException@ exception. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. If there are no unprocessed items remaining, the response contains an empty @UnprocessedItems@ map. bwirsUnprocessedItems :: Lens' BatchWriteItemResponse (HashMap Text (NonEmpty WriteRequest)) bwirsUnprocessedItems = lens _bwirsUnprocessedItems (\ s a -> s{_bwirsUnprocessedItems = a}) . _Default . _Map; @@ -210,4 +214,4 @@ bwirsResponseStatus :: Lens' BatchWriteItemResponse Int bwirsResponseStatus = lens _bwirsResponseStatus (\ s a -> s{_bwirsResponseStatus = a}); -instance NFData BatchWriteItemResponse +instance NFData BatchWriteItemResponse where diff --git a/gen/Network/AWS/DynamoDB/CreateTable.hs b/gen/Network/AWS/DynamoDB/CreateTable.hs --- a/gen/Network/AWS/DynamoDB/CreateTable.hs +++ b/gen/Network/AWS/DynamoDB/CreateTable.hs @@ -12,20 +12,20 @@ -- | -- Module : Network.AWS.DynamoDB.CreateTable --- Copyright : (c) 2013-2016 Brendan Hay +-- Copyright : (c) 2013-2017 Brendan Hay -- License : Mozilla Public License, v. 2.0. --- Maintainer : Brendan Hay +-- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- The /CreateTable/ operation adds a new table to your account. In an AWS account, table names must be unique within each region. That is, you can have two tables with same name if you create the tables in different regions. +-- The @CreateTable@ operation adds a new table to your account. In an AWS account, table names must be unique within each region. That is, you can have two tables with same name if you create the tables in different regions. -- -- --- /CreateTable/ is an asynchronous operation. Upon receiving a /CreateTable/ request, DynamoDB immediately returns a response with a /TableStatus/ of @CREATING@ . After the table is created, DynamoDB sets the /TableStatus/ to @ACTIVE@ . You can perform read and write operations only on an @ACTIVE@ table. +-- @CreateTable@ is an asynchronous operation. Upon receiving a @CreateTable@ request, DynamoDB immediately returns a response with a @TableStatus@ of @CREATING@ . After the table is created, DynamoDB sets the @TableStatus@ to @ACTIVE@ . You can perform read and write operations only on an @ACTIVE@ table. -- --- You can optionally define secondary indexes on the new table, as part of the /CreateTable/ operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the @CREATING@ state at any given time. +-- You can optionally define secondary indexes on the new table, as part of the @CreateTable@ operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the @CREATING@ state at any given time. -- --- You can use the /DescribeTable/ API to check the table status. +-- You can use the @DescribeTable@ action to check the table status. -- module Network.AWS.DynamoDB.CreateTable ( @@ -49,70 +49,72 @@ , ctrsResponseStatus ) where -import Network.AWS.DynamoDB.Types -import Network.AWS.DynamoDB.Types.Product -import Network.AWS.Lens -import Network.AWS.Prelude -import Network.AWS.Request -import Network.AWS.Response +import Network.AWS.DynamoDB.Types +import Network.AWS.DynamoDB.Types.Product +import Network.AWS.Lens +import Network.AWS.Prelude +import Network.AWS.Request +import Network.AWS.Response --- | Represents the input of a /CreateTable/ operation. +-- | Represents the input of a @CreateTable@ operation. -- -- -- -- /See:/ 'createTable' smart constructor. data CreateTable = CreateTable' - { _ctGlobalSecondaryIndexes :: !(Maybe [GlobalSecondaryIndex]) - , _ctLocalSecondaryIndexes :: !(Maybe [LocalSecondaryIndex]) - , _ctStreamSpecification :: !(Maybe StreamSpecification) - , _ctAttributeDefinitions :: ![AttributeDefinition] - , _ctTableName :: !Text - , _ctKeySchema :: !(List1 KeySchemaElement) - , _ctProvisionedThroughput :: !ProvisionedThroughput - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _ctGlobalSecondaryIndexes :: !(Maybe [GlobalSecondaryIndex]) + , _ctLocalSecondaryIndexes :: !(Maybe [LocalSecondaryIndex]) + , _ctStreamSpecification :: !(Maybe StreamSpecification) + , _ctAttributeDefinitions :: ![AttributeDefinition] + , _ctTableName :: !Text + , _ctKeySchema :: !(List1 KeySchemaElement) + , _ctProvisionedThroughput :: !ProvisionedThroughput + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'CreateTable' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ctGlobalSecondaryIndexes' - One or more global secondary indexes (the maximum is five) to be created on the table. Each global secondary index in the array includes the following: * /IndexName/ - The name of the global secondary index. Must be unique only for this table. * /KeySchema/ - Specifies the key schema for the global secondary index. * /Projection/ - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: * /ProjectionType/ - One of the following: * @KEYS_ONLY@ - Only the index and primary keys are projected into the index. * @INCLUDE@ - Only the specified table attributes are projected into the index. The list of projected attributes are in /NonKeyAttributes/ . * @ALL@ - All of the table attributes are projected into the index. * /NonKeyAttributes/ - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in /NonKeyAttributes/ , summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. * /ProvisionedThroughput/ - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units. +-- * 'ctGlobalSecondaryIndexes' - One or more global secondary indexes (the maximum is five) to be created on the table. Each global secondary index in the array includes the following: * @IndexName@ - The name of the global secondary index. Must be unique only for this table. * @KeySchema@ - Specifies the key schema for the global secondary index. * @Projection@ - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: * @ProjectionType@ - One of the following: * @KEYS_ONLY@ - Only the index and primary keys are projected into the index. * @INCLUDE@ - Only the specified table attributes are projected into the index. The list of projected attributes are in @NonKeyAttributes@ . * @ALL@ - All of the table attributes are projected into the index. * @NonKeyAttributes@ - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in @NonKeyAttributes@ , summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. * @ProvisionedThroughput@ - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units. -- --- * 'ctLocalSecondaryIndexes' - One or more local secondary indexes (the maximum is five) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained. Each local secondary index in the array includes the following: * /IndexName/ - The name of the local secondary index. Must be unique only for this table. * /KeySchema/ - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table. * /Projection/ - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: * /ProjectionType/ - One of the following: * @KEYS_ONLY@ - Only the index and primary keys are projected into the index. * @INCLUDE@ - Only the specified table attributes are projected into the index. The list of projected attributes are in /NonKeyAttributes/ . * @ALL@ - All of the table attributes are projected into the index. * /NonKeyAttributes/ - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in /NonKeyAttributes/ , summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. +-- * 'ctLocalSecondaryIndexes' - One or more local secondary indexes (the maximum is five) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained. Each local secondary index in the array includes the following: * @IndexName@ - The name of the local secondary index. Must be unique only for this table. * @KeySchema@ - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table. * @Projection@ - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: * @ProjectionType@ - One of the following: * @KEYS_ONLY@ - Only the index and primary keys are projected into the index. * @INCLUDE@ - Only the specified table attributes are projected into the index. The list of projected attributes are in @NonKeyAttributes@ . * @ALL@ - All of the table attributes are projected into the index. * @NonKeyAttributes@ - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in @NonKeyAttributes@ , summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. -- --- * 'ctStreamSpecification' - The settings for DynamoDB Streams on the table. These settings consist of: * /StreamEnabled/ - Indicates whether Streams is to be enabled (true) or disabled (false). * /StreamViewType/ - When an item in the table is modified, /StreamViewType/ determines what information is written to the table's stream. Valid values for /StreamViewType/ are: * /KEYS_ONLY/ - Only the key attributes of the modified item are written to the stream. * /NEW_IMAGE/ - The entire item, as it appears after it was modified, is written to the stream. * /OLD_IMAGE/ - The entire item, as it appeared before it was modified, is written to the stream. * /NEW_AND_OLD_IMAGES/ - Both the new and the old item images of the item are written to the stream. +-- * 'ctStreamSpecification' - The settings for DynamoDB Streams on the table. These settings consist of: * @StreamEnabled@ - Indicates whether Streams is to be enabled (true) or disabled (false). * @StreamViewType@ - When an item in the table is modified, @StreamViewType@ determines what information is written to the table's stream. Valid values for @StreamViewType@ are: * @KEYS_ONLY@ - Only the key attributes of the modified item are written to the stream. * @NEW_IMAGE@ - The entire item, as it appears after it was modified, is written to the stream. * @OLD_IMAGE@ - The entire item, as it appeared before it was modified, is written to the stream. * @NEW_AND_OLD_IMAGES@ - Both the new and the old item images of the item are written to the stream. -- -- * 'ctAttributeDefinitions' - An array of attributes that describe the key schema for the table and indexes. -- -- * 'ctTableName' - The name of the table to create. -- --- * 'ctKeySchema' - Specifies the attributes that make up the primary key for a table or an index. The attributes in /KeySchema/ must also be defined in the /AttributeDefinitions/ array. For more information, see in the /Amazon DynamoDB Developer Guide/ . Each /KeySchemaElement/ in the array is composed of: * /AttributeName/ - The name of this key attribute. * /KeyType/ - The role that the key attribute will assume: * @HASH@ - partition key * @RANGE@ - sort key For a simple primary key (partition key), you must provide exactly one element with a /KeyType/ of @HASH@ . For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a /KeyType/ of @HASH@ , and the second element must have a /KeyType/ of @RANGE@ . For more information, see in the /Amazon DynamoDB Developer Guide/ . +-- * 'ctKeySchema' - Specifies the attributes that make up the primary key for a table or an index. The attributes in @KeySchema@ must also be defined in the @AttributeDefinitions@ array. For more information, see in the /Amazon DynamoDB Developer Guide/ . Each @KeySchemaElement@ in the array is composed of: * @AttributeName@ - The name of this key attribute. * @KeyType@ - The role that the key attribute will assume: * @HASH@ - partition key * @RANGE@ - sort key For a simple primary key (partition key), you must provide exactly one element with a @KeyType@ of @HASH@ . For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a @KeyType@ of @HASH@ , and the second element must have a @KeyType@ of @RANGE@ . For more information, see in the /Amazon DynamoDB Developer Guide/ . -- --- * 'ctProvisionedThroughput' - Undocumented member. +-- * 'ctProvisionedThroughput' - Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the @UpdateTable@ operation. For current minimum and maximum provisioned throughput values, see in the /Amazon DynamoDB Developer Guide/ . createTable :: Text -- ^ 'ctTableName' -> NonEmpty KeySchemaElement -- ^ 'ctKeySchema' -> ProvisionedThroughput -- ^ 'ctProvisionedThroughput' -> CreateTable createTable pTableName_ pKeySchema_ pProvisionedThroughput_ = - CreateTable' - { _ctGlobalSecondaryIndexes = Nothing - , _ctLocalSecondaryIndexes = Nothing - , _ctStreamSpecification = Nothing - , _ctAttributeDefinitions = mempty - , _ctTableName = pTableName_ - , _ctKeySchema = _List1 # pKeySchema_ - , _ctProvisionedThroughput = pProvisionedThroughput_ - } + CreateTable' + { _ctGlobalSecondaryIndexes = Nothing + , _ctLocalSecondaryIndexes = Nothing + , _ctStreamSpecification = Nothing + , _ctAttributeDefinitions = mempty + , _ctTableName = pTableName_ + , _ctKeySchema = _List1 # pKeySchema_ + , _ctProvisionedThroughput = pProvisionedThroughput_ + } --- | One or more global secondary indexes (the maximum is five) to be created on the table. Each global secondary index in the array includes the following: * /IndexName/ - The name of the global secondary index. Must be unique only for this table. * /KeySchema/ - Specifies the key schema for the global secondary index. * /Projection/ - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: * /ProjectionType/ - One of the following: * @KEYS_ONLY@ - Only the index and primary keys are projected into the index. * @INCLUDE@ - Only the specified table attributes are projected into the index. The list of projected attributes are in /NonKeyAttributes/ . * @ALL@ - All of the table attributes are projected into the index. * /NonKeyAttributes/ - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in /NonKeyAttributes/ , summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. * /ProvisionedThroughput/ - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units. + +-- | One or more global secondary indexes (the maximum is five) to be created on the table. Each global secondary index in the array includes the following: * @IndexName@ - The name of the global secondary index. Must be unique only for this table. * @KeySchema@ - Specifies the key schema for the global secondary index. * @Projection@ - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: * @ProjectionType@ - One of the following: * @KEYS_ONLY@ - Only the index and primary keys are projected into the index. * @INCLUDE@ - Only the specified table attributes are projected into the index. The list of projected attributes are in @NonKeyAttributes@ . * @ALL@ - All of the table attributes are projected into the index. * @NonKeyAttributes@ - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in @NonKeyAttributes@ , summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. * @ProvisionedThroughput@ - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units. ctGlobalSecondaryIndexes :: Lens' CreateTable [GlobalSecondaryIndex] ctGlobalSecondaryIndexes = lens _ctGlobalSecondaryIndexes (\ s a -> s{_ctGlobalSecondaryIndexes = a}) . _Default . _Coerce; --- | One or more local secondary indexes (the maximum is five) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained. Each local secondary index in the array includes the following: * /IndexName/ - The name of the local secondary index. Must be unique only for this table. * /KeySchema/ - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table. * /Projection/ - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: * /ProjectionType/ - One of the following: * @KEYS_ONLY@ - Only the index and primary keys are projected into the index. * @INCLUDE@ - Only the specified table attributes are projected into the index. The list of projected attributes are in /NonKeyAttributes/ . * @ALL@ - All of the table attributes are projected into the index. * /NonKeyAttributes/ - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in /NonKeyAttributes/ , summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. +-- | One or more local secondary indexes (the maximum is five) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained. Each local secondary index in the array includes the following: * @IndexName@ - The name of the local secondary index. Must be unique only for this table. * @KeySchema@ - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table. * @Projection@ - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: * @ProjectionType@ - One of the following: * @KEYS_ONLY@ - Only the index and primary keys are projected into the index. * @INCLUDE@ - Only the specified table attributes are projected into the index. The list of projected attributes are in @NonKeyAttributes@ . * @ALL@ - All of the table attributes are projected into the index. * @NonKeyAttributes@ - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in @NonKeyAttributes@ , summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. ctLocalSecondaryIndexes :: Lens' CreateTable [LocalSecondaryIndex] ctLocalSecondaryIndexes = lens _ctLocalSecondaryIndexes (\ s a -> s{_ctLocalSecondaryIndexes = a}) . _Default . _Coerce; --- | The settings for DynamoDB Streams on the table. These settings consist of: * /StreamEnabled/ - Indicates whether Streams is to be enabled (true) or disabled (false). * /StreamViewType/ - When an item in the table is modified, /StreamViewType/ determines what information is written to the table's stream. Valid values for /StreamViewType/ are: * /KEYS_ONLY/ - Only the key attributes of the modified item are written to the stream. * /NEW_IMAGE/ - The entire item, as it appears after it was modified, is written to the stream. * /OLD_IMAGE/ - The entire item, as it appeared before it was modified, is written to the stream. * /NEW_AND_OLD_IMAGES/ - Both the new and the old item images of the item are written to the stream. +-- | The settings for DynamoDB Streams on the table. These settings consist of: * @StreamEnabled@ - Indicates whether Streams is to be enabled (true) or disabled (false). * @StreamViewType@ - When an item in the table is modified, @StreamViewType@ determines what information is written to the table's stream. Valid values for @StreamViewType@ are: * @KEYS_ONLY@ - Only the key attributes of the modified item are written to the stream. * @NEW_IMAGE@ - The entire item, as it appears after it was modified, is written to the stream. * @OLD_IMAGE@ - The entire item, as it appeared before it was modified, is written to the stream. * @NEW_AND_OLD_IMAGES@ - Both the new and the old item images of the item are written to the stream. ctStreamSpecification :: Lens' CreateTable (Maybe StreamSpecification) ctStreamSpecification = lens _ctStreamSpecification (\ s a -> s{_ctStreamSpecification = a}); @@ -124,11 +126,11 @@ ctTableName :: Lens' CreateTable Text ctTableName = lens _ctTableName (\ s a -> s{_ctTableName = a}); --- | Specifies the attributes that make up the primary key for a table or an index. The attributes in /KeySchema/ must also be defined in the /AttributeDefinitions/ array. For more information, see in the /Amazon DynamoDB Developer Guide/ . Each /KeySchemaElement/ in the array is composed of: * /AttributeName/ - The name of this key attribute. * /KeyType/ - The role that the key attribute will assume: * @HASH@ - partition key * @RANGE@ - sort key For a simple primary key (partition key), you must provide exactly one element with a /KeyType/ of @HASH@ . For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a /KeyType/ of @HASH@ , and the second element must have a /KeyType/ of @RANGE@ . For more information, see in the /Amazon DynamoDB Developer Guide/ . +-- | Specifies the attributes that make up the primary key for a table or an index. The attributes in @KeySchema@ must also be defined in the @AttributeDefinitions@ array. For more information, see in the /Amazon DynamoDB Developer Guide/ . Each @KeySchemaElement@ in the array is composed of: * @AttributeName@ - The name of this key attribute. * @KeyType@ - The role that the key attribute will assume: * @HASH@ - partition key * @RANGE@ - sort key For a simple primary key (partition key), you must provide exactly one element with a @KeyType@ of @HASH@ . For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a @KeyType@ of @HASH@ , and the second element must have a @KeyType@ of @RANGE@ . For more information, see in the /Amazon DynamoDB Developer Guide/ . ctKeySchema :: Lens' CreateTable (NonEmpty KeySchemaElement) ctKeySchema = lens _ctKeySchema (\ s a -> s{_ctKeySchema = a}) . _List1; --- | Undocumented member. +-- | Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the @UpdateTable@ operation. For current minimum and maximum provisioned throughput values, see in the /Amazon DynamoDB Developer Guide/ . ctProvisionedThroughput :: Lens' CreateTable ProvisionedThroughput ctProvisionedThroughput = lens _ctProvisionedThroughput (\ s a -> s{_ctProvisionedThroughput = a}); @@ -141,9 +143,9 @@ CreateTableResponse' <$> (x .?> "TableDescription") <*> (pure (fromEnum s))) -instance Hashable CreateTable +instance Hashable CreateTable where -instance NFData CreateTable +instance NFData CreateTable where instance ToHeaders CreateTable where toHeaders @@ -178,33 +180,33 @@ instance ToQuery CreateTable where toQuery = const mempty --- | Represents the output of a /CreateTable/ operation. +-- | Represents the output of a @CreateTable@ operation. -- -- -- -- /See:/ 'createTableResponse' smart constructor. data CreateTableResponse = CreateTableResponse' - { _ctrsTableDescription :: !(Maybe TableDescription) - , _ctrsResponseStatus :: !Int - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _ctrsTableDescription :: !(Maybe TableDescription) + , _ctrsResponseStatus :: !Int + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'CreateTableResponse' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ctrsTableDescription' - Undocumented member. +-- * 'ctrsTableDescription' - Represents the properties of the table. -- -- * 'ctrsResponseStatus' - -- | The response status code. createTableResponse :: Int -- ^ 'ctrsResponseStatus' -> CreateTableResponse createTableResponse pResponseStatus_ = - CreateTableResponse' - { _ctrsTableDescription = Nothing - , _ctrsResponseStatus = pResponseStatus_ - } + CreateTableResponse' + {_ctrsTableDescription = Nothing, _ctrsResponseStatus = pResponseStatus_} --- | Undocumented member. + +-- | Represents the properties of the table. ctrsTableDescription :: Lens' CreateTableResponse (Maybe TableDescription) ctrsTableDescription = lens _ctrsTableDescription (\ s a -> s{_ctrsTableDescription = a}); @@ -212,4 +214,4 @@ ctrsResponseStatus :: Lens' CreateTableResponse Int ctrsResponseStatus = lens _ctrsResponseStatus (\ s a -> s{_ctrsResponseStatus = a}); -instance NFData CreateTableResponse +instance NFData CreateTableResponse where diff --git a/gen/Network/AWS/DynamoDB/DeleteItem.hs b/gen/Network/AWS/DynamoDB/DeleteItem.hs --- a/gen/Network/AWS/DynamoDB/DeleteItem.hs +++ b/gen/Network/AWS/DynamoDB/DeleteItem.hs @@ -12,18 +12,18 @@ -- | -- Module : Network.AWS.DynamoDB.DeleteItem --- Copyright : (c) 2013-2016 Brendan Hay +-- Copyright : (c) 2013-2017 Brendan Hay -- License : Mozilla Public License, v. 2.0. --- Maintainer : Brendan Hay +-- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value. -- -- --- In addition to deleting an item, you can also return the item's attribute values in the same operation, using the /ReturnValues/ parameter. +-- In addition to deleting an item, you can also return the item's attribute values in the same operation, using the @ReturnValues@ parameter. -- --- Unless you specify conditions, the /DeleteItem/ is an idempotent operation; running it multiple times on the same item or attribute does /not/ result in an error response. +-- Unless you specify conditions, the @DeleteItem@ is an idempotent operation; running it multiple times on the same item or attribute does /not/ result in an error response. -- -- Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted. -- @@ -54,80 +54,82 @@ , dirsResponseStatus ) where -import Network.AWS.DynamoDB.Types -import Network.AWS.DynamoDB.Types.Product -import Network.AWS.Lens -import Network.AWS.Prelude -import Network.AWS.Request -import Network.AWS.Response +import Network.AWS.DynamoDB.Types +import Network.AWS.DynamoDB.Types.Product +import Network.AWS.Lens +import Network.AWS.Prelude +import Network.AWS.Request +import Network.AWS.Response --- | Represents the input of a /DeleteItem/ operation. +-- | Represents the input of a @DeleteItem@ operation. -- -- -- -- /See:/ 'deleteItem' smart constructor. data DeleteItem = DeleteItem' - { _diExpressionAttributeNames :: !(Maybe (Map Text Text)) - , _diReturnValues :: !(Maybe ReturnValue) - , _diExpressionAttributeValues :: !(Maybe (Map Text AttributeValue)) - , _diReturnConsumedCapacity :: !(Maybe ReturnConsumedCapacity) - , _diReturnItemCollectionMetrics :: !(Maybe ReturnItemCollectionMetrics) - , _diConditionExpression :: !(Maybe Text) - , _diConditionalOperator :: !(Maybe ConditionalOperator) - , _diExpected :: !(Maybe (Map Text ExpectedAttributeValue)) - , _diTableName :: !Text - , _diKey :: !(Map Text AttributeValue) - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _diExpressionAttributeNames :: !(Maybe (Map Text Text)) + , _diReturnValues :: !(Maybe ReturnValue) + , _diExpressionAttributeValues :: !(Maybe (Map Text AttributeValue)) + , _diReturnConsumedCapacity :: !(Maybe ReturnConsumedCapacity) + , _diReturnItemCollectionMetrics :: !(Maybe ReturnItemCollectionMetrics) + , _diConditionExpression :: !(Maybe Text) + , _diConditionalOperator :: !(Maybe ConditionalOperator) + , _diExpected :: !(Maybe (Map Text ExpectedAttributeValue)) + , _diTableName :: !Text + , _diKey :: !(Map Text AttributeValue) + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'DeleteItem' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'diExpressionAttributeNames' - 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for /ExpressionAttributeNames/ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . +-- * 'diExpressionAttributeNames' - 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for @ExpressionAttributeNames@ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . -- --- * 'diReturnValues' - Use /ReturnValues/ if you want to get the item attributes as they appeared before they were deleted. For /DeleteItem/ , the valid values are: * @NONE@ - If /ReturnValues/ is not specified, or if its value is @NONE@ , then nothing is returned. (This setting is the default for /ReturnValues/ .) * @ALL_OLD@ - The content of the old item is returned. +-- * 'diReturnValues' - Use @ReturnValues@ if you want to get the item attributes as they appeared before they were deleted. For @DeleteItem@ , the valid values are: * @NONE@ - If @ReturnValues@ is not specified, or if its value is @NONE@ , then nothing is returned. (This setting is the default for @ReturnValues@ .) * @ALL_OLD@ - The content of the old item is returned. -- --- * 'diExpressionAttributeValues' - 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 in the /Amazon DynamoDB Developer Guide/ . +-- * 'diExpressionAttributeValues' - 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 in the /Amazon DynamoDB Developer Guide/ . -- -- * 'diReturnConsumedCapacity' - Undocumented member. -- -- * 'diReturnItemCollectionMetrics' - Determines whether item collection metrics are returned. If set to @SIZE@ , the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to @NONE@ (the default), no statistics are returned. -- --- * 'diConditionExpression' - A condition that must be satisfied in order for a conditional /DeleteItem/ to succeed. An expression can contain any of the following: * Functions: @attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size@ These function names are case-sensitive. * Comparison operators: @= | <> | < | > | <= | >= | BETWEEN | IN@ * Logical operators: @AND | OR | NOT@ For more information on condition expressions, see in the /Amazon DynamoDB Developer Guide/ . +-- * 'diConditionExpression' - A condition that must be satisfied in order for a conditional @DeleteItem@ to succeed. An expression can contain any of the following: * Functions: @attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size@ These function names are case-sensitive. * Comparison operators: @= | <> | < | > | <= | >= | BETWEEN | IN @ * Logical operators: @AND | OR | NOT@ For more information on condition expressions, see in the /Amazon DynamoDB Developer Guide/ . -- --- * 'diConditionalOperator' - /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /ConditionExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. A logical operator to apply to the conditions in the /Expected/ map: * @AND@ - If all of the conditions evaluate to true, then the entire map evaluates to true. * @OR@ - If at least one of the conditions evaluate to true, then the entire map evaluates to true. If you omit /ConditionalOperator/ , then @AND@ is the default. The operation will succeed only if the entire map evaluates to true. +-- * 'diConditionalOperator' - This is a legacy parameter. Use @ConditionExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . -- --- * 'diExpected' - /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /ConditionExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. A map of attribute/condition pairs. /Expected/ provides a conditional block for the /DeleteItem/ operation. Each element of /Expected/ consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each /Expected/ element, the result of the evaluation is either true or false. If you specify more than one element in the /Expected/ map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the /ConditionalOperator/ parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.) If the /Expected/ map evaluates to true, then the conditional operation succeeds; otherwise, it fails. /Expected/ contains the following: * /AttributeValueList/ - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the /ComparisonOperator/ being used. For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, @a@ is greater than @A@ , and @a@ is greater than @B@ . For a list of code values, see . For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. * /ComparisonOperator/ - A comparator for evaluating attributes in the /AttributeValueList/ . When performing the comparison, DynamoDB uses strongly consistent reads. The following comparison operators are available: @EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN@ The following are descriptions of each comparison operator. * @EQ@ : Equal. @EQ@ is supported for all datatypes, including lists and maps. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @NE@ : Not equal. @NE@ is supported for all datatypes, including lists and maps. /AttributeValueList/ can contain only one /AttributeValue/ of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an /AttributeValue/ of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @LE@ : Less than or equal. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @LT@ : Less than. /AttributeValueList/ can contain only one /AttributeValue/ of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GE@ : Greater than or equal. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GT@ : Greater than. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @NOT_NULL@ : The attribute exists. @NOT_NULL@ is supported for all datatypes, including lists and maps. * @NULL@ : The attribute does not exist. @NULL@ is supported for all datatypes, including lists and maps. * @CONTAINS@ : Checks for a subsequence, or value in a set. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it finds an exact match with any member of the set. CONTAINS is supported for lists: When evaluating "@a CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @NOT_CONTAINS@ : Checks for absence of a subsequence, or absence of a value in a set. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it /does not/ find an exact match with any member of the set. NOT_CONTAINS is supported for lists: When evaluating "@a NOT CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @BEGINS_WITH@ : Checks for a prefix. /AttributeValueList/ can contain only one /AttributeValue/ of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). * @IN@ : Checks for matching elements within two sets. /AttributeValueList/ can contain one or more /AttributeValue/ elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true. * @BETWEEN@ : Greater than or equal to the first value, and less than or equal to the second value. /AttributeValueList/ must contain two /AttributeValue/ elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not compare to @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ For usage examples of /AttributeValueList/ and /ComparisonOperator/ , see in the /Amazon DynamoDB Developer Guide/ . For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of /AttributeValueList/ and /ComparisonOperator/ : * /Value/ - A value for DynamoDB to compare with an attribute. * /Exists/ - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation: * If /Exists/ is @true@ , DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false. * If /Exists/ is @false@ , DynamoDB assumes that the attribute value does /not/ exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false. Note that the default value for /Exists/ is @true@ . The /Value/ and /Exists/ parameters are incompatible with /AttributeValueList/ and /ComparisonOperator/ . Note that if you use both sets of parameters at once, DynamoDB will return a /ValidationException/ exception. +-- * 'diExpected' - This is a legacy parameter. Use @ConditionExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . -- -- * 'diTableName' - The name of the table from which to delete the item. -- --- * 'diKey' - A map of attribute names to /AttributeValue/ objects, representing the primary key of the item to delete. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key. +-- * 'diKey' - A map of attribute names to @AttributeValue@ objects, representing the primary key of the item to delete. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key. deleteItem :: Text -- ^ 'diTableName' -> DeleteItem deleteItem pTableName_ = - DeleteItem' - { _diExpressionAttributeNames = Nothing - , _diReturnValues = Nothing - , _diExpressionAttributeValues = Nothing - , _diReturnConsumedCapacity = Nothing - , _diReturnItemCollectionMetrics = Nothing - , _diConditionExpression = Nothing - , _diConditionalOperator = Nothing - , _diExpected = Nothing - , _diTableName = pTableName_ - , _diKey = mempty - } + DeleteItem' + { _diExpressionAttributeNames = Nothing + , _diReturnValues = Nothing + , _diExpressionAttributeValues = Nothing + , _diReturnConsumedCapacity = Nothing + , _diReturnItemCollectionMetrics = Nothing + , _diConditionExpression = Nothing + , _diConditionalOperator = Nothing + , _diExpected = Nothing + , _diTableName = pTableName_ + , _diKey = mempty + } --- | 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for /ExpressionAttributeNames/ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . + +-- | 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for @ExpressionAttributeNames@ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . diExpressionAttributeNames :: Lens' DeleteItem (HashMap Text Text) diExpressionAttributeNames = lens _diExpressionAttributeNames (\ s a -> s{_diExpressionAttributeNames = a}) . _Default . _Map; --- | Use /ReturnValues/ if you want to get the item attributes as they appeared before they were deleted. For /DeleteItem/ , the valid values are: * @NONE@ - If /ReturnValues/ is not specified, or if its value is @NONE@ , then nothing is returned. (This setting is the default for /ReturnValues/ .) * @ALL_OLD@ - The content of the old item is returned. +-- | Use @ReturnValues@ if you want to get the item attributes as they appeared before they were deleted. For @DeleteItem@ , the valid values are: * @NONE@ - If @ReturnValues@ is not specified, or if its value is @NONE@ , then nothing is returned. (This setting is the default for @ReturnValues@ .) * @ALL_OLD@ - The content of the old item is returned. diReturnValues :: Lens' DeleteItem (Maybe ReturnValue) diReturnValues = lens _diReturnValues (\ s a -> s{_diReturnValues = a}); --- | 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 in the /Amazon DynamoDB Developer Guide/ . +-- | 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 in the /Amazon DynamoDB Developer Guide/ . diExpressionAttributeValues :: Lens' DeleteItem (HashMap Text AttributeValue) diExpressionAttributeValues = lens _diExpressionAttributeValues (\ s a -> s{_diExpressionAttributeValues = a}) . _Default . _Map; @@ -139,15 +141,15 @@ diReturnItemCollectionMetrics :: Lens' DeleteItem (Maybe ReturnItemCollectionMetrics) diReturnItemCollectionMetrics = lens _diReturnItemCollectionMetrics (\ s a -> s{_diReturnItemCollectionMetrics = a}); --- | A condition that must be satisfied in order for a conditional /DeleteItem/ to succeed. An expression can contain any of the following: * Functions: @attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size@ These function names are case-sensitive. * Comparison operators: @= | <> | < | > | <= | >= | BETWEEN | IN@ * Logical operators: @AND | OR | NOT@ For more information on condition expressions, see in the /Amazon DynamoDB Developer Guide/ . +-- | A condition that must be satisfied in order for a conditional @DeleteItem@ to succeed. An expression can contain any of the following: * Functions: @attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size@ These function names are case-sensitive. * Comparison operators: @= | <> | < | > | <= | >= | BETWEEN | IN @ * Logical operators: @AND | OR | NOT@ For more information on condition expressions, see in the /Amazon DynamoDB Developer Guide/ . diConditionExpression :: Lens' DeleteItem (Maybe Text) diConditionExpression = lens _diConditionExpression (\ s a -> s{_diConditionExpression = a}); --- | /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /ConditionExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. A logical operator to apply to the conditions in the /Expected/ map: * @AND@ - If all of the conditions evaluate to true, then the entire map evaluates to true. * @OR@ - If at least one of the conditions evaluate to true, then the entire map evaluates to true. If you omit /ConditionalOperator/ , then @AND@ is the default. The operation will succeed only if the entire map evaluates to true. +-- | This is a legacy parameter. Use @ConditionExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . diConditionalOperator :: Lens' DeleteItem (Maybe ConditionalOperator) diConditionalOperator = lens _diConditionalOperator (\ s a -> s{_diConditionalOperator = a}); --- | /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /ConditionExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. A map of attribute/condition pairs. /Expected/ provides a conditional block for the /DeleteItem/ operation. Each element of /Expected/ consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each /Expected/ element, the result of the evaluation is either true or false. If you specify more than one element in the /Expected/ map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the /ConditionalOperator/ parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.) If the /Expected/ map evaluates to true, then the conditional operation succeeds; otherwise, it fails. /Expected/ contains the following: * /AttributeValueList/ - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the /ComparisonOperator/ being used. For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, @a@ is greater than @A@ , and @a@ is greater than @B@ . For a list of code values, see . For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. * /ComparisonOperator/ - A comparator for evaluating attributes in the /AttributeValueList/ . When performing the comparison, DynamoDB uses strongly consistent reads. The following comparison operators are available: @EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN@ The following are descriptions of each comparison operator. * @EQ@ : Equal. @EQ@ is supported for all datatypes, including lists and maps. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @NE@ : Not equal. @NE@ is supported for all datatypes, including lists and maps. /AttributeValueList/ can contain only one /AttributeValue/ of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an /AttributeValue/ of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @LE@ : Less than or equal. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @LT@ : Less than. /AttributeValueList/ can contain only one /AttributeValue/ of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GE@ : Greater than or equal. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GT@ : Greater than. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @NOT_NULL@ : The attribute exists. @NOT_NULL@ is supported for all datatypes, including lists and maps. * @NULL@ : The attribute does not exist. @NULL@ is supported for all datatypes, including lists and maps. * @CONTAINS@ : Checks for a subsequence, or value in a set. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it finds an exact match with any member of the set. CONTAINS is supported for lists: When evaluating "@a CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @NOT_CONTAINS@ : Checks for absence of a subsequence, or absence of a value in a set. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it /does not/ find an exact match with any member of the set. NOT_CONTAINS is supported for lists: When evaluating "@a NOT CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @BEGINS_WITH@ : Checks for a prefix. /AttributeValueList/ can contain only one /AttributeValue/ of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). * @IN@ : Checks for matching elements within two sets. /AttributeValueList/ can contain one or more /AttributeValue/ elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true. * @BETWEEN@ : Greater than or equal to the first value, and less than or equal to the second value. /AttributeValueList/ must contain two /AttributeValue/ elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not compare to @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ For usage examples of /AttributeValueList/ and /ComparisonOperator/ , see in the /Amazon DynamoDB Developer Guide/ . For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of /AttributeValueList/ and /ComparisonOperator/ : * /Value/ - A value for DynamoDB to compare with an attribute. * /Exists/ - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation: * If /Exists/ is @true@ , DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false. * If /Exists/ is @false@ , DynamoDB assumes that the attribute value does /not/ exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false. Note that the default value for /Exists/ is @true@ . The /Value/ and /Exists/ parameters are incompatible with /AttributeValueList/ and /ComparisonOperator/ . Note that if you use both sets of parameters at once, DynamoDB will return a /ValidationException/ exception. +-- | This is a legacy parameter. Use @ConditionExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . diExpected :: Lens' DeleteItem (HashMap Text ExpectedAttributeValue) diExpected = lens _diExpected (\ s a -> s{_diExpected = a}) . _Default . _Map; @@ -155,7 +157,7 @@ diTableName :: Lens' DeleteItem Text diTableName = lens _diTableName (\ s a -> s{_diTableName = a}); --- | A map of attribute names to /AttributeValue/ objects, representing the primary key of the item to delete. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key. +-- | A map of attribute names to @AttributeValue@ objects, representing the primary key of the item to delete. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key. diKey :: Lens' DeleteItem (HashMap Text AttributeValue) diKey = lens _diKey (\ s a -> s{_diKey = a}) . _Map; @@ -171,9 +173,9 @@ <*> (x .?> "Attributes" .!@ mempty) <*> (pure (fromEnum s))) -instance Hashable DeleteItem +instance Hashable DeleteItem where -instance NFData DeleteItem +instance NFData DeleteItem where instance ToHeaders DeleteItem where toHeaders @@ -211,49 +213,51 @@ instance ToQuery DeleteItem where toQuery = const mempty --- | Represents the output of a /DeleteItem/ operation. +-- | Represents the output of a @DeleteItem@ operation. -- -- -- -- /See:/ 'deleteItemResponse' smart constructor. data DeleteItemResponse = DeleteItemResponse' - { _dirsItemCollectionMetrics :: !(Maybe ItemCollectionMetrics) - , _dirsConsumedCapacity :: !(Maybe ConsumedCapacity) - , _dirsAttributes :: !(Maybe (Map Text AttributeValue)) - , _dirsResponseStatus :: !Int - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _dirsItemCollectionMetrics :: !(Maybe ItemCollectionMetrics) + , _dirsConsumedCapacity :: !(Maybe ConsumedCapacity) + , _dirsAttributes :: !(Maybe (Map Text AttributeValue)) + , _dirsResponseStatus :: !Int + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'DeleteItemResponse' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'dirsItemCollectionMetrics' - Information about item collections, if any, that were affected by the operation. /ItemCollectionMetrics/ is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response. Each /ItemCollectionMetrics/ element consists of: * /ItemCollectionKey/ - The partition key value of the item collection. This is the same as the partition key value of the item itself. * /SizeEstimateRange/ - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. +-- * 'dirsItemCollectionMetrics' - Information about item collections, if any, that were affected by the @DeleteItem@ operation. @ItemCollectionMetrics@ is only returned if the @ReturnItemCollectionMetrics@ parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response. Each @ItemCollectionMetrics@ element consists of: * @ItemCollectionKey@ - The partition key value of the item collection. This is the same as the partition key value of the item itself. * @SizeEstimateRange@ - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. -- --- * 'dirsConsumedCapacity' - Undocumented member. +-- * 'dirsConsumedCapacity' - The capacity units consumed by the @DeleteItem@ 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 in the /Amazon DynamoDB Developer Guide/ . -- --- * 'dirsAttributes' - A map of attribute names to /AttributeValue/ objects, representing the item as it appeared before the /DeleteItem/ operation. This map appears in the response only if /ReturnValues/ was specified as @ALL_OLD@ in the request. +-- * 'dirsAttributes' - A map of attribute names to @AttributeValue@ objects, representing the item as it appeared before the @DeleteItem@ operation. This map appears in the response only if @ReturnValues@ was specified as @ALL_OLD@ in the request. -- -- * 'dirsResponseStatus' - -- | The response status code. deleteItemResponse :: Int -- ^ 'dirsResponseStatus' -> DeleteItemResponse deleteItemResponse pResponseStatus_ = - DeleteItemResponse' - { _dirsItemCollectionMetrics = Nothing - , _dirsConsumedCapacity = Nothing - , _dirsAttributes = Nothing - , _dirsResponseStatus = pResponseStatus_ - } + DeleteItemResponse' + { _dirsItemCollectionMetrics = Nothing + , _dirsConsumedCapacity = Nothing + , _dirsAttributes = Nothing + , _dirsResponseStatus = pResponseStatus_ + } --- | Information about item collections, if any, that were affected by the operation. /ItemCollectionMetrics/ is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response. Each /ItemCollectionMetrics/ element consists of: * /ItemCollectionKey/ - The partition key value of the item collection. This is the same as the partition key value of the item itself. * /SizeEstimateRange/ - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. + +-- | Information about item collections, if any, that were affected by the @DeleteItem@ operation. @ItemCollectionMetrics@ is only returned if the @ReturnItemCollectionMetrics@ parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response. Each @ItemCollectionMetrics@ element consists of: * @ItemCollectionKey@ - The partition key value of the item collection. This is the same as the partition key value of the item itself. * @SizeEstimateRange@ - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. dirsItemCollectionMetrics :: Lens' DeleteItemResponse (Maybe ItemCollectionMetrics) dirsItemCollectionMetrics = lens _dirsItemCollectionMetrics (\ s a -> s{_dirsItemCollectionMetrics = a}); --- | Undocumented member. +-- | The capacity units consumed by the @DeleteItem@ 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 in the /Amazon DynamoDB Developer Guide/ . dirsConsumedCapacity :: Lens' DeleteItemResponse (Maybe ConsumedCapacity) dirsConsumedCapacity = lens _dirsConsumedCapacity (\ s a -> s{_dirsConsumedCapacity = a}); --- | A map of attribute names to /AttributeValue/ objects, representing the item as it appeared before the /DeleteItem/ operation. This map appears in the response only if /ReturnValues/ was specified as @ALL_OLD@ in the request. +-- | A map of attribute names to @AttributeValue@ objects, representing the item as it appeared before the @DeleteItem@ operation. This map appears in the response only if @ReturnValues@ was specified as @ALL_OLD@ in the request. dirsAttributes :: Lens' DeleteItemResponse (HashMap Text AttributeValue) dirsAttributes = lens _dirsAttributes (\ s a -> s{_dirsAttributes = a}) . _Default . _Map; @@ -261,4 +265,4 @@ dirsResponseStatus :: Lens' DeleteItemResponse Int dirsResponseStatus = lens _dirsResponseStatus (\ s a -> s{_dirsResponseStatus = a}); -instance NFData DeleteItemResponse +instance NFData DeleteItemResponse where diff --git a/gen/Network/AWS/DynamoDB/DeleteTable.hs b/gen/Network/AWS/DynamoDB/DeleteTable.hs --- a/gen/Network/AWS/DynamoDB/DeleteTable.hs +++ b/gen/Network/AWS/DynamoDB/DeleteTable.hs @@ -12,20 +12,20 @@ -- | -- Module : Network.AWS.DynamoDB.DeleteTable --- Copyright : (c) 2013-2016 Brendan Hay +-- Copyright : (c) 2013-2017 Brendan Hay -- License : Mozilla Public License, v. 2.0. --- Maintainer : Brendan Hay +-- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- The /DeleteTable/ operation deletes a table and all of its items. After a /DeleteTable/ request, the specified table is in the @DELETING@ state until DynamoDB completes the deletion. If the table is in the @ACTIVE@ state, you can delete it. If a table is in @CREATING@ or @UPDATING@ states, then DynamoDB returns a /ResourceInUseException/ . If the specified table does not exist, DynamoDB returns a /ResourceNotFoundException/ . If table is already in the @DELETING@ state, no error is returned. +-- The @DeleteTable@ operation deletes a table and all of its items. After a @DeleteTable@ request, the specified table is in the @DELETING@ state until DynamoDB completes the deletion. If the table is in the @ACTIVE@ state, you can delete it. If a table is in @CREATING@ or @UPDATING@ states, then DynamoDB returns a @ResourceInUseException@ . If the specified table does not exist, DynamoDB returns a @ResourceNotFoundException@ . If table is already in the @DELETING@ state, no error is returned. -- -- -- When you delete a table, any indexes on that table are also deleted. -- -- If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the @DISABLED@ state, and the stream is automatically deleted after 24 hours. -- --- Use the /DescribeTable/ API to check the status of the table. +-- Use the @DescribeTable@ action to check the status of the table. -- module Network.AWS.DynamoDB.DeleteTable ( @@ -43,22 +43,23 @@ , dtrsResponseStatus ) where -import Network.AWS.DynamoDB.Types -import Network.AWS.DynamoDB.Types.Product -import Network.AWS.Lens -import Network.AWS.Prelude -import Network.AWS.Request -import Network.AWS.Response +import Network.AWS.DynamoDB.Types +import Network.AWS.DynamoDB.Types.Product +import Network.AWS.Lens +import Network.AWS.Prelude +import Network.AWS.Request +import Network.AWS.Response --- | Represents the input of a /DeleteTable/ operation. +-- | Represents the input of a @DeleteTable@ operation. -- -- -- -- /See:/ 'deleteTable' smart constructor. newtype DeleteTable = DeleteTable' - { _dtTableName :: Text - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _dtTableName :: Text + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'DeleteTable' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -67,11 +68,9 @@ deleteTable :: Text -- ^ 'dtTableName' -> DeleteTable -deleteTable pTableName_ = - DeleteTable' - { _dtTableName = pTableName_ - } +deleteTable pTableName_ = DeleteTable' {_dtTableName = pTableName_} + -- | The name of the table to delete. dtTableName :: Lens' DeleteTable Text dtTableName = lens _dtTableName (\ s a -> s{_dtTableName = a}); @@ -85,9 +84,9 @@ DeleteTableResponse' <$> (x .?> "TableDescription") <*> (pure (fromEnum s))) -instance Hashable DeleteTable +instance Hashable DeleteTable where -instance NFData DeleteTable +instance NFData DeleteTable where instance ToHeaders DeleteTable where toHeaders @@ -109,33 +108,33 @@ instance ToQuery DeleteTable where toQuery = const mempty --- | Represents the output of a /DeleteTable/ operation. +-- | Represents the output of a @DeleteTable@ operation. -- -- -- -- /See:/ 'deleteTableResponse' smart constructor. data DeleteTableResponse = DeleteTableResponse' - { _dtrsTableDescription :: !(Maybe TableDescription) - , _dtrsResponseStatus :: !Int - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _dtrsTableDescription :: !(Maybe TableDescription) + , _dtrsResponseStatus :: !Int + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'DeleteTableResponse' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'dtrsTableDescription' - Undocumented member. +-- * 'dtrsTableDescription' - Represents the properties of a table. -- -- * 'dtrsResponseStatus' - -- | The response status code. deleteTableResponse :: Int -- ^ 'dtrsResponseStatus' -> DeleteTableResponse deleteTableResponse pResponseStatus_ = - DeleteTableResponse' - { _dtrsTableDescription = Nothing - , _dtrsResponseStatus = pResponseStatus_ - } + DeleteTableResponse' + {_dtrsTableDescription = Nothing, _dtrsResponseStatus = pResponseStatus_} --- | Undocumented member. + +-- | Represents the properties of a table. dtrsTableDescription :: Lens' DeleteTableResponse (Maybe TableDescription) dtrsTableDescription = lens _dtrsTableDescription (\ s a -> s{_dtrsTableDescription = a}); @@ -143,4 +142,4 @@ dtrsResponseStatus :: Lens' DeleteTableResponse Int dtrsResponseStatus = lens _dtrsResponseStatus (\ s a -> s{_dtrsResponseStatus = a}); -instance NFData DeleteTableResponse +instance NFData DeleteTableResponse where diff --git a/gen/Network/AWS/DynamoDB/DescribeLimits.hs b/gen/Network/AWS/DynamoDB/DescribeLimits.hs --- a/gen/Network/AWS/DynamoDB/DescribeLimits.hs +++ b/gen/Network/AWS/DynamoDB/DescribeLimits.hs @@ -12,9 +12,9 @@ -- | -- Module : Network.AWS.DynamoDB.DescribeLimits --- Copyright : (c) 2013-2016 Brendan Hay +-- Copyright : (c) 2013-2017 Brendan Hay -- License : Mozilla Public License, v. 2.0. --- Maintainer : Brendan Hay +-- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- @@ -23,27 +23,27 @@ -- -- When you establish an AWS account, the account has initial limits on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given region. Also, there are per-table limits that apply when you create a table there. For more information, see page in the /Amazon DynamoDB Developer Guide/ . -- --- Although you can increase these limits by filing a case at , obtaining the increase is not instantaneous. The /DescribeLimits/ API lets you write code to compare the capacity you are currently using to those limits imposed by your account so that you have enough time to apply for an increase before you hit a limit. +-- Although you can increase these limits by filing a case at , obtaining the increase is not instantaneous. The @DescribeLimits@ action lets you write code to compare the capacity you are currently using to those limits imposed by your account so that you have enough time to apply for an increase before you hit a limit. -- -- For example, you could use one of the AWS SDKs to do the following: -- --- * Call /DescribeLimits/ for a particular region to obtain your current account limits on provisioned capacity there. +-- * Call @DescribeLimits@ for a particular region to obtain your current account limits on provisioned capacity there. -- -- * Create a variable to hold the aggregate read capacity units provisioned for all your tables in that region, and one to hold the aggregate write capacity units. Zero them both. -- --- * Call /ListTables/ to obtain a list of all your DynamoDB tables. +-- * Call @ListTables@ to obtain a list of all your DynamoDB tables. -- --- * For each table name listed by /ListTables/ , do the following: +-- * For each table name listed by @ListTables@ , do the following: -- --- * Call /DescribeTable/ with the table name. +-- * Call @DescribeTable@ with the table name. -- --- * Use the data returned by /DescribeTable/ to add the read capacity units and write capacity units provisioned for the table itself to your variables. +-- * Use the data returned by @DescribeTable@ to add the read capacity units and write capacity units provisioned for the table itself to your variables. -- -- * If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well. -- -- -- --- * Report the account limits for that region returned by /DescribeLimits/ , along with the total current provisioned capacity levels you have calculated. +-- * Report the account limits for that region returned by @DescribeLimits@ , along with the total current provisioned capacity levels you have calculated. -- -- -- @@ -53,7 +53,7 @@ -- -- For existing tables and their GSIs, DynamoDB will not let you increase provisioned capacity extremely rapidly, but the only upper limit that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account limits. -- --- The /DescribeLimits/ Request element has no content. +-- The @DescribeLimits@ Request element has no content. -- module Network.AWS.DynamoDB.DescribeLimits ( @@ -72,28 +72,30 @@ , dlrsResponseStatus ) where -import Network.AWS.DynamoDB.Types -import Network.AWS.DynamoDB.Types.Product -import Network.AWS.Lens -import Network.AWS.Prelude -import Network.AWS.Request -import Network.AWS.Response +import Network.AWS.DynamoDB.Types +import Network.AWS.DynamoDB.Types.Product +import Network.AWS.Lens +import Network.AWS.Prelude +import Network.AWS.Request +import Network.AWS.Response --- | Represents the input of a /DescribeLimits/ operation. Has no content. +-- | Represents the input of a @DescribeLimits@ operation. Has no content. -- -- -- -- /See:/ 'describeLimits' smart constructor. data DescribeLimits = - DescribeLimits' - deriving (Eq,Read,Show,Data,Typeable,Generic) + DescribeLimits' + deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'DescribeLimits' with the minimum fields required to make a request. -- describeLimits :: DescribeLimits describeLimits = DescribeLimits' + instance AWSRequest DescribeLimits where type Rs DescribeLimits = DescribeLimitsResponse request = postJSON dynamoDB @@ -107,9 +109,9 @@ <*> (x .?> "AccountMaxReadCapacityUnits") <*> (pure (fromEnum s))) -instance Hashable DescribeLimits +instance Hashable DescribeLimits where -instance NFData DescribeLimits +instance NFData DescribeLimits where instance ToHeaders DescribeLimits where toHeaders @@ -129,19 +131,20 @@ instance ToQuery DescribeLimits where toQuery = const mempty --- | Represents the output of a /DescribeLimits/ operation. +-- | Represents the output of a @DescribeLimits@ operation. -- -- -- -- /See:/ 'describeLimitsResponse' smart constructor. data DescribeLimitsResponse = DescribeLimitsResponse' - { _dlrsTableMaxWriteCapacityUnits :: !(Maybe Nat) - , _dlrsTableMaxReadCapacityUnits :: !(Maybe Nat) - , _dlrsAccountMaxWriteCapacityUnits :: !(Maybe Nat) - , _dlrsAccountMaxReadCapacityUnits :: !(Maybe Nat) - , _dlrsResponseStatus :: !Int - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _dlrsTableMaxWriteCapacityUnits :: !(Maybe Nat) + , _dlrsTableMaxReadCapacityUnits :: !(Maybe Nat) + , _dlrsAccountMaxWriteCapacityUnits :: !(Maybe Nat) + , _dlrsAccountMaxReadCapacityUnits :: !(Maybe Nat) + , _dlrsResponseStatus :: !Int + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'DescribeLimitsResponse' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -159,14 +162,15 @@ :: Int -- ^ 'dlrsResponseStatus' -> DescribeLimitsResponse describeLimitsResponse pResponseStatus_ = - DescribeLimitsResponse' - { _dlrsTableMaxWriteCapacityUnits = Nothing - , _dlrsTableMaxReadCapacityUnits = Nothing - , _dlrsAccountMaxWriteCapacityUnits = Nothing - , _dlrsAccountMaxReadCapacityUnits = Nothing - , _dlrsResponseStatus = pResponseStatus_ - } + DescribeLimitsResponse' + { _dlrsTableMaxWriteCapacityUnits = Nothing + , _dlrsTableMaxReadCapacityUnits = Nothing + , _dlrsAccountMaxWriteCapacityUnits = Nothing + , _dlrsAccountMaxReadCapacityUnits = Nothing + , _dlrsResponseStatus = pResponseStatus_ + } + -- | The maximum write capacity units that your account allows you to provision for a new table that you are creating in this region, including the write capacity units provisioned for its global secondary indexes (GSIs). dlrsTableMaxWriteCapacityUnits :: Lens' DescribeLimitsResponse (Maybe Natural) dlrsTableMaxWriteCapacityUnits = lens _dlrsTableMaxWriteCapacityUnits (\ s a -> s{_dlrsTableMaxWriteCapacityUnits = a}) . mapping _Nat; @@ -187,4 +191,4 @@ dlrsResponseStatus :: Lens' DescribeLimitsResponse Int dlrsResponseStatus = lens _dlrsResponseStatus (\ s a -> s{_dlrsResponseStatus = a}); -instance NFData DescribeLimitsResponse +instance NFData DescribeLimitsResponse where diff --git a/gen/Network/AWS/DynamoDB/DescribeTable.hs b/gen/Network/AWS/DynamoDB/DescribeTable.hs --- a/gen/Network/AWS/DynamoDB/DescribeTable.hs +++ b/gen/Network/AWS/DynamoDB/DescribeTable.hs @@ -12,9 +12,9 @@ -- | -- Module : Network.AWS.DynamoDB.DescribeTable --- Copyright : (c) 2013-2016 Brendan Hay +-- Copyright : (c) 2013-2017 Brendan Hay -- License : Mozilla Public License, v. 2.0. --- Maintainer : Brendan Hay +-- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- @@ -37,22 +37,23 @@ , drsResponseStatus ) where -import Network.AWS.DynamoDB.Types -import Network.AWS.DynamoDB.Types.Product -import Network.AWS.Lens -import Network.AWS.Prelude -import Network.AWS.Request -import Network.AWS.Response +import Network.AWS.DynamoDB.Types +import Network.AWS.DynamoDB.Types.Product +import Network.AWS.Lens +import Network.AWS.Prelude +import Network.AWS.Request +import Network.AWS.Response --- | Represents the input of a /DescribeTable/ operation. +-- | Represents the input of a @DescribeTable@ operation. -- -- -- -- /See:/ 'describeTable' smart constructor. newtype DescribeTable = DescribeTable' - { _dTableName :: Text - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _dTableName :: Text + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'DescribeTable' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -61,11 +62,9 @@ describeTable :: Text -- ^ 'dTableName' -> DescribeTable -describeTable pTableName_ = - DescribeTable' - { _dTableName = pTableName_ - } +describeTable pTableName_ = DescribeTable' {_dTableName = pTableName_} + -- | The name of the table to describe. dTableName :: Lens' DescribeTable Text dTableName = lens _dTableName (\ s a -> s{_dTableName = a}); @@ -79,9 +78,9 @@ DescribeTableResponse' <$> (x .?> "Table") <*> (pure (fromEnum s))) -instance Hashable DescribeTable +instance Hashable DescribeTable where -instance NFData DescribeTable +instance NFData DescribeTable where instance ToHeaders DescribeTable where toHeaders @@ -103,33 +102,33 @@ instance ToQuery DescribeTable where toQuery = const mempty --- | Represents the output of a /DescribeTable/ operation. +-- | Represents the output of a @DescribeTable@ operation. -- -- -- -- /See:/ 'describeTableResponse' smart constructor. data DescribeTableResponse = DescribeTableResponse' - { _drsTable :: !(Maybe TableDescription) - , _drsResponseStatus :: !Int - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _drsTable :: !(Maybe TableDescription) + , _drsResponseStatus :: !Int + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'DescribeTableResponse' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'drsTable' - Undocumented member. +-- * 'drsTable' - The properties of the table. -- -- * 'drsResponseStatus' - -- | The response status code. describeTableResponse :: Int -- ^ 'drsResponseStatus' -> DescribeTableResponse describeTableResponse pResponseStatus_ = - DescribeTableResponse' - { _drsTable = Nothing - , _drsResponseStatus = pResponseStatus_ - } + DescribeTableResponse' + {_drsTable = Nothing, _drsResponseStatus = pResponseStatus_} --- | Undocumented member. + +-- | The properties of the table. drsTable :: Lens' DescribeTableResponse (Maybe TableDescription) drsTable = lens _drsTable (\ s a -> s{_drsTable = a}); @@ -137,4 +136,4 @@ drsResponseStatus :: Lens' DescribeTableResponse Int drsResponseStatus = lens _drsResponseStatus (\ s a -> s{_drsResponseStatus = a}); -instance NFData DescribeTableResponse +instance NFData DescribeTableResponse where diff --git a/gen/Network/AWS/DynamoDB/DescribeTimeToLive.hs b/gen/Network/AWS/DynamoDB/DescribeTimeToLive.hs new file mode 100644 --- /dev/null +++ b/gen/Network/AWS/DynamoDB/DescribeTimeToLive.hs @@ -0,0 +1,137 @@ +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} +{-# LANGUAGE TypeFamilies #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} +{-# OPTIONS_GHC -fno-warn-unused-binds #-} +{-# OPTIONS_GHC -fno-warn-unused-matches #-} + +-- Derived from AWS service descriptions, licensed under Apache 2.0. + +-- | +-- Module : Network.AWS.DynamoDB.DescribeTimeToLive +-- Copyright : (c) 2013-2017 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +-- Gives a description of the Time to Live (TTL) status on the specified table. +-- +-- +module Network.AWS.DynamoDB.DescribeTimeToLive + ( + -- * Creating a Request + describeTimeToLive + , DescribeTimeToLive + -- * Request Lenses + , dttlTableName + + -- * Destructuring the Response + , describeTimeToLiveResponse + , DescribeTimeToLiveResponse + -- * Response Lenses + , dttlrsTimeToLiveDescription + , dttlrsResponseStatus + ) where + +import Network.AWS.DynamoDB.Types +import Network.AWS.DynamoDB.Types.Product +import Network.AWS.Lens +import Network.AWS.Prelude +import Network.AWS.Request +import Network.AWS.Response + +-- | /See:/ 'describeTimeToLive' smart constructor. +newtype DescribeTimeToLive = DescribeTimeToLive' + { _dttlTableName :: Text + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'DescribeTimeToLive' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'dttlTableName' - The name of the table to be described. +describeTimeToLive + :: Text -- ^ 'dttlTableName' + -> DescribeTimeToLive +describeTimeToLive pTableName_ = + DescribeTimeToLive' {_dttlTableName = pTableName_} + + +-- | The name of the table to be described. +dttlTableName :: Lens' DescribeTimeToLive Text +dttlTableName = lens _dttlTableName (\ s a -> s{_dttlTableName = a}); + +instance AWSRequest DescribeTimeToLive where + type Rs DescribeTimeToLive = + DescribeTimeToLiveResponse + request = postJSON dynamoDB + response + = receiveJSON + (\ s h x -> + DescribeTimeToLiveResponse' <$> + (x .?> "TimeToLiveDescription") <*> + (pure (fromEnum s))) + +instance Hashable DescribeTimeToLive where + +instance NFData DescribeTimeToLive where + +instance ToHeaders DescribeTimeToLive where + toHeaders + = const + (mconcat + ["X-Amz-Target" =# + ("DynamoDB_20120810.DescribeTimeToLive" :: + ByteString), + "Content-Type" =# + ("application/x-amz-json-1.0" :: ByteString)]) + +instance ToJSON DescribeTimeToLive where + toJSON DescribeTimeToLive'{..} + = object + (catMaybes [Just ("TableName" .= _dttlTableName)]) + +instance ToPath DescribeTimeToLive where + toPath = const "/" + +instance ToQuery DescribeTimeToLive where + toQuery = const mempty + +-- | /See:/ 'describeTimeToLiveResponse' smart constructor. +data DescribeTimeToLiveResponse = DescribeTimeToLiveResponse' + { _dttlrsTimeToLiveDescription :: !(Maybe TimeToLiveDescription) + , _dttlrsResponseStatus :: !Int + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'DescribeTimeToLiveResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'dttlrsTimeToLiveDescription' - +-- +-- * 'dttlrsResponseStatus' - -- | The response status code. +describeTimeToLiveResponse + :: Int -- ^ 'dttlrsResponseStatus' + -> DescribeTimeToLiveResponse +describeTimeToLiveResponse pResponseStatus_ = + DescribeTimeToLiveResponse' + { _dttlrsTimeToLiveDescription = Nothing + , _dttlrsResponseStatus = pResponseStatus_ + } + + +-- | +dttlrsTimeToLiveDescription :: Lens' DescribeTimeToLiveResponse (Maybe TimeToLiveDescription) +dttlrsTimeToLiveDescription = lens _dttlrsTimeToLiveDescription (\ s a -> s{_dttlrsTimeToLiveDescription = a}); + +-- | -- | The response status code. +dttlrsResponseStatus :: Lens' DescribeTimeToLiveResponse Int +dttlrsResponseStatus = lens _dttlrsResponseStatus (\ s a -> s{_dttlrsResponseStatus = a}); + +instance NFData DescribeTimeToLiveResponse where diff --git a/gen/Network/AWS/DynamoDB/GetItem.hs b/gen/Network/AWS/DynamoDB/GetItem.hs --- a/gen/Network/AWS/DynamoDB/GetItem.hs +++ b/gen/Network/AWS/DynamoDB/GetItem.hs @@ -12,16 +12,16 @@ -- | -- Module : Network.AWS.DynamoDB.GetItem --- Copyright : (c) 2013-2016 Brendan Hay +-- Copyright : (c) 2013-2017 Brendan Hay -- License : Mozilla Public License, v. 2.0. --- Maintainer : Brendan Hay +-- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- The /GetItem/ operation returns a set of attributes for the item with the given primary key. If there is no matching item, /GetItem/ does not return any data. +-- The @GetItem@ operation returns a set of attributes for the item with the given primary key. If there is no matching item, @GetItem@ does not return any data and there will be no @Item@ element in the response. -- -- --- /GetItem/ provides an eventually consistent read by default. If your application requires a strongly consistent read, set /ConsistentRead/ to @true@ . Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value. +-- @GetItem@ provides an eventually consistent read by default. If your application requires a strongly consistent read, set @ConsistentRead@ to @true@ . Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value. -- module Network.AWS.DynamoDB.GetItem ( @@ -46,37 +46,38 @@ , girsResponseStatus ) where -import Network.AWS.DynamoDB.Types -import Network.AWS.DynamoDB.Types.Product -import Network.AWS.Lens -import Network.AWS.Prelude -import Network.AWS.Request -import Network.AWS.Response +import Network.AWS.DynamoDB.Types +import Network.AWS.DynamoDB.Types.Product +import Network.AWS.Lens +import Network.AWS.Prelude +import Network.AWS.Request +import Network.AWS.Response --- | Represents the input of a /GetItem/ operation. +-- | Represents the input of a @GetItem@ operation. -- -- -- -- /See:/ 'getItem' smart constructor. data GetItem = GetItem' - { _giProjectionExpression :: !(Maybe Text) - , _giAttributesToGet :: !(Maybe (List1 Text)) - , _giExpressionAttributeNames :: !(Maybe (Map Text Text)) - , _giConsistentRead :: !(Maybe Bool) - , _giReturnConsumedCapacity :: !(Maybe ReturnConsumedCapacity) - , _giTableName :: !Text - , _giKey :: !(Map Text AttributeValue) - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _giProjectionExpression :: !(Maybe Text) + , _giAttributesToGet :: !(Maybe (List1 Text)) + , _giExpressionAttributeNames :: !(Maybe (Map Text Text)) + , _giConsistentRead :: !(Maybe Bool) + , _giReturnConsumedCapacity :: !(Maybe ReturnConsumedCapacity) + , _giTableName :: !Text + , _giKey :: !(Map Text AttributeValue) + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'GetItem' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- * 'giProjectionExpression' - 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 in the /Amazon DynamoDB Developer Guide/ . -- --- * 'giAttributesToGet' - /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /ProjectionExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map. The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. Note that /AttributesToGet/ has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application. +-- * 'giAttributesToGet' - This is a legacy parameter. Use @ProjectionExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . -- --- * 'giExpressionAttributeNames' - 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for /ExpressionAttributeNames/ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . +-- * 'giExpressionAttributeNames' - 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for @ExpressionAttributeNames@ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . -- -- * 'giConsistentRead' - Determines the read consistency model: If set to @true@ , then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads. -- @@ -84,30 +85,31 @@ -- -- * 'giTableName' - The name of the table containing the requested item. -- --- * 'giKey' - A map of attribute names to /AttributeValue/ objects, representing the primary key of the item to retrieve. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key. +-- * 'giKey' - A map of attribute names to @AttributeValue@ objects, representing the primary key of the item to retrieve. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key. getItem :: Text -- ^ 'giTableName' -> GetItem getItem pTableName_ = - GetItem' - { _giProjectionExpression = Nothing - , _giAttributesToGet = Nothing - , _giExpressionAttributeNames = Nothing - , _giConsistentRead = Nothing - , _giReturnConsumedCapacity = Nothing - , _giTableName = pTableName_ - , _giKey = mempty - } + GetItem' + { _giProjectionExpression = Nothing + , _giAttributesToGet = Nothing + , _giExpressionAttributeNames = Nothing + , _giConsistentRead = Nothing + , _giReturnConsumedCapacity = Nothing + , _giTableName = pTableName_ + , _giKey = mempty + } + -- | 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 in the /Amazon DynamoDB Developer Guide/ . giProjectionExpression :: Lens' GetItem (Maybe Text) giProjectionExpression = lens _giProjectionExpression (\ s a -> s{_giProjectionExpression = a}); --- | /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /ProjectionExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map. The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. Note that /AttributesToGet/ has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application. +-- | This is a legacy parameter. Use @ProjectionExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . giAttributesToGet :: Lens' GetItem (Maybe (NonEmpty Text)) giAttributesToGet = lens _giAttributesToGet (\ s a -> s{_giAttributesToGet = a}) . mapping _List1; --- | 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for /ExpressionAttributeNames/ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . +-- | 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for @ExpressionAttributeNames@ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . giExpressionAttributeNames :: Lens' GetItem (HashMap Text Text) giExpressionAttributeNames = lens _giExpressionAttributeNames (\ s a -> s{_giExpressionAttributeNames = a}) . _Default . _Map; @@ -123,7 +125,7 @@ giTableName :: Lens' GetItem Text giTableName = lens _giTableName (\ s a -> s{_giTableName = a}); --- | A map of attribute names to /AttributeValue/ objects, representing the primary key of the item to retrieve. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key. +-- | A map of attribute names to @AttributeValue@ objects, representing the primary key of the item to retrieve. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key. giKey :: Lens' GetItem (HashMap Text AttributeValue) giKey = lens _giKey (\ s a -> s{_giKey = a}) . _Map; @@ -138,9 +140,9 @@ (x .?> "Item" .!@ mempty) <*> (pure (fromEnum s))) -instance Hashable GetItem +instance Hashable GetItem where -instance NFData GetItem +instance NFData GetItem where instance ToHeaders GetItem where toHeaders @@ -172,41 +174,43 @@ instance ToQuery GetItem where toQuery = const mempty --- | Represents the output of a /GetItem/ operation. +-- | Represents the output of a @GetItem@ operation. -- -- -- -- /See:/ 'getItemResponse' smart constructor. data GetItemResponse = GetItemResponse' - { _girsConsumedCapacity :: !(Maybe ConsumedCapacity) - , _girsItem :: !(Maybe (Map Text AttributeValue)) - , _girsResponseStatus :: !Int - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _girsConsumedCapacity :: !(Maybe ConsumedCapacity) + , _girsItem :: !(Maybe (Map Text AttributeValue)) + , _girsResponseStatus :: !Int + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'GetItemResponse' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'girsConsumedCapacity' - Undocumented member. +-- * 'girsConsumedCapacity' - The capacity units consumed by the @GetItem@ 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 in the /Amazon DynamoDB Developer Guide/ . -- --- * 'girsItem' - A map of attribute names to /AttributeValue/ objects, as specified by /AttributesToGet/ . +-- * 'girsItem' - A map of attribute names to @AttributeValue@ objects, as specified by @ProjectionExpression@ . -- -- * 'girsResponseStatus' - -- | The response status code. getItemResponse :: Int -- ^ 'girsResponseStatus' -> GetItemResponse getItemResponse pResponseStatus_ = - GetItemResponse' - { _girsConsumedCapacity = Nothing - , _girsItem = Nothing - , _girsResponseStatus = pResponseStatus_ - } + GetItemResponse' + { _girsConsumedCapacity = Nothing + , _girsItem = Nothing + , _girsResponseStatus = pResponseStatus_ + } --- | Undocumented member. + +-- | The capacity units consumed by the @GetItem@ 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 in the /Amazon DynamoDB Developer Guide/ . girsConsumedCapacity :: Lens' GetItemResponse (Maybe ConsumedCapacity) girsConsumedCapacity = lens _girsConsumedCapacity (\ s a -> s{_girsConsumedCapacity = a}); --- | A map of attribute names to /AttributeValue/ objects, as specified by /AttributesToGet/ . +-- | A map of attribute names to @AttributeValue@ objects, as specified by @ProjectionExpression@ . girsItem :: Lens' GetItemResponse (HashMap Text AttributeValue) girsItem = lens _girsItem (\ s a -> s{_girsItem = a}) . _Default . _Map; @@ -214,4 +218,4 @@ girsResponseStatus :: Lens' GetItemResponse Int girsResponseStatus = lens _girsResponseStatus (\ s a -> s{_girsResponseStatus = a}); -instance NFData GetItemResponse +instance NFData GetItemResponse where diff --git a/gen/Network/AWS/DynamoDB/ListTables.hs b/gen/Network/AWS/DynamoDB/ListTables.hs --- a/gen/Network/AWS/DynamoDB/ListTables.hs +++ b/gen/Network/AWS/DynamoDB/ListTables.hs @@ -12,13 +12,13 @@ -- | -- Module : Network.AWS.DynamoDB.ListTables --- Copyright : (c) 2013-2016 Brendan Hay +-- Copyright : (c) 2013-2017 Brendan Hay -- License : Mozilla Public License, v. 2.0. --- Maintainer : Brendan Hay +-- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- Returns an array of table names associated with the current account and endpoint. The output from /ListTables/ is paginated, with each page returning a maximum of 100 table names. +-- Returns an array of table names associated with the current account and endpoint. The output from @ListTables@ is paginated, with each page returning a maximum of 100 table names. -- -- -- @@ -41,40 +41,39 @@ , ltrsResponseStatus ) where -import Network.AWS.DynamoDB.Types -import Network.AWS.DynamoDB.Types.Product -import Network.AWS.Lens -import Network.AWS.Pager -import Network.AWS.Prelude -import Network.AWS.Request -import Network.AWS.Response +import Network.AWS.DynamoDB.Types +import Network.AWS.DynamoDB.Types.Product +import Network.AWS.Lens +import Network.AWS.Pager +import Network.AWS.Prelude +import Network.AWS.Request +import Network.AWS.Response --- | Represents the input of a /ListTables/ operation. +-- | Represents the input of a @ListTables@ operation. -- -- -- -- /See:/ 'listTables' smart constructor. data ListTables = ListTables' - { _ltExclusiveStartTableName :: !(Maybe Text) - , _ltLimit :: !(Maybe Nat) - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _ltExclusiveStartTableName :: !(Maybe Text) + , _ltLimit :: !(Maybe Nat) + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'ListTables' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ltExclusiveStartTableName' - The first table name that this operation will evaluate. Use the value that was returned for /LastEvaluatedTableName/ in a previous operation, so that you can obtain the next page of results. +-- * 'ltExclusiveStartTableName' - The first table name that this operation will evaluate. Use the value that was returned for @LastEvaluatedTableName@ in a previous operation, so that you can obtain the next page of results. -- -- * 'ltLimit' - A maximum number of table names to return. If this parameter is not specified, the limit is 100. listTables :: ListTables listTables = - ListTables' - { _ltExclusiveStartTableName = Nothing - , _ltLimit = Nothing - } + ListTables' {_ltExclusiveStartTableName = Nothing, _ltLimit = Nothing} --- | The first table name that this operation will evaluate. Use the value that was returned for /LastEvaluatedTableName/ in a previous operation, so that you can obtain the next page of results. + +-- | The first table name that this operation will evaluate. Use the value that was returned for @LastEvaluatedTableName@ in a previous operation, so that you can obtain the next page of results. ltExclusiveStartTableName :: Lens' ListTables (Maybe Text) ltExclusiveStartTableName = lens _ltExclusiveStartTableName (\ s a -> s{_ltExclusiveStartTableName = a}); @@ -102,9 +101,9 @@ (x .?> "TableNames" .!@ mempty) <*> (pure (fromEnum s))) -instance Hashable ListTables +instance Hashable ListTables where -instance NFData ListTables +instance NFData ListTables where instance ToHeaders ListTables where toHeaders @@ -129,41 +128,43 @@ instance ToQuery ListTables where toQuery = const mempty --- | Represents the output of a /ListTables/ operation. +-- | Represents the output of a @ListTables@ operation. -- -- -- -- /See:/ 'listTablesResponse' smart constructor. data ListTablesResponse = ListTablesResponse' - { _ltrsLastEvaluatedTableName :: !(Maybe Text) - , _ltrsTableNames :: !(Maybe [Text]) - , _ltrsResponseStatus :: !Int - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _ltrsLastEvaluatedTableName :: !(Maybe Text) + , _ltrsTableNames :: !(Maybe [Text]) + , _ltrsResponseStatus :: !Int + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'ListTablesResponse' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ltrsLastEvaluatedTableName' - The name of the last table in the current page of results. Use this value as the /ExclusiveStartTableName/ in a new request to obtain the next page of results, until all the table names are returned. If you do not receive a /LastEvaluatedTableName/ value in the response, this means that there are no more table names to be retrieved. +-- * 'ltrsLastEvaluatedTableName' - The name of the last table in the current page of results. Use this value as the @ExclusiveStartTableName@ in a new request to obtain the next page of results, until all the table names are returned. If you do not receive a @LastEvaluatedTableName@ value in the response, this means that there are no more table names to be retrieved. -- --- * 'ltrsTableNames' - The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100. If /LastEvaluatedTableName/ also appears in the output, you can use this value as the /ExclusiveStartTableName/ parameter in a subsequent /ListTables/ request and obtain the next page of results. +-- * 'ltrsTableNames' - The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100. If @LastEvaluatedTableName@ also appears in the output, you can use this value as the @ExclusiveStartTableName@ parameter in a subsequent @ListTables@ request and obtain the next page of results. -- -- * 'ltrsResponseStatus' - -- | The response status code. listTablesResponse :: Int -- ^ 'ltrsResponseStatus' -> ListTablesResponse listTablesResponse pResponseStatus_ = - ListTablesResponse' - { _ltrsLastEvaluatedTableName = Nothing - , _ltrsTableNames = Nothing - , _ltrsResponseStatus = pResponseStatus_ - } + ListTablesResponse' + { _ltrsLastEvaluatedTableName = Nothing + , _ltrsTableNames = Nothing + , _ltrsResponseStatus = pResponseStatus_ + } --- | The name of the last table in the current page of results. Use this value as the /ExclusiveStartTableName/ in a new request to obtain the next page of results, until all the table names are returned. If you do not receive a /LastEvaluatedTableName/ value in the response, this means that there are no more table names to be retrieved. + +-- | The name of the last table in the current page of results. Use this value as the @ExclusiveStartTableName@ in a new request to obtain the next page of results, until all the table names are returned. If you do not receive a @LastEvaluatedTableName@ value in the response, this means that there are no more table names to be retrieved. ltrsLastEvaluatedTableName :: Lens' ListTablesResponse (Maybe Text) ltrsLastEvaluatedTableName = lens _ltrsLastEvaluatedTableName (\ s a -> s{_ltrsLastEvaluatedTableName = a}); --- | The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100. If /LastEvaluatedTableName/ also appears in the output, you can use this value as the /ExclusiveStartTableName/ parameter in a subsequent /ListTables/ request and obtain the next page of results. +-- | The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100. If @LastEvaluatedTableName@ also appears in the output, you can use this value as the @ExclusiveStartTableName@ parameter in a subsequent @ListTables@ request and obtain the next page of results. ltrsTableNames :: Lens' ListTablesResponse [Text] ltrsTableNames = lens _ltrsTableNames (\ s a -> s{_ltrsTableNames = a}) . _Default . _Coerce; @@ -171,4 +172,4 @@ ltrsResponseStatus :: Lens' ListTablesResponse Int ltrsResponseStatus = lens _ltrsResponseStatus (\ s a -> s{_ltrsResponseStatus = a}); -instance NFData ListTablesResponse +instance NFData ListTablesResponse where diff --git a/gen/Network/AWS/DynamoDB/ListTagsOfResource.hs b/gen/Network/AWS/DynamoDB/ListTagsOfResource.hs new file mode 100644 --- /dev/null +++ b/gen/Network/AWS/DynamoDB/ListTagsOfResource.hs @@ -0,0 +1,159 @@ +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} +{-# LANGUAGE TypeFamilies #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} +{-# OPTIONS_GHC -fno-warn-unused-binds #-} +{-# OPTIONS_GHC -fno-warn-unused-matches #-} + +-- Derived from AWS service descriptions, licensed under Apache 2.0. + +-- | +-- Module : Network.AWS.DynamoDB.ListTagsOfResource +-- Copyright : (c) 2013-2017 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +-- List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account. +-- +-- +-- For an overview on tagging DynamoDB resources, see in the /Amazon DynamoDB Developer Guide/ . +-- +module Network.AWS.DynamoDB.ListTagsOfResource + ( + -- * Creating a Request + listTagsOfResource + , ListTagsOfResource + -- * Request Lenses + , ltorNextToken + , ltorResourceARN + + -- * Destructuring the Response + , listTagsOfResourceResponse + , ListTagsOfResourceResponse + -- * Response Lenses + , ltorrsNextToken + , ltorrsTags + , ltorrsResponseStatus + ) where + +import Network.AWS.DynamoDB.Types +import Network.AWS.DynamoDB.Types.Product +import Network.AWS.Lens +import Network.AWS.Prelude +import Network.AWS.Request +import Network.AWS.Response + +-- | /See:/ 'listTagsOfResource' smart constructor. +data ListTagsOfResource = ListTagsOfResource' + { _ltorNextToken :: !(Maybe Text) + , _ltorResourceARN :: !Text + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ListTagsOfResource' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ltorNextToken' - An optional string that, if supplied, must be copied from the output of a previous call to ListTagOfResource. When provided in this manner, this API fetches the next page of results. +-- +-- * 'ltorResourceARN' - The Amazon DynamoDB resource with tags to be listed. This value is an Amazon Resource Name (ARN). +listTagsOfResource + :: Text -- ^ 'ltorResourceARN' + -> ListTagsOfResource +listTagsOfResource pResourceARN_ = + ListTagsOfResource' + {_ltorNextToken = Nothing, _ltorResourceARN = pResourceARN_} + + +-- | An optional string that, if supplied, must be copied from the output of a previous call to ListTagOfResource. When provided in this manner, this API fetches the next page of results. +ltorNextToken :: Lens' ListTagsOfResource (Maybe Text) +ltorNextToken = lens _ltorNextToken (\ s a -> s{_ltorNextToken = a}); + +-- | The Amazon DynamoDB resource with tags to be listed. This value is an Amazon Resource Name (ARN). +ltorResourceARN :: Lens' ListTagsOfResource Text +ltorResourceARN = lens _ltorResourceARN (\ s a -> s{_ltorResourceARN = a}); + +instance AWSRequest ListTagsOfResource where + type Rs ListTagsOfResource = + ListTagsOfResourceResponse + request = postJSON dynamoDB + response + = receiveJSON + (\ s h x -> + ListTagsOfResourceResponse' <$> + (x .?> "NextToken") <*> (x .?> "Tags" .!@ mempty) <*> + (pure (fromEnum s))) + +instance Hashable ListTagsOfResource where + +instance NFData ListTagsOfResource where + +instance ToHeaders ListTagsOfResource where + toHeaders + = const + (mconcat + ["X-Amz-Target" =# + ("DynamoDB_20120810.ListTagsOfResource" :: + ByteString), + "Content-Type" =# + ("application/x-amz-json-1.0" :: ByteString)]) + +instance ToJSON ListTagsOfResource where + toJSON ListTagsOfResource'{..} + = object + (catMaybes + [("NextToken" .=) <$> _ltorNextToken, + Just ("ResourceArn" .= _ltorResourceARN)]) + +instance ToPath ListTagsOfResource where + toPath = const "/" + +instance ToQuery ListTagsOfResource where + toQuery = const mempty + +-- | /See:/ 'listTagsOfResourceResponse' smart constructor. +data ListTagsOfResourceResponse = ListTagsOfResourceResponse' + { _ltorrsNextToken :: !(Maybe Text) + , _ltorrsTags :: !(Maybe [Tag]) + , _ltorrsResponseStatus :: !Int + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ListTagsOfResourceResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ltorrsNextToken' - If this value is returned, there are additional results to be displayed. To retrieve them, call ListTagsOfResource again, with NextToken set to this value. +-- +-- * 'ltorrsTags' - The tags currently associated with the Amazon DynamoDB resource. +-- +-- * 'ltorrsResponseStatus' - -- | The response status code. +listTagsOfResourceResponse + :: Int -- ^ 'ltorrsResponseStatus' + -> ListTagsOfResourceResponse +listTagsOfResourceResponse pResponseStatus_ = + ListTagsOfResourceResponse' + { _ltorrsNextToken = Nothing + , _ltorrsTags = Nothing + , _ltorrsResponseStatus = pResponseStatus_ + } + + +-- | If this value is returned, there are additional results to be displayed. To retrieve them, call ListTagsOfResource again, with NextToken set to this value. +ltorrsNextToken :: Lens' ListTagsOfResourceResponse (Maybe Text) +ltorrsNextToken = lens _ltorrsNextToken (\ s a -> s{_ltorrsNextToken = a}); + +-- | The tags currently associated with the Amazon DynamoDB resource. +ltorrsTags :: Lens' ListTagsOfResourceResponse [Tag] +ltorrsTags = lens _ltorrsTags (\ s a -> s{_ltorrsTags = a}) . _Default . _Coerce; + +-- | -- | The response status code. +ltorrsResponseStatus :: Lens' ListTagsOfResourceResponse Int +ltorrsResponseStatus = lens _ltorrsResponseStatus (\ s a -> s{_ltorrsResponseStatus = a}); + +instance NFData ListTagsOfResourceResponse where diff --git a/gen/Network/AWS/DynamoDB/PutItem.hs b/gen/Network/AWS/DynamoDB/PutItem.hs --- a/gen/Network/AWS/DynamoDB/PutItem.hs +++ b/gen/Network/AWS/DynamoDB/PutItem.hs @@ -12,23 +12,43 @@ -- | -- Module : Network.AWS.DynamoDB.PutItem --- Copyright : (c) 2013-2016 Brendan Hay +-- Copyright : (c) 2013-2017 Brendan Hay -- License : Mozilla Public License, v. 2.0. --- Maintainer : Brendan Hay +-- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. +-- Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. You can return the item's attribute values in the same operation, using the @ReturnValues@ parameter. -- -- --- In addition to putting an item, you can also return the item's attribute values in the same operation, using the /ReturnValues/ parameter. +-- /Important:/ This topic provides general information about the @PutItem@ API. -- --- When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a /ValidationException/ exception. +-- For information on how to call the @PutItem@ API using the AWS SDK in specific languages, see the following: -- --- You can request that /PutItem/ return either a copy of the original item (before the update) or a copy of the updated item (after the update). For more information, see the /ReturnValues/ description below. +-- * -- --- For more information about using this API, see in the /Amazon DynamoDB Developer Guide/ . +-- * -- +-- * +-- +-- * +-- +-- * +-- +-- * +-- +-- * +-- +-- * +-- +-- * +-- +-- +-- +-- When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a @ValidationException@ exception. +-- +-- For more information about @PutItem@ , see in the /Amazon DynamoDB Developer Guide/ . +-- module Network.AWS.DynamoDB.PutItem ( -- * Creating a Request @@ -56,80 +76,82 @@ , pirsResponseStatus ) where -import Network.AWS.DynamoDB.Types -import Network.AWS.DynamoDB.Types.Product -import Network.AWS.Lens -import Network.AWS.Prelude -import Network.AWS.Request -import Network.AWS.Response +import Network.AWS.DynamoDB.Types +import Network.AWS.DynamoDB.Types.Product +import Network.AWS.Lens +import Network.AWS.Prelude +import Network.AWS.Request +import Network.AWS.Response --- | Represents the input of a /PutItem/ operation. +-- | Represents the input of a @PutItem@ operation. -- -- -- -- /See:/ 'putItem' smart constructor. data PutItem = PutItem' - { _piExpressionAttributeNames :: !(Maybe (Map Text Text)) - , _piReturnValues :: !(Maybe ReturnValue) - , _piExpressionAttributeValues :: !(Maybe (Map Text AttributeValue)) - , _piReturnConsumedCapacity :: !(Maybe ReturnConsumedCapacity) - , _piReturnItemCollectionMetrics :: !(Maybe ReturnItemCollectionMetrics) - , _piConditionExpression :: !(Maybe Text) - , _piConditionalOperator :: !(Maybe ConditionalOperator) - , _piExpected :: !(Maybe (Map Text ExpectedAttributeValue)) - , _piTableName :: !Text - , _piItem :: !(Map Text AttributeValue) - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _piExpressionAttributeNames :: !(Maybe (Map Text Text)) + , _piReturnValues :: !(Maybe ReturnValue) + , _piExpressionAttributeValues :: !(Maybe (Map Text AttributeValue)) + , _piReturnConsumedCapacity :: !(Maybe ReturnConsumedCapacity) + , _piReturnItemCollectionMetrics :: !(Maybe ReturnItemCollectionMetrics) + , _piConditionExpression :: !(Maybe Text) + , _piConditionalOperator :: !(Maybe ConditionalOperator) + , _piExpected :: !(Maybe (Map Text ExpectedAttributeValue)) + , _piTableName :: !Text + , _piItem :: !(Map Text AttributeValue) + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'PutItem' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'piExpressionAttributeNames' - 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for /ExpressionAttributeNames/ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . +-- * 'piExpressionAttributeNames' - 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for @ExpressionAttributeNames@ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . -- --- * 'piReturnValues' - Use /ReturnValues/ if you want to get the item attributes as they appeared before they were updated with the /PutItem/ request. For /PutItem/ , the valid values are: * @NONE@ - If /ReturnValues/ is not specified, or if its value is @NONE@ , then nothing is returned. (This setting is the default for /ReturnValues/ .) * @ALL_OLD@ - If /PutItem/ overwrote an attribute name-value pair, then the content of the old item is returned. +-- * 'piReturnValues' - Use @ReturnValues@ if you want to get the item attributes as they appeared before they were updated with the @PutItem@ request. For @PutItem@ , the valid values are: * @NONE@ - If @ReturnValues@ is not specified, or if its value is @NONE@ , then nothing is returned. (This setting is the default for @ReturnValues@ .) * @ALL_OLD@ - If @PutItem@ overwrote an attribute name-value pair, then the content of the old item is returned. -- --- * 'piExpressionAttributeValues' - 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 in the /Amazon DynamoDB Developer Guide/ . +-- * 'piExpressionAttributeValues' - 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 in the /Amazon DynamoDB Developer Guide/ . -- -- * 'piReturnConsumedCapacity' - Undocumented member. -- -- * 'piReturnItemCollectionMetrics' - Determines whether item collection metrics are returned. If set to @SIZE@ , the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to @NONE@ (the default), no statistics are returned. -- --- * 'piConditionExpression' - A condition that must be satisfied in order for a conditional /PutItem/ operation to succeed. An expression can contain any of the following: * Functions: @attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size@ These function names are case-sensitive. * Comparison operators: @= | <> | < | > | <= | >= | BETWEEN | IN@ * Logical operators: @AND | OR | NOT@ For more information on condition expressions, see in the /Amazon DynamoDB Developer Guide/ . +-- * 'piConditionExpression' - A condition that must be satisfied in order for a conditional @PutItem@ operation to succeed. An expression can contain any of the following: * Functions: @attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size@ These function names are case-sensitive. * Comparison operators: @= | <> | < | > | <= | >= | BETWEEN | IN @ * Logical operators: @AND | OR | NOT@ For more information on condition expressions, see in the /Amazon DynamoDB Developer Guide/ . -- --- * 'piConditionalOperator' - /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /ConditionExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. A logical operator to apply to the conditions in the /Expected/ map: * @AND@ - If all of the conditions evaluate to true, then the entire map evaluates to true. * @OR@ - If at least one of the conditions evaluate to true, then the entire map evaluates to true. If you omit /ConditionalOperator/ , then @AND@ is the default. The operation will succeed only if the entire map evaluates to true. +-- * 'piConditionalOperator' - This is a legacy parameter. Use @ConditionExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . -- --- * 'piExpected' - /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /ConditionExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. A map of attribute/condition pairs. /Expected/ provides a conditional block for the /PutItem/ operation. Each element of /Expected/ consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each /Expected/ element, the result of the evaluation is either true or false. If you specify more than one element in the /Expected/ map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the /ConditionalOperator/ parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.) If the /Expected/ map evaluates to true, then the conditional operation succeeds; otherwise, it fails. /Expected/ contains the following: * /AttributeValueList/ - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the /ComparisonOperator/ being used. For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, @a@ is greater than @A@ , and @a@ is greater than @B@ . For a list of code values, see . For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. * /ComparisonOperator/ - A comparator for evaluating attributes in the /AttributeValueList/ . When performing the comparison, DynamoDB uses strongly consistent reads. The following comparison operators are available: @EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN@ The following are descriptions of each comparison operator. * @EQ@ : Equal. @EQ@ is supported for all datatypes, including lists and maps. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @NE@ : Not equal. @NE@ is supported for all datatypes, including lists and maps. /AttributeValueList/ can contain only one /AttributeValue/ of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an /AttributeValue/ of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @LE@ : Less than or equal. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @LT@ : Less than. /AttributeValueList/ can contain only one /AttributeValue/ of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GE@ : Greater than or equal. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GT@ : Greater than. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @NOT_NULL@ : The attribute exists. @NOT_NULL@ is supported for all datatypes, including lists and maps. * @NULL@ : The attribute does not exist. @NULL@ is supported for all datatypes, including lists and maps. * @CONTAINS@ : Checks for a subsequence, or value in a set. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it finds an exact match with any member of the set. CONTAINS is supported for lists: When evaluating "@a CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @NOT_CONTAINS@ : Checks for absence of a subsequence, or absence of a value in a set. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it /does not/ find an exact match with any member of the set. NOT_CONTAINS is supported for lists: When evaluating "@a NOT CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @BEGINS_WITH@ : Checks for a prefix. /AttributeValueList/ can contain only one /AttributeValue/ of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). * @IN@ : Checks for matching elements within two sets. /AttributeValueList/ can contain one or more /AttributeValue/ elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true. * @BETWEEN@ : Greater than or equal to the first value, and less than or equal to the second value. /AttributeValueList/ must contain two /AttributeValue/ elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not compare to @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ For usage examples of /AttributeValueList/ and /ComparisonOperator/ , see in the /Amazon DynamoDB Developer Guide/ . For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of /AttributeValueList/ and /ComparisonOperator/ : * /Value/ - A value for DynamoDB to compare with an attribute. * /Exists/ - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation: * If /Exists/ is @true@ , DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false. * If /Exists/ is @false@ , DynamoDB assumes that the attribute value does /not/ exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false. Note that the default value for /Exists/ is @true@ . The /Value/ and /Exists/ parameters are incompatible with /AttributeValueList/ and /ComparisonOperator/ . Note that if you use both sets of parameters at once, DynamoDB will return a /ValidationException/ exception. +-- * 'piExpected' - This is a legacy parameter. Use @ConditionExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . -- -- * 'piTableName' - The name of the table to contain the item. -- --- * 'piItem' - A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item. You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. For more information about primary keys, see in the /Amazon DynamoDB Developer Guide/ . Each element in the /Item/ map is an /AttributeValue/ object. +-- * 'piItem' - A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item. You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. For more information about primary keys, see in the /Amazon DynamoDB Developer Guide/ . Each element in the @Item@ map is an @AttributeValue@ object. putItem :: Text -- ^ 'piTableName' -> PutItem putItem pTableName_ = - PutItem' - { _piExpressionAttributeNames = Nothing - , _piReturnValues = Nothing - , _piExpressionAttributeValues = Nothing - , _piReturnConsumedCapacity = Nothing - , _piReturnItemCollectionMetrics = Nothing - , _piConditionExpression = Nothing - , _piConditionalOperator = Nothing - , _piExpected = Nothing - , _piTableName = pTableName_ - , _piItem = mempty - } + PutItem' + { _piExpressionAttributeNames = Nothing + , _piReturnValues = Nothing + , _piExpressionAttributeValues = Nothing + , _piReturnConsumedCapacity = Nothing + , _piReturnItemCollectionMetrics = Nothing + , _piConditionExpression = Nothing + , _piConditionalOperator = Nothing + , _piExpected = Nothing + , _piTableName = pTableName_ + , _piItem = mempty + } --- | 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for /ExpressionAttributeNames/ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . + +-- | 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for @ExpressionAttributeNames@ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . piExpressionAttributeNames :: Lens' PutItem (HashMap Text Text) piExpressionAttributeNames = lens _piExpressionAttributeNames (\ s a -> s{_piExpressionAttributeNames = a}) . _Default . _Map; --- | Use /ReturnValues/ if you want to get the item attributes as they appeared before they were updated with the /PutItem/ request. For /PutItem/ , the valid values are: * @NONE@ - If /ReturnValues/ is not specified, or if its value is @NONE@ , then nothing is returned. (This setting is the default for /ReturnValues/ .) * @ALL_OLD@ - If /PutItem/ overwrote an attribute name-value pair, then the content of the old item is returned. +-- | Use @ReturnValues@ if you want to get the item attributes as they appeared before they were updated with the @PutItem@ request. For @PutItem@ , the valid values are: * @NONE@ - If @ReturnValues@ is not specified, or if its value is @NONE@ , then nothing is returned. (This setting is the default for @ReturnValues@ .) * @ALL_OLD@ - If @PutItem@ overwrote an attribute name-value pair, then the content of the old item is returned. piReturnValues :: Lens' PutItem (Maybe ReturnValue) piReturnValues = lens _piReturnValues (\ s a -> s{_piReturnValues = a}); --- | 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 in the /Amazon DynamoDB Developer Guide/ . +-- | 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 in the /Amazon DynamoDB Developer Guide/ . piExpressionAttributeValues :: Lens' PutItem (HashMap Text AttributeValue) piExpressionAttributeValues = lens _piExpressionAttributeValues (\ s a -> s{_piExpressionAttributeValues = a}) . _Default . _Map; @@ -141,15 +163,15 @@ piReturnItemCollectionMetrics :: Lens' PutItem (Maybe ReturnItemCollectionMetrics) piReturnItemCollectionMetrics = lens _piReturnItemCollectionMetrics (\ s a -> s{_piReturnItemCollectionMetrics = a}); --- | A condition that must be satisfied in order for a conditional /PutItem/ operation to succeed. An expression can contain any of the following: * Functions: @attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size@ These function names are case-sensitive. * Comparison operators: @= | <> | < | > | <= | >= | BETWEEN | IN@ * Logical operators: @AND | OR | NOT@ For more information on condition expressions, see in the /Amazon DynamoDB Developer Guide/ . +-- | A condition that must be satisfied in order for a conditional @PutItem@ operation to succeed. An expression can contain any of the following: * Functions: @attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size@ These function names are case-sensitive. * Comparison operators: @= | <> | < | > | <= | >= | BETWEEN | IN @ * Logical operators: @AND | OR | NOT@ For more information on condition expressions, see in the /Amazon DynamoDB Developer Guide/ . piConditionExpression :: Lens' PutItem (Maybe Text) piConditionExpression = lens _piConditionExpression (\ s a -> s{_piConditionExpression = a}); --- | /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /ConditionExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. A logical operator to apply to the conditions in the /Expected/ map: * @AND@ - If all of the conditions evaluate to true, then the entire map evaluates to true. * @OR@ - If at least one of the conditions evaluate to true, then the entire map evaluates to true. If you omit /ConditionalOperator/ , then @AND@ is the default. The operation will succeed only if the entire map evaluates to true. +-- | This is a legacy parameter. Use @ConditionExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . piConditionalOperator :: Lens' PutItem (Maybe ConditionalOperator) piConditionalOperator = lens _piConditionalOperator (\ s a -> s{_piConditionalOperator = a}); --- | /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /ConditionExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. A map of attribute/condition pairs. /Expected/ provides a conditional block for the /PutItem/ operation. Each element of /Expected/ consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each /Expected/ element, the result of the evaluation is either true or false. If you specify more than one element in the /Expected/ map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the /ConditionalOperator/ parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.) If the /Expected/ map evaluates to true, then the conditional operation succeeds; otherwise, it fails. /Expected/ contains the following: * /AttributeValueList/ - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the /ComparisonOperator/ being used. For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, @a@ is greater than @A@ , and @a@ is greater than @B@ . For a list of code values, see . For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. * /ComparisonOperator/ - A comparator for evaluating attributes in the /AttributeValueList/ . When performing the comparison, DynamoDB uses strongly consistent reads. The following comparison operators are available: @EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN@ The following are descriptions of each comparison operator. * @EQ@ : Equal. @EQ@ is supported for all datatypes, including lists and maps. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @NE@ : Not equal. @NE@ is supported for all datatypes, including lists and maps. /AttributeValueList/ can contain only one /AttributeValue/ of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an /AttributeValue/ of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @LE@ : Less than or equal. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @LT@ : Less than. /AttributeValueList/ can contain only one /AttributeValue/ of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GE@ : Greater than or equal. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GT@ : Greater than. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @NOT_NULL@ : The attribute exists. @NOT_NULL@ is supported for all datatypes, including lists and maps. * @NULL@ : The attribute does not exist. @NULL@ is supported for all datatypes, including lists and maps. * @CONTAINS@ : Checks for a subsequence, or value in a set. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it finds an exact match with any member of the set. CONTAINS is supported for lists: When evaluating "@a CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @NOT_CONTAINS@ : Checks for absence of a subsequence, or absence of a value in a set. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it /does not/ find an exact match with any member of the set. NOT_CONTAINS is supported for lists: When evaluating "@a NOT CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @BEGINS_WITH@ : Checks for a prefix. /AttributeValueList/ can contain only one /AttributeValue/ of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). * @IN@ : Checks for matching elements within two sets. /AttributeValueList/ can contain one or more /AttributeValue/ elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true. * @BETWEEN@ : Greater than or equal to the first value, and less than or equal to the second value. /AttributeValueList/ must contain two /AttributeValue/ elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not compare to @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ For usage examples of /AttributeValueList/ and /ComparisonOperator/ , see in the /Amazon DynamoDB Developer Guide/ . For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of /AttributeValueList/ and /ComparisonOperator/ : * /Value/ - A value for DynamoDB to compare with an attribute. * /Exists/ - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation: * If /Exists/ is @true@ , DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false. * If /Exists/ is @false@ , DynamoDB assumes that the attribute value does /not/ exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false. Note that the default value for /Exists/ is @true@ . The /Value/ and /Exists/ parameters are incompatible with /AttributeValueList/ and /ComparisonOperator/ . Note that if you use both sets of parameters at once, DynamoDB will return a /ValidationException/ exception. +-- | This is a legacy parameter. Use @ConditionExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . piExpected :: Lens' PutItem (HashMap Text ExpectedAttributeValue) piExpected = lens _piExpected (\ s a -> s{_piExpected = a}) . _Default . _Map; @@ -157,7 +179,7 @@ piTableName :: Lens' PutItem Text piTableName = lens _piTableName (\ s a -> s{_piTableName = a}); --- | A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item. You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. For more information about primary keys, see in the /Amazon DynamoDB Developer Guide/ . Each element in the /Item/ map is an /AttributeValue/ object. +-- | A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item. You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. For more information about primary keys, see in the /Amazon DynamoDB Developer Guide/ . Each element in the @Item@ map is an @AttributeValue@ object. piItem :: Lens' PutItem (HashMap Text AttributeValue) piItem = lens _piItem (\ s a -> s{_piItem = a}) . _Map; @@ -173,9 +195,9 @@ <*> (x .?> "Attributes" .!@ mempty) <*> (pure (fromEnum s))) -instance Hashable PutItem +instance Hashable PutItem where -instance NFData PutItem +instance NFData PutItem where instance ToHeaders PutItem where toHeaders @@ -213,49 +235,51 @@ instance ToQuery PutItem where toQuery = const mempty --- | Represents the output of a /PutItem/ operation. +-- | Represents the output of a @PutItem@ operation. -- -- -- -- /See:/ 'putItemResponse' smart constructor. data PutItemResponse = PutItemResponse' - { _pirsItemCollectionMetrics :: !(Maybe ItemCollectionMetrics) - , _pirsConsumedCapacity :: !(Maybe ConsumedCapacity) - , _pirsAttributes :: !(Maybe (Map Text AttributeValue)) - , _pirsResponseStatus :: !Int - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _pirsItemCollectionMetrics :: !(Maybe ItemCollectionMetrics) + , _pirsConsumedCapacity :: !(Maybe ConsumedCapacity) + , _pirsAttributes :: !(Maybe (Map Text AttributeValue)) + , _pirsResponseStatus :: !Int + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'PutItemResponse' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'pirsItemCollectionMetrics' - Information about item collections, if any, that were affected by the operation. /ItemCollectionMetrics/ is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response. Each /ItemCollectionMetrics/ element consists of: * /ItemCollectionKey/ - The partition key value of the item collection. This is the same as the partition key value of the item itself. * /SizeEstimateRange/ - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. +-- * 'pirsItemCollectionMetrics' - Information about item collections, if any, that were affected by the @PutItem@ operation. @ItemCollectionMetrics@ is only returned if the @ReturnItemCollectionMetrics@ parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response. Each @ItemCollectionMetrics@ element consists of: * @ItemCollectionKey@ - The partition key value of the item collection. This is the same as the partition key value of the item itself. * @SizeEstimateRange@ - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. -- --- * 'pirsConsumedCapacity' - Undocumented member. +-- * 'pirsConsumedCapacity' - The capacity units consumed by the @PutItem@ 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 in the /Amazon DynamoDB Developer Guide/ . -- --- * 'pirsAttributes' - The attribute values as they appeared before the /PutItem/ operation, but only if /ReturnValues/ is specified as @ALL_OLD@ in the request. Each element consists of an attribute name and an attribute value. +-- * 'pirsAttributes' - The attribute values as they appeared before the @PutItem@ operation, but only if @ReturnValues@ is specified as @ALL_OLD@ in the request. Each element consists of an attribute name and an attribute value. -- -- * 'pirsResponseStatus' - -- | The response status code. putItemResponse :: Int -- ^ 'pirsResponseStatus' -> PutItemResponse putItemResponse pResponseStatus_ = - PutItemResponse' - { _pirsItemCollectionMetrics = Nothing - , _pirsConsumedCapacity = Nothing - , _pirsAttributes = Nothing - , _pirsResponseStatus = pResponseStatus_ - } + PutItemResponse' + { _pirsItemCollectionMetrics = Nothing + , _pirsConsumedCapacity = Nothing + , _pirsAttributes = Nothing + , _pirsResponseStatus = pResponseStatus_ + } --- | Information about item collections, if any, that were affected by the operation. /ItemCollectionMetrics/ is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response. Each /ItemCollectionMetrics/ element consists of: * /ItemCollectionKey/ - The partition key value of the item collection. This is the same as the partition key value of the item itself. * /SizeEstimateRange/ - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. + +-- | Information about item collections, if any, that were affected by the @PutItem@ operation. @ItemCollectionMetrics@ is only returned if the @ReturnItemCollectionMetrics@ parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response. Each @ItemCollectionMetrics@ element consists of: * @ItemCollectionKey@ - The partition key value of the item collection. This is the same as the partition key value of the item itself. * @SizeEstimateRange@ - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. pirsItemCollectionMetrics :: Lens' PutItemResponse (Maybe ItemCollectionMetrics) pirsItemCollectionMetrics = lens _pirsItemCollectionMetrics (\ s a -> s{_pirsItemCollectionMetrics = a}); --- | Undocumented member. +-- | The capacity units consumed by the @PutItem@ 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 in the /Amazon DynamoDB Developer Guide/ . pirsConsumedCapacity :: Lens' PutItemResponse (Maybe ConsumedCapacity) pirsConsumedCapacity = lens _pirsConsumedCapacity (\ s a -> s{_pirsConsumedCapacity = a}); --- | The attribute values as they appeared before the /PutItem/ operation, but only if /ReturnValues/ is specified as @ALL_OLD@ in the request. Each element consists of an attribute name and an attribute value. +-- | The attribute values as they appeared before the @PutItem@ operation, but only if @ReturnValues@ is specified as @ALL_OLD@ in the request. Each element consists of an attribute name and an attribute value. pirsAttributes :: Lens' PutItemResponse (HashMap Text AttributeValue) pirsAttributes = lens _pirsAttributes (\ s a -> s{_pirsAttributes = a}) . _Default . _Map; @@ -263,4 +287,4 @@ pirsResponseStatus :: Lens' PutItemResponse Int pirsResponseStatus = lens _pirsResponseStatus (\ s a -> s{_pirsResponseStatus = a}); -instance NFData PutItemResponse +instance NFData PutItemResponse where diff --git a/gen/Network/AWS/DynamoDB/Query.hs b/gen/Network/AWS/DynamoDB/Query.hs --- a/gen/Network/AWS/DynamoDB/Query.hs +++ b/gen/Network/AWS/DynamoDB/Query.hs @@ -12,24 +12,28 @@ -- | -- Module : Network.AWS.DynamoDB.Query --- Copyright : (c) 2013-2016 Brendan Hay +-- Copyright : (c) 2013-2017 Brendan Hay -- License : Mozilla Public License, v. 2.0. --- Maintainer : Brendan Hay +-- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- A /Query/ operation uses the primary key of a table or a secondary index to directly access items from that table or index. +-- The @Query@ operation finds items based on primary key values. You can query any table or secondary index that has a composite primary key (a partition key and a sort key). -- -- --- 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/ . You can use the /ScanIndexForward/ parameter to get results in forward or reverse order, by sort key. +-- 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. -- --- Queries that do not return results consume the minimum number of read capacity units for that type of read operation. +-- 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. -- --- If the total number of items meeting the query criteria exceeds the result set size limit of 1 MB, the query stops and results are returned to the user with the /LastEvaluatedKey/ element to continue the query in a subsequent operation. Unlike a /Scan/ operation, a /Query/ operation never returns both an empty result set and a /LastEvaluatedKey/ value. /LastEvaluatedKey/ is only provided if you have used the /Limit/ parameter, or if the result set exceeds 1 MB (prior to applying a filter). +-- @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. -- --- 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. +-- 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 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@ . -- +-- 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 Network.AWS.DynamoDB.Query ( @@ -67,101 +71,103 @@ , qrsResponseStatus ) where -import Network.AWS.DynamoDB.Types -import Network.AWS.DynamoDB.Types.Product -import Network.AWS.Lens -import Network.AWS.Pager -import Network.AWS.Prelude -import Network.AWS.Request -import Network.AWS.Response +import Network.AWS.DynamoDB.Types +import Network.AWS.DynamoDB.Types.Product +import Network.AWS.Lens +import Network.AWS.Pager +import Network.AWS.Prelude +import Network.AWS.Request +import Network.AWS.Response --- | Represents the input of a /Query/ operation. +-- | Represents the input of a @Query@ operation. -- -- -- -- /See:/ 'query' smart constructor. data Query = Query' - { _qKeyConditions :: !(Maybe (Map Text Condition)) - , _qProjectionExpression :: !(Maybe Text) - , _qAttributesToGet :: !(Maybe (List1 Text)) - , _qExpressionAttributeNames :: !(Maybe (Map Text Text)) - , _qFilterExpression :: !(Maybe Text) - , _qQueryFilter :: !(Maybe (Map Text Condition)) - , _qConsistentRead :: !(Maybe Bool) - , _qExpressionAttributeValues :: !(Maybe (Map Text AttributeValue)) - , _qReturnConsumedCapacity :: !(Maybe ReturnConsumedCapacity) - , _qScanIndexForward :: !(Maybe Bool) - , _qLimit :: !(Maybe Nat) - , _qSelect :: !(Maybe Select) - , _qKeyConditionExpression :: !(Maybe Text) - , _qConditionalOperator :: !(Maybe ConditionalOperator) - , _qExclusiveStartKey :: !(Maybe (Map Text AttributeValue)) - , _qIndexName :: !(Maybe Text) - , _qTableName :: !Text - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _qKeyConditions :: !(Maybe (Map Text Condition)) + , _qProjectionExpression :: !(Maybe Text) + , _qAttributesToGet :: !(Maybe (List1 Text)) + , _qExpressionAttributeNames :: !(Maybe (Map Text Text)) + , _qFilterExpression :: !(Maybe Text) + , _qQueryFilter :: !(Maybe (Map Text Condition)) + , _qConsistentRead :: !(Maybe Bool) + , _qExpressionAttributeValues :: !(Maybe (Map Text AttributeValue)) + , _qReturnConsumedCapacity :: !(Maybe ReturnConsumedCapacity) + , _qScanIndexForward :: !(Maybe Bool) + , _qLimit :: !(Maybe Nat) + , _qSelect :: !(Maybe Select) + , _qKeyConditionExpression :: !(Maybe Text) + , _qConditionalOperator :: !(Maybe ConditionalOperator) + , _qExclusiveStartKey :: !(Maybe (Map Text AttributeValue)) + , _qIndexName :: !(Maybe Text) + , _qTableName :: !Text + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'Query' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'qKeyConditions' - /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /KeyConditionExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. The selection criteria for the query. For a query on a table, you can have conditions only on the table primary key attributes. You must provide the partition key name and value as an @EQ@ condition. You can optionally provide a second condition, referring to the sort key. For a query on an index, you can have conditions only on the index key attributes. You must provide the index partition key name and value as an @EQ@ condition. You can optionally provide a second condition, referring to the index sort key. Each /KeyConditions/ element consists of an attribute name to compare, along with the following: * /AttributeValueList/ - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the /ComparisonOperator/ being used. For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, @a@ is greater than @A@ , and @a@ is greater than @B@ . For a list of code values, see . For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. * /ComparisonOperator/ - A comparator for evaluating attributes, for example, equals, greater than, less than, and so on. For /KeyConditions/ , only the following comparison operators are supported: @EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN@ The following are descriptions of these comparison operators. * @EQ@ : Equal. /AttributeValueList/ can contain only one /AttributeValue/ of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one specified in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @LE@ : Less than or equal. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @LT@ : Less than. /AttributeValueList/ can contain only one /AttributeValue/ of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GE@ : Greater than or equal. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GT@ : Greater than. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @BEGINS_WITH@ : Checks for a prefix. /AttributeValueList/ can contain only one /AttributeValue/ of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). * @BETWEEN@ : Greater than or equal to the first value, and less than or equal to the second value. /AttributeValueList/ must contain two /AttributeValue/ elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not compare to @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ For usage examples of /AttributeValueList/ and /ComparisonOperator/ , see in the /Amazon DynamoDB Developer Guide/ . +-- * 'qKeyConditions' - This is a legacy parameter. Use @KeyConditionExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . -- -- * 'qProjectionExpression' - 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 in the /Amazon DynamoDB Developer Guide/ . -- --- * 'qAttributesToGet' - /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /ProjectionExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map. The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. Note that /AttributesToGet/ has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application. You cannot use both /AttributesToGet/ and /Select/ together in a /Query/ request, /unless/ the value for /Select/ is @SPECIFIC_ATTRIBUTES@ . (This usage is equivalent to specifying /AttributesToGet/ without any value for /Select/ .) If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency. If you query 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. +-- * 'qAttributesToGet' - This is a legacy parameter. Use @ProjectionExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . -- --- * 'qExpressionAttributeNames' - 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for /ExpressionAttributeNames/ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . +-- * 'qExpressionAttributeNames' - 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for @ExpressionAttributeNames@ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . -- --- * 'qFilterExpression' - 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. For more information, see in the /Amazon DynamoDB Developer Guide/ . +-- * 'qFilterExpression' - 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. For more information, see in the /Amazon DynamoDB Developer Guide/ . -- --- * 'qQueryFilter' - /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /FilterExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. A condition that evaluates the query results after the items are read and returns only the desired values. This parameter does not support attributes of type List or Map. If you provide more than one condition in the /QueryFilter/ map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the /ConditionalOperator/ parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.) Note that /QueryFilter/ does not allow key attributes. You cannot define a filter condition on a partition key or a sort key. Each /QueryFilter/ element consists of an attribute name to compare, along with the following: * /AttributeValueList/ - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in /ComparisonOperator/ . For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, @a@ is greater than @A@ , and @a@ is greater than @B@ . For a list of code values, see . For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. For information on specifying data types in JSON, see in the /Amazon DynamoDB Developer Guide/ . * /ComparisonOperator/ - A comparator for evaluating attributes. For example, equals, greater than, less than, etc. The following comparison operators are available: @EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN@ For complete descriptions of all comparison operators, see the data type. +-- * 'qQueryFilter' - This is a legacy parameter. Use @FilterExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . -- --- * 'qConsistentRead' - 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/ . +-- * 'qConsistentRead' - 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@ . -- --- * 'qExpressionAttributeValues' - 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 in the /Amazon DynamoDB Developer Guide/ . +-- * 'qExpressionAttributeValues' - 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 in the /Amazon DynamoDB Developer Guide/ . -- -- * 'qReturnConsumedCapacity' - Undocumented member. -- --- * 'qScanIndexForward' - 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 ASCII character code values. 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. +-- * 'qScanIndexForward' - 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 ASCII character code values. 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. -- --- * 'qLimit' - The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in /LastEvaluatedKey/ to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in /LastEvaluatedKey/ to apply in a subsequent operation to continue the operation. For more information, see in the /Amazon DynamoDB Developer Guide/ . +-- * 'qLimit' - The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in @LastEvaluatedKey@ to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in @LastEvaluatedKey@ to apply in a subsequent operation to continue the operation. For more information, see in the /Amazon DynamoDB Developer Guide/ . -- --- * 'qSelect' - The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index. * @ALL_ATTRIBUTES@ - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required. * @ALL_PROJECTED_ATTRIBUTES@ - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying @ALL_ATTRIBUTES@ . * @COUNT@ - Returns the number of matching items, rather than the matching items themselves. * @SPECIFIC_ATTRIBUTES@ - Returns only the attributes listed in /AttributesToGet/ . This return value is equivalent to specifying /AttributesToGet/ without specifying any value for /Select/ . If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency. If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table. If neither /Select/ nor /AttributesToGet/ are specified, DynamoDB defaults to @ALL_ATTRIBUTES@ when accessing a table, and @ALL_PROJECTED_ATTRIBUTES@ when accessing an index. You cannot use both /Select/ and /AttributesToGet/ together in a single request, unless the value for /Select/ is @SPECIFIC_ATTRIBUTES@ . (This usage is equivalent to specifying /AttributesToGet/ without any value for /Select/ .) +-- * 'qSelect' - The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index. * @ALL_ATTRIBUTES@ - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required. * @ALL_PROJECTED_ATTRIBUTES@ - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying @ALL_ATTRIBUTES@ . * @COUNT@ - Returns the number of matching items, rather than the matching items themselves. * @SPECIFIC_ATTRIBUTES@ - Returns only the attributes listed in @AttributesToGet@ . This return value is equivalent to specifying @AttributesToGet@ without specifying any value for @Select@ . If you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency. If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table. If neither @Select@ nor @AttributesToGet@ are specified, DynamoDB defaults to @ALL_ATTRIBUTES@ when accessing a table, and @ALL_PROJECTED_ATTRIBUTES@ when accessing an index. You cannot use both @Select@ and @AttributesToGet@ together in a single request, unless the value for @Select@ is @SPECIFIC_ATTRIBUTES@ . (This usage is equivalent to specifying @AttributesToGet@ without any value for @Select@ .) -- --- * 'qKeyConditionExpression' - The condition that specifies the key value(s) 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 also perform one of several comparison tests on a single sort key value. /Query/ can use /KeyConditionExpression/ 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 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 in the /Amazon DynamoDB Developer Guide/ . For more information on /ExpressionAttributeNames/ and /ExpressionAttributeValues/ , see in the /Amazon DynamoDB Developer Guide/ . +-- * 'qKeyConditionExpression' - The condition that specifies the key value(s) 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 also perform one of several comparison tests on a single sort key value. @Query@ can use @KeyConditionExpression@ 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 in the /Amazon DynamoDB Developer Guide/ . For more information on @ExpressionAttributeNames@ and @ExpressionAttributeValues@ , see in the /Amazon DynamoDB Developer Guide/ . -- --- * 'qConditionalOperator' - /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /FilterExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. A logical operator to apply to the conditions in a /QueryFilter/ map: * @AND@ - If all of the conditions evaluate to true, then the entire map evaluates to true. * @OR@ - If at least one of the conditions evaluate to true, then the entire map evaluates to true. If you omit /ConditionalOperator/ , then @AND@ is the default. The operation will succeed only if the entire map evaluates to true. +-- * 'qConditionalOperator' - This is a legacy parameter. Use @FilterExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . -- --- * 'qExclusiveStartKey' - 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. +-- * 'qExclusiveStartKey' - 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. -- --- * 'qIndexName' - 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./ +-- * 'qIndexName' - 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.@ -- -- * 'qTableName' - The name of the table containing the requested items. query :: Text -- ^ 'qTableName' -> Query query pTableName_ = - Query' - { _qKeyConditions = Nothing - , _qProjectionExpression = Nothing - , _qAttributesToGet = Nothing - , _qExpressionAttributeNames = Nothing - , _qFilterExpression = Nothing - , _qQueryFilter = Nothing - , _qConsistentRead = Nothing - , _qExpressionAttributeValues = Nothing - , _qReturnConsumedCapacity = Nothing - , _qScanIndexForward = Nothing - , _qLimit = Nothing - , _qSelect = Nothing - , _qKeyConditionExpression = Nothing - , _qConditionalOperator = Nothing - , _qExclusiveStartKey = Nothing - , _qIndexName = Nothing - , _qTableName = pTableName_ - } + Query' + { _qKeyConditions = Nothing + , _qProjectionExpression = Nothing + , _qAttributesToGet = Nothing + , _qExpressionAttributeNames = Nothing + , _qFilterExpression = Nothing + , _qQueryFilter = Nothing + , _qConsistentRead = Nothing + , _qExpressionAttributeValues = Nothing + , _qReturnConsumedCapacity = Nothing + , _qScanIndexForward = Nothing + , _qLimit = Nothing + , _qSelect = Nothing + , _qKeyConditionExpression = Nothing + , _qConditionalOperator = Nothing + , _qExclusiveStartKey = Nothing + , _qIndexName = Nothing + , _qTableName = pTableName_ + } --- | /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /KeyConditionExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. The selection criteria for the query. For a query on a table, you can have conditions only on the table primary key attributes. You must provide the partition key name and value as an @EQ@ condition. You can optionally provide a second condition, referring to the sort key. For a query on an index, you can have conditions only on the index key attributes. You must provide the index partition key name and value as an @EQ@ condition. You can optionally provide a second condition, referring to the index sort key. Each /KeyConditions/ element consists of an attribute name to compare, along with the following: * /AttributeValueList/ - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the /ComparisonOperator/ being used. For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, @a@ is greater than @A@ , and @a@ is greater than @B@ . For a list of code values, see . For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. * /ComparisonOperator/ - A comparator for evaluating attributes, for example, equals, greater than, less than, and so on. For /KeyConditions/ , only the following comparison operators are supported: @EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN@ The following are descriptions of these comparison operators. * @EQ@ : Equal. /AttributeValueList/ can contain only one /AttributeValue/ of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one specified in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @LE@ : Less than or equal. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @LT@ : Less than. /AttributeValueList/ can contain only one /AttributeValue/ of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GE@ : Greater than or equal. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GT@ : Greater than. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @BEGINS_WITH@ : Checks for a prefix. /AttributeValueList/ can contain only one /AttributeValue/ of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). * @BETWEEN@ : Greater than or equal to the first value, and less than or equal to the second value. /AttributeValueList/ must contain two /AttributeValue/ elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not compare to @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ For usage examples of /AttributeValueList/ and /ComparisonOperator/ , see in the /Amazon DynamoDB Developer Guide/ . + +-- | This is a legacy parameter. Use @KeyConditionExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . qKeyConditions :: Lens' Query (HashMap Text Condition) qKeyConditions = lens _qKeyConditions (\ s a -> s{_qKeyConditions = a}) . _Default . _Map; @@ -169,27 +175,27 @@ qProjectionExpression :: Lens' Query (Maybe Text) qProjectionExpression = lens _qProjectionExpression (\ s a -> s{_qProjectionExpression = a}); --- | /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /ProjectionExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map. The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. Note that /AttributesToGet/ has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application. You cannot use both /AttributesToGet/ and /Select/ together in a /Query/ request, /unless/ the value for /Select/ is @SPECIFIC_ATTRIBUTES@ . (This usage is equivalent to specifying /AttributesToGet/ without any value for /Select/ .) If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency. If you query 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. +-- | This is a legacy parameter. Use @ProjectionExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . qAttributesToGet :: Lens' Query (Maybe (NonEmpty Text)) qAttributesToGet = lens _qAttributesToGet (\ s a -> s{_qAttributesToGet = a}) . mapping _List1; --- | 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for /ExpressionAttributeNames/ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . +-- | 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for @ExpressionAttributeNames@ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . qExpressionAttributeNames :: Lens' Query (HashMap Text Text) qExpressionAttributeNames = lens _qExpressionAttributeNames (\ s a -> s{_qExpressionAttributeNames = a}) . _Default . _Map; --- | 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. For more information, see in the /Amazon DynamoDB Developer Guide/ . +-- | 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. For more information, see in the /Amazon DynamoDB Developer Guide/ . qFilterExpression :: Lens' Query (Maybe Text) qFilterExpression = lens _qFilterExpression (\ s a -> s{_qFilterExpression = a}); --- | /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /FilterExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. A condition that evaluates the query results after the items are read and returns only the desired values. This parameter does not support attributes of type List or Map. If you provide more than one condition in the /QueryFilter/ map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the /ConditionalOperator/ parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.) Note that /QueryFilter/ does not allow key attributes. You cannot define a filter condition on a partition key or a sort key. Each /QueryFilter/ element consists of an attribute name to compare, along with the following: * /AttributeValueList/ - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in /ComparisonOperator/ . For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, @a@ is greater than @A@ , and @a@ is greater than @B@ . For a list of code values, see . For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. For information on specifying data types in JSON, see in the /Amazon DynamoDB Developer Guide/ . * /ComparisonOperator/ - A comparator for evaluating attributes. For example, equals, greater than, less than, etc. The following comparison operators are available: @EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN@ For complete descriptions of all comparison operators, see the data type. +-- | This is a legacy parameter. Use @FilterExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . qQueryFilter :: Lens' Query (HashMap Text Condition) qQueryFilter = lens _qQueryFilter (\ s a -> s{_qQueryFilter = a}) . _Default . _Map; --- | 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/ . +-- | 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@ . qConsistentRead :: Lens' Query (Maybe Bool) qConsistentRead = lens _qConsistentRead (\ s a -> s{_qConsistentRead = a}); --- | 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 in the /Amazon DynamoDB Developer Guide/ . +-- | 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 in the /Amazon DynamoDB Developer Guide/ . qExpressionAttributeValues :: Lens' Query (HashMap Text AttributeValue) qExpressionAttributeValues = lens _qExpressionAttributeValues (\ s a -> s{_qExpressionAttributeValues = a}) . _Default . _Map; @@ -197,31 +203,31 @@ qReturnConsumedCapacity :: Lens' Query (Maybe ReturnConsumedCapacity) qReturnConsumedCapacity = lens _qReturnConsumedCapacity (\ s a -> s{_qReturnConsumedCapacity = a}); --- | 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 ASCII character code values. 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. +-- | 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 ASCII character code values. 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. qScanIndexForward :: Lens' Query (Maybe Bool) qScanIndexForward = lens _qScanIndexForward (\ s a -> s{_qScanIndexForward = a}); --- | The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in /LastEvaluatedKey/ to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in /LastEvaluatedKey/ to apply in a subsequent operation to continue the operation. For more information, see in the /Amazon DynamoDB Developer Guide/ . +-- | The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in @LastEvaluatedKey@ to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in @LastEvaluatedKey@ to apply in a subsequent operation to continue the operation. For more information, see in the /Amazon DynamoDB Developer Guide/ . qLimit :: Lens' Query (Maybe Natural) qLimit = lens _qLimit (\ s a -> s{_qLimit = a}) . mapping _Nat; --- | The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index. * @ALL_ATTRIBUTES@ - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required. * @ALL_PROJECTED_ATTRIBUTES@ - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying @ALL_ATTRIBUTES@ . * @COUNT@ - Returns the number of matching items, rather than the matching items themselves. * @SPECIFIC_ATTRIBUTES@ - Returns only the attributes listed in /AttributesToGet/ . This return value is equivalent to specifying /AttributesToGet/ without specifying any value for /Select/ . If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency. If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table. If neither /Select/ nor /AttributesToGet/ are specified, DynamoDB defaults to @ALL_ATTRIBUTES@ when accessing a table, and @ALL_PROJECTED_ATTRIBUTES@ when accessing an index. You cannot use both /Select/ and /AttributesToGet/ together in a single request, unless the value for /Select/ is @SPECIFIC_ATTRIBUTES@ . (This usage is equivalent to specifying /AttributesToGet/ without any value for /Select/ .) +-- | The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index. * @ALL_ATTRIBUTES@ - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required. * @ALL_PROJECTED_ATTRIBUTES@ - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying @ALL_ATTRIBUTES@ . * @COUNT@ - Returns the number of matching items, rather than the matching items themselves. * @SPECIFIC_ATTRIBUTES@ - Returns only the attributes listed in @AttributesToGet@ . This return value is equivalent to specifying @AttributesToGet@ without specifying any value for @Select@ . If you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency. If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table. If neither @Select@ nor @AttributesToGet@ are specified, DynamoDB defaults to @ALL_ATTRIBUTES@ when accessing a table, and @ALL_PROJECTED_ATTRIBUTES@ when accessing an index. You cannot use both @Select@ and @AttributesToGet@ together in a single request, unless the value for @Select@ is @SPECIFIC_ATTRIBUTES@ . (This usage is equivalent to specifying @AttributesToGet@ without any value for @Select@ .) qSelect :: Lens' Query (Maybe Select) qSelect = lens _qSelect (\ s a -> s{_qSelect = a}); --- | The condition that specifies the key value(s) 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 also perform one of several comparison tests on a single sort key value. /Query/ can use /KeyConditionExpression/ 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 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 in the /Amazon DynamoDB Developer Guide/ . For more information on /ExpressionAttributeNames/ and /ExpressionAttributeValues/ , see in the /Amazon DynamoDB Developer Guide/ . +-- | The condition that specifies the key value(s) 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 also perform one of several comparison tests on a single sort key value. @Query@ can use @KeyConditionExpression@ 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 in the /Amazon DynamoDB Developer Guide/ . For more information on @ExpressionAttributeNames@ and @ExpressionAttributeValues@ , see in the /Amazon DynamoDB Developer Guide/ . qKeyConditionExpression :: Lens' Query (Maybe Text) qKeyConditionExpression = lens _qKeyConditionExpression (\ s a -> s{_qKeyConditionExpression = a}); --- | /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /FilterExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. A logical operator to apply to the conditions in a /QueryFilter/ map: * @AND@ - If all of the conditions evaluate to true, then the entire map evaluates to true. * @OR@ - If at least one of the conditions evaluate to true, then the entire map evaluates to true. If you omit /ConditionalOperator/ , then @AND@ is the default. The operation will succeed only if the entire map evaluates to true. +-- | This is a legacy parameter. Use @FilterExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . qConditionalOperator :: Lens' Query (Maybe ConditionalOperator) qConditionalOperator = lens _qConditionalOperator (\ s a -> s{_qConditionalOperator = a}); --- | 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. +-- | 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. qExclusiveStartKey :: Lens' Query (HashMap Text AttributeValue) qExclusiveStartKey = lens _qExclusiveStartKey (\ s a -> s{_qExclusiveStartKey = a}) . _Default . _Map; --- | 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./ +-- | 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.@ qIndexName :: Lens' Query (Maybe Text) qIndexName = lens _qIndexName (\ s a -> s{_qIndexName = a}); @@ -232,9 +238,6 @@ instance AWSPager Query where page rq rs | stop (rs ^. qrsLastEvaluatedKey) = Nothing - | stop (rs ^. qrsItems) = Nothing - | stop (rs ^. qrsCount) = Nothing - | stop (rs ^. qrsScannedCount) = Nothing | otherwise = Just $ rq & qExclusiveStartKey .~ rs ^. qrsLastEvaluatedKey @@ -253,9 +256,9 @@ <*> (x .?> "ConsumedCapacity") <*> (pure (fromEnum s))) -instance Hashable Query +instance Hashable Query where -instance NFData Query +instance NFData Query where instance ToHeaders Query where toHeaders @@ -298,57 +301,59 @@ instance ToQuery Query where toQuery = const mempty --- | Represents the output of a /Query/ operation. +-- | Represents the output of a @Query@ operation. -- -- -- -- /See:/ 'queryResponse' smart constructor. data QueryResponse = QueryResponse' - { _qrsLastEvaluatedKey :: !(Maybe (Map Text AttributeValue)) - , _qrsCount :: !(Maybe Int) - , _qrsScannedCount :: !(Maybe Int) - , _qrsItems :: !(Maybe [Map Text AttributeValue]) - , _qrsConsumedCapacity :: !(Maybe ConsumedCapacity) - , _qrsResponseStatus :: !Int - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _qrsLastEvaluatedKey :: !(Maybe (Map Text AttributeValue)) + , _qrsCount :: !(Maybe Int) + , _qrsScannedCount :: !(Maybe Int) + , _qrsItems :: !(Maybe [Map Text AttributeValue]) + , _qrsConsumedCapacity :: !(Maybe ConsumedCapacity) + , _qrsResponseStatus :: !Int + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'QueryResponse' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'qrsLastEvaluatedKey' - 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. +-- * 'qrsLastEvaluatedKey' - 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. -- --- * 'qrsCount' - 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. +-- * 'qrsCount' - 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. -- --- * 'qrsScannedCount' - 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 in the /Amazon DynamoDB Developer Guide/ . If you did not use a filter in the request, then /ScannedCount/ is the same as /Count/ . +-- * 'qrsScannedCount' - 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 in the /Amazon DynamoDB Developer Guide/ . If you did not use a filter in the request, then @ScannedCount@ is the same as @Count@ . -- -- * 'qrsItems' - 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. -- --- * 'qrsConsumedCapacity' - Undocumented member. +-- * 'qrsConsumedCapacity' - 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 in the /Amazon DynamoDB Developer Guide/ . -- -- * 'qrsResponseStatus' - -- | The response status code. queryResponse :: Int -- ^ 'qrsResponseStatus' -> QueryResponse queryResponse pResponseStatus_ = - QueryResponse' - { _qrsLastEvaluatedKey = Nothing - , _qrsCount = Nothing - , _qrsScannedCount = Nothing - , _qrsItems = Nothing - , _qrsConsumedCapacity = Nothing - , _qrsResponseStatus = pResponseStatus_ - } + QueryResponse' + { _qrsLastEvaluatedKey = Nothing + , _qrsCount = Nothing + , _qrsScannedCount = Nothing + , _qrsItems = Nothing + , _qrsConsumedCapacity = Nothing + , _qrsResponseStatus = pResponseStatus_ + } --- | 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. + +-- | 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. qrsLastEvaluatedKey :: Lens' QueryResponse (HashMap Text AttributeValue) qrsLastEvaluatedKey = lens _qrsLastEvaluatedKey (\ s a -> s{_qrsLastEvaluatedKey = a}) . _Default . _Map; --- | 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. +-- | 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. qrsCount :: Lens' QueryResponse (Maybe Int) qrsCount = lens _qrsCount (\ s a -> s{_qrsCount = a}); --- | 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 in the /Amazon DynamoDB Developer Guide/ . If you did not use a filter in the request, then /ScannedCount/ is the same as /Count/ . +-- | 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 in the /Amazon DynamoDB Developer Guide/ . If you did not use a filter in the request, then @ScannedCount@ is the same as @Count@ . qrsScannedCount :: Lens' QueryResponse (Maybe Int) qrsScannedCount = lens _qrsScannedCount (\ s a -> s{_qrsScannedCount = a}); @@ -356,7 +361,7 @@ qrsItems :: Lens' QueryResponse [HashMap Text AttributeValue] qrsItems = lens _qrsItems (\ s a -> s{_qrsItems = a}) . _Default . _Coerce; --- | Undocumented member. +-- | 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 in the /Amazon DynamoDB Developer Guide/ . qrsConsumedCapacity :: Lens' QueryResponse (Maybe ConsumedCapacity) qrsConsumedCapacity = lens _qrsConsumedCapacity (\ s a -> s{_qrsConsumedCapacity = a}); @@ -364,4 +369,4 @@ qrsResponseStatus :: Lens' QueryResponse Int qrsResponseStatus = lens _qrsResponseStatus (\ s a -> s{_qrsResponseStatus = a}); -instance NFData QueryResponse +instance NFData QueryResponse where diff --git a/gen/Network/AWS/DynamoDB/Scan.hs b/gen/Network/AWS/DynamoDB/Scan.hs --- a/gen/Network/AWS/DynamoDB/Scan.hs +++ b/gen/Network/AWS/DynamoDB/Scan.hs @@ -12,22 +12,24 @@ -- | -- Module : Network.AWS.DynamoDB.Scan --- Copyright : (c) 2013-2016 Brendan Hay +-- Copyright : (c) 2013-2017 Brendan Hay -- License : Mozilla Public License, v. 2.0. --- Maintainer : Brendan Hay +-- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- The /Scan/ operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a /ScanFilter/ operation. +-- The @Scan@ operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a @FilterExpression@ operation. -- -- --- If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a /LastEvaluatedKey/ value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria. +-- If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a @LastEvaluatedKey@ value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria. -- --- By default, /Scan/ operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel /Scan/ operation by providing the /Segment/ and /TotalSegments/ parameters. For more information, see in the /Amazon DynamoDB Developer Guide/ . +-- A single @Scan@ operation will read up to the maximum number of items set (if using the @Limit@ parameter) or a maximum of 1 MB of data and then apply any filtering to the results using @FilterExpression@ . If @LastEvaluatedKey@ is present in the response, you will need to paginate the result set. For more information, see in the /Amazon DynamoDB Developer Guide/ . -- --- By default, /Scan/ uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the /ConsistentRead/ parameter to /true/ . +-- @Scan@ operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel @Scan@ operation by providing the @Segment@ and @TotalSegments@ parameters. For more information, see in the /Amazon DynamoDB Developer Guide/ . -- +-- @Scan@ uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the @Scan@ begins, you can set the @ConsistentRead@ parameter to @true@ . -- +-- -- This operation returns paginated results. module Network.AWS.DynamoDB.Scan ( @@ -64,69 +66,70 @@ , srsResponseStatus ) where -import Network.AWS.DynamoDB.Types -import Network.AWS.DynamoDB.Types.Product -import Network.AWS.Lens -import Network.AWS.Pager -import Network.AWS.Prelude -import Network.AWS.Request -import Network.AWS.Response +import Network.AWS.DynamoDB.Types +import Network.AWS.DynamoDB.Types.Product +import Network.AWS.Lens +import Network.AWS.Pager +import Network.AWS.Prelude +import Network.AWS.Request +import Network.AWS.Response --- | Represents the input of a /Scan/ operation. +-- | Represents the input of a @Scan@ operation. -- -- -- -- /See:/ 'scan' smart constructor. data Scan = Scan' - { _sProjectionExpression :: !(Maybe Text) - , _sScanFilter :: !(Maybe (Map Text Condition)) - , _sAttributesToGet :: !(Maybe (List1 Text)) - , _sTotalSegments :: !(Maybe Nat) - , _sExpressionAttributeNames :: !(Maybe (Map Text Text)) - , _sFilterExpression :: !(Maybe Text) - , _sConsistentRead :: !(Maybe Bool) - , _sExpressionAttributeValues :: !(Maybe (Map Text AttributeValue)) - , _sReturnConsumedCapacity :: !(Maybe ReturnConsumedCapacity) - , _sLimit :: !(Maybe Nat) - , _sSelect :: !(Maybe Select) - , _sSegment :: !(Maybe Nat) - , _sConditionalOperator :: !(Maybe ConditionalOperator) - , _sExclusiveStartKey :: !(Maybe (Map Text AttributeValue)) - , _sIndexName :: !(Maybe Text) - , _sTableName :: !Text - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _sProjectionExpression :: !(Maybe Text) + , _sScanFilter :: !(Maybe (Map Text Condition)) + , _sAttributesToGet :: !(Maybe (List1 Text)) + , _sTotalSegments :: !(Maybe Nat) + , _sExpressionAttributeNames :: !(Maybe (Map Text Text)) + , _sFilterExpression :: !(Maybe Text) + , _sConsistentRead :: !(Maybe Bool) + , _sExpressionAttributeValues :: !(Maybe (Map Text AttributeValue)) + , _sReturnConsumedCapacity :: !(Maybe ReturnConsumedCapacity) + , _sLimit :: !(Maybe Nat) + , _sSelect :: !(Maybe Select) + , _sSegment :: !(Maybe Nat) + , _sConditionalOperator :: !(Maybe ConditionalOperator) + , _sExclusiveStartKey :: !(Maybe (Map Text AttributeValue)) + , _sIndexName :: !(Maybe Text) + , _sTableName :: !Text + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'Scan' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- * 'sProjectionExpression' - A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see in the /Amazon DynamoDB Developer Guide/ . -- --- * 'sScanFilter' - /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /FilterExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. A condition that evaluates the scan results and returns only the desired values. If you specify more than one condition in the /ScanFilter/ map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the /ConditionalOperator/ parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.) Each /ScanFilter/ element consists of an attribute name to compare, along with the following: * /AttributeValueList/ - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in /ComparisonOperator/ . For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, @a@ is greater than @A@ , and @a@ is greater than @B@ . For a list of code values, see . For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. For information on specifying data types in JSON, see in the /Amazon DynamoDB Developer Guide/ . * /ComparisonOperator/ - A comparator for evaluating attributes. For example, equals, greater than, less than, etc. The following comparison operators are available: @EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN@ For complete descriptions of all comparison operators, see . +-- * 'sScanFilter' - This is a legacy parameter. Use @FilterExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . -- --- * 'sAttributesToGet' - /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /ProjectionExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map. The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. Note that /AttributesToGet/ has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application. +-- * 'sAttributesToGet' - This is a legacy parameter. Use @ProjectionExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . -- --- * 'sTotalSegments' - For a parallel /Scan/ request, /TotalSegments/ represents the total number of segments into which the /Scan/ operation will be divided. The value of /TotalSegments/ corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a /TotalSegments/ value of 4. The value for /TotalSegments/ must be greater than or equal to 1, and less than or equal to 1000000. If you specify a /TotalSegments/ value of 1, the /Scan/ operation will be sequential rather than parallel. If you specify /TotalSegments/ , you must also specify /Segment/ . +-- * 'sTotalSegments' - For a parallel @Scan@ request, @TotalSegments@ represents the total number of segments into which the @Scan@ operation will be divided. The value of @TotalSegments@ corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a @TotalSegments@ value of 4. The value for @TotalSegments@ must be greater than or equal to 1, and less than or equal to 1000000. If you specify a @TotalSegments@ value of 1, the @Scan@ operation will be sequential rather than parallel. If you specify @TotalSegments@ , you must also specify @Segment@ . -- --- * 'sExpressionAttributeNames' - One or more substitution tokens for attribute names in an expression. The following are some use cases for using /ExpressionAttributeNames/ : * To access an attribute whose name conflicts with a DynamoDB reserved word. * To create a placeholder for repeating occurrences of an attribute name in an expression. * To prevent special characters in an attribute name from being misinterpreted in an expression. Use the __#__ character in an expression to dereference an attribute name. For example, consider the following attribute name: * @Percentile@ The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for /ExpressionAttributeNames/ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . +-- * 'sExpressionAttributeNames' - One or more substitution tokens for attribute names in an expression. The following are some use cases for using @ExpressionAttributeNames@ : * To access an attribute whose name conflicts with a DynamoDB reserved word. * To create a placeholder for repeating occurrences of an attribute name in an expression. * To prevent special characters in an attribute name from being misinterpreted in an expression. Use the __#__ character in an expression to dereference an attribute name. For example, consider the following attribute name: * @Percentile@ The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for @ExpressionAttributeNames@ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . -- --- * 'sFilterExpression' - A string that contains conditions that DynamoDB applies after the /Scan/ operation, but before the data is returned to you. Items that do not satisfy the /FilterExpression/ criteria are not returned. For more information, see in the /Amazon DynamoDB Developer Guide/ . +-- * 'sFilterExpression' - A string that contains conditions that DynamoDB applies after the @Scan@ operation, but before the data is returned to you. Items that do not satisfy the @FilterExpression@ criteria are not returned. For more information, see in the /Amazon DynamoDB Developer Guide/ . -- --- * 'sConsistentRead' - A Boolean value that determines the read consistency model during the scan: * If /ConsistentRead/ is @false@ , then the data returned from /Scan/ might not contain the results from other recently completed write operations (PutItem, UpdateItem or DeleteItem). * If /ConsistentRead/ is @true@ , then all of the write operations that completed before the /Scan/ began are guaranteed to be contained in the /Scan/ response. The default setting for /ConsistentRead/ is @false@ . The /ConsistentRead/ parameter is not supported on global secondary indexes. If you scan a global secondary index with /ConsistentRead/ set to true, you will receive a /ValidationException/ . +-- * 'sConsistentRead' - A Boolean value that determines the read consistency model during the scan: * If @ConsistentRead@ is @false@ , then the data returned from @Scan@ might not contain the results from other recently completed write operations (PutItem, UpdateItem or DeleteItem). * If @ConsistentRead@ is @true@ , then all of the write operations that completed before the @Scan@ began are guaranteed to be contained in the @Scan@ response. The default setting for @ConsistentRead@ is @false@ . The @ConsistentRead@ parameter is not supported on global secondary indexes. If you scan a global secondary index with @ConsistentRead@ set to true, you will receive a @ValidationException@ . -- --- * 'sExpressionAttributeValues' - One or more values that can be substituted in an expression. Use the __:__ (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the /ProductStatus/ attribute was one of the following: @Available | Backordered | Discontinued@ You would first need to specify /ExpressionAttributeValues/ as follows: @{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }@ You could then use these values in an expression, such as this: @ProductStatus IN (:avail, :back, :disc)@ For more information on expression attribute values, see in the /Amazon DynamoDB Developer Guide/ . +-- * 'sExpressionAttributeValues' - One or more values that can be substituted in an expression. Use the __:__ (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the /ProductStatus/ attribute was one of the following: @Available | Backordered | Discontinued@ You would first need to specify @ExpressionAttributeValues@ as follows: @{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }@ You could then use these values in an expression, such as this: @ProductStatus IN (:avail, :back, :disc)@ For more information on expression attribute values, see in the /Amazon DynamoDB Developer Guide/ . -- -- * 'sReturnConsumedCapacity' - Undocumented member. -- --- * 'sLimit' - The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in /LastEvaluatedKey/ to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in /LastEvaluatedKey/ to apply in a subsequent operation to continue the operation. For more information, see in the /Amazon DynamoDB Developer Guide/ . +-- * 'sLimit' - The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in @LastEvaluatedKey@ to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in @LastEvaluatedKey@ to apply in a subsequent operation to continue the operation. For more information, see in the /Amazon DynamoDB Developer Guide/ . -- --- * 'sSelect' - The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, or the count of matching items. * @ALL_ATTRIBUTES@ - Returns all of the item attributes. * @ALL_PROJECTED_ATTRIBUTES@ - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying @ALL_ATTRIBUTES@ . * @COUNT@ - Returns the number of matching items, rather than the matching items themselves. * @SPECIFIC_ATTRIBUTES@ - Returns only the attributes listed in /AttributesToGet/ . This return value is equivalent to specifying /AttributesToGet/ without specifying any value for /Select/ . If neither /Select/ nor /AttributesToGet/ are specified, DynamoDB defaults to @ALL_ATTRIBUTES@ . You cannot use both /AttributesToGet/ and /Select/ together in a single request, unless the value for /Select/ is @SPECIFIC_ATTRIBUTES@ . (This usage is equivalent to specifying /AttributesToGet/ without any value for /Select/ .) +-- * 'sSelect' - The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index. * @ALL_ATTRIBUTES@ - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required. * @ALL_PROJECTED_ATTRIBUTES@ - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying @ALL_ATTRIBUTES@ . * @COUNT@ - Returns the number of matching items, rather than the matching items themselves. * @SPECIFIC_ATTRIBUTES@ - Returns only the attributes listed in @AttributesToGet@ . This return value is equivalent to specifying @AttributesToGet@ without specifying any value for @Select@ . If you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency. If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table. If neither @Select@ nor @AttributesToGet@ are specified, DynamoDB defaults to @ALL_ATTRIBUTES@ when accessing a table, and @ALL_PROJECTED_ATTRIBUTES@ when accessing an index. You cannot use both @Select@ and @AttributesToGet@ together in a single request, unless the value for @Select@ is @SPECIFIC_ATTRIBUTES@ . (This usage is equivalent to specifying @AttributesToGet@ without any value for @Select@ .) -- --- * 'sSegment' - For a parallel /Scan/ request, /Segment/ identifies an individual segment to be scanned by an application worker. Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a /Segment/ value of 0, the second thread specifies 1, and so on. The value of /LastEvaluatedKey/ returned from a parallel /Scan/ request must be used as /ExclusiveStartKey/ with the same segment ID in a subsequent /Scan/ operation. The value for /Segment/ must be greater than or equal to 0, and less than the value provided for /TotalSegments/ . If you provide /Segment/ , you must also provide /TotalSegments/ . +-- * 'sSegment' - For a parallel @Scan@ request, @Segment@ identifies an individual segment to be scanned by an application worker. Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a @Segment@ value of 0, the second thread specifies 1, and so on. The value of @LastEvaluatedKey@ returned from a parallel @Scan@ request must be used as @ExclusiveStartKey@ with the same segment ID in a subsequent @Scan@ operation. The value for @Segment@ must be greater than or equal to 0, and less than the value provided for @TotalSegments@ . If you provide @Segment@ , you must also provide @TotalSegments@ . -- --- * 'sConditionalOperator' - /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /FilterExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. A logical operator to apply to the conditions in a /ScanFilter/ map: * @AND@ - If all of the conditions evaluate to true, then the entire map evaluates to true. * @OR@ - If at least one of the conditions evaluate to true, then the entire map evaluates to true. If you omit /ConditionalOperator/ , then @AND@ is the default. The operation will succeed only if the entire map evaluates to true. +-- * 'sConditionalOperator' - This is a legacy parameter. Use @FilterExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . -- --- * 'sExclusiveStartKey' - The primary key of the first item that this operation will evaluate. Use the value that was returned for /LastEvaluatedKey/ in the previous operation. The data type for /ExclusiveStartKey/ must be String, Number or Binary. No set data types are allowed. In a parallel scan, a /Scan/ request that includes /ExclusiveStartKey/ must specify the same segment whose previous /Scan/ returned the corresponding value of /LastEvaluatedKey/ . +-- * 'sExclusiveStartKey' - The primary key of the first item that this operation will evaluate. Use the value that was returned for @LastEvaluatedKey@ in the previous operation. The data type for @ExclusiveStartKey@ must be String, Number or Binary. No set data types are allowed. In a parallel scan, a @Scan@ request that includes @ExclusiveStartKey@ must specify the same segment whose previous @Scan@ returned the corresponding value of @LastEvaluatedKey@ . -- -- * 'sIndexName' - The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the @IndexName@ parameter, you must also provide @TableName@ . -- @@ -135,54 +138,55 @@ :: Text -- ^ 'sTableName' -> Scan scan pTableName_ = - Scan' - { _sProjectionExpression = Nothing - , _sScanFilter = Nothing - , _sAttributesToGet = Nothing - , _sTotalSegments = Nothing - , _sExpressionAttributeNames = Nothing - , _sFilterExpression = Nothing - , _sConsistentRead = Nothing - , _sExpressionAttributeValues = Nothing - , _sReturnConsumedCapacity = Nothing - , _sLimit = Nothing - , _sSelect = Nothing - , _sSegment = Nothing - , _sConditionalOperator = Nothing - , _sExclusiveStartKey = Nothing - , _sIndexName = Nothing - , _sTableName = pTableName_ - } + Scan' + { _sProjectionExpression = Nothing + , _sScanFilter = Nothing + , _sAttributesToGet = Nothing + , _sTotalSegments = Nothing + , _sExpressionAttributeNames = Nothing + , _sFilterExpression = Nothing + , _sConsistentRead = Nothing + , _sExpressionAttributeValues = Nothing + , _sReturnConsumedCapacity = Nothing + , _sLimit = Nothing + , _sSelect = Nothing + , _sSegment = Nothing + , _sConditionalOperator = Nothing + , _sExclusiveStartKey = Nothing + , _sIndexName = Nothing + , _sTableName = pTableName_ + } + -- | A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see in the /Amazon DynamoDB Developer Guide/ . sProjectionExpression :: Lens' Scan (Maybe Text) sProjectionExpression = lens _sProjectionExpression (\ s a -> s{_sProjectionExpression = a}); --- | /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /FilterExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. A condition that evaluates the scan results and returns only the desired values. If you specify more than one condition in the /ScanFilter/ map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the /ConditionalOperator/ parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.) Each /ScanFilter/ element consists of an attribute name to compare, along with the following: * /AttributeValueList/ - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in /ComparisonOperator/ . For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, @a@ is greater than @A@ , and @a@ is greater than @B@ . For a list of code values, see . For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. For information on specifying data types in JSON, see in the /Amazon DynamoDB Developer Guide/ . * /ComparisonOperator/ - A comparator for evaluating attributes. For example, equals, greater than, less than, etc. The following comparison operators are available: @EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN@ For complete descriptions of all comparison operators, see . +-- | This is a legacy parameter. Use @FilterExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . sScanFilter :: Lens' Scan (HashMap Text Condition) sScanFilter = lens _sScanFilter (\ s a -> s{_sScanFilter = a}) . _Default . _Map; --- | /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /ProjectionExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map. The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. Note that /AttributesToGet/ has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application. +-- | This is a legacy parameter. Use @ProjectionExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . sAttributesToGet :: Lens' Scan (Maybe (NonEmpty Text)) sAttributesToGet = lens _sAttributesToGet (\ s a -> s{_sAttributesToGet = a}) . mapping _List1; --- | For a parallel /Scan/ request, /TotalSegments/ represents the total number of segments into which the /Scan/ operation will be divided. The value of /TotalSegments/ corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a /TotalSegments/ value of 4. The value for /TotalSegments/ must be greater than or equal to 1, and less than or equal to 1000000. If you specify a /TotalSegments/ value of 1, the /Scan/ operation will be sequential rather than parallel. If you specify /TotalSegments/ , you must also specify /Segment/ . +-- | For a parallel @Scan@ request, @TotalSegments@ represents the total number of segments into which the @Scan@ operation will be divided. The value of @TotalSegments@ corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a @TotalSegments@ value of 4. The value for @TotalSegments@ must be greater than or equal to 1, and less than or equal to 1000000. If you specify a @TotalSegments@ value of 1, the @Scan@ operation will be sequential rather than parallel. If you specify @TotalSegments@ , you must also specify @Segment@ . sTotalSegments :: Lens' Scan (Maybe Natural) sTotalSegments = lens _sTotalSegments (\ s a -> s{_sTotalSegments = a}) . mapping _Nat; --- | 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for /ExpressionAttributeNames/ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . +-- | 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for @ExpressionAttributeNames@ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . sExpressionAttributeNames :: Lens' Scan (HashMap Text Text) sExpressionAttributeNames = lens _sExpressionAttributeNames (\ s a -> s{_sExpressionAttributeNames = a}) . _Default . _Map; --- | A string that contains conditions that DynamoDB applies after the /Scan/ operation, but before the data is returned to you. Items that do not satisfy the /FilterExpression/ criteria are not returned. For more information, see in the /Amazon DynamoDB Developer Guide/ . +-- | A string that contains conditions that DynamoDB applies after the @Scan@ operation, but before the data is returned to you. Items that do not satisfy the @FilterExpression@ criteria are not returned. For more information, see in the /Amazon DynamoDB Developer Guide/ . sFilterExpression :: Lens' Scan (Maybe Text) sFilterExpression = lens _sFilterExpression (\ s a -> s{_sFilterExpression = a}); --- | A Boolean value that determines the read consistency model during the scan: * If /ConsistentRead/ is @false@ , then the data returned from /Scan/ might not contain the results from other recently completed write operations (PutItem, UpdateItem or DeleteItem). * If /ConsistentRead/ is @true@ , then all of the write operations that completed before the /Scan/ began are guaranteed to be contained in the /Scan/ response. The default setting for /ConsistentRead/ is @false@ . The /ConsistentRead/ parameter is not supported on global secondary indexes. If you scan a global secondary index with /ConsistentRead/ set to true, you will receive a /ValidationException/ . +-- | A Boolean value that determines the read consistency model during the scan: * If @ConsistentRead@ is @false@ , then the data returned from @Scan@ might not contain the results from other recently completed write operations (PutItem, UpdateItem or DeleteItem). * If @ConsistentRead@ is @true@ , then all of the write operations that completed before the @Scan@ began are guaranteed to be contained in the @Scan@ response. The default setting for @ConsistentRead@ is @false@ . The @ConsistentRead@ parameter is not supported on global secondary indexes. If you scan a global secondary index with @ConsistentRead@ set to true, you will receive a @ValidationException@ . sConsistentRead :: Lens' Scan (Maybe Bool) sConsistentRead = lens _sConsistentRead (\ s a -> s{_sConsistentRead = a}); --- | 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 in the /Amazon DynamoDB Developer Guide/ . +-- | 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 in the /Amazon DynamoDB Developer Guide/ . sExpressionAttributeValues :: Lens' Scan (HashMap Text AttributeValue) sExpressionAttributeValues = lens _sExpressionAttributeValues (\ s a -> s{_sExpressionAttributeValues = a}) . _Default . _Map; @@ -190,23 +194,23 @@ sReturnConsumedCapacity :: Lens' Scan (Maybe ReturnConsumedCapacity) sReturnConsumedCapacity = lens _sReturnConsumedCapacity (\ s a -> s{_sReturnConsumedCapacity = a}); --- | The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in /LastEvaluatedKey/ to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in /LastEvaluatedKey/ to apply in a subsequent operation to continue the operation. For more information, see in the /Amazon DynamoDB Developer Guide/ . +-- | The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in @LastEvaluatedKey@ to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in @LastEvaluatedKey@ to apply in a subsequent operation to continue the operation. For more information, see in the /Amazon DynamoDB Developer Guide/ . sLimit :: Lens' Scan (Maybe Natural) sLimit = lens _sLimit (\ s a -> s{_sLimit = a}) . mapping _Nat; --- | The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, or the count of matching items. * @ALL_ATTRIBUTES@ - Returns all of the item attributes. * @ALL_PROJECTED_ATTRIBUTES@ - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying @ALL_ATTRIBUTES@ . * @COUNT@ - Returns the number of matching items, rather than the matching items themselves. * @SPECIFIC_ATTRIBUTES@ - Returns only the attributes listed in /AttributesToGet/ . This return value is equivalent to specifying /AttributesToGet/ without specifying any value for /Select/ . If neither /Select/ nor /AttributesToGet/ are specified, DynamoDB defaults to @ALL_ATTRIBUTES@ . You cannot use both /AttributesToGet/ and /Select/ together in a single request, unless the value for /Select/ is @SPECIFIC_ATTRIBUTES@ . (This usage is equivalent to specifying /AttributesToGet/ without any value for /Select/ .) +-- | The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index. * @ALL_ATTRIBUTES@ - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required. * @ALL_PROJECTED_ATTRIBUTES@ - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying @ALL_ATTRIBUTES@ . * @COUNT@ - Returns the number of matching items, rather than the matching items themselves. * @SPECIFIC_ATTRIBUTES@ - Returns only the attributes listed in @AttributesToGet@ . This return value is equivalent to specifying @AttributesToGet@ without specifying any value for @Select@ . If you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency. If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table. If neither @Select@ nor @AttributesToGet@ are specified, DynamoDB defaults to @ALL_ATTRIBUTES@ when accessing a table, and @ALL_PROJECTED_ATTRIBUTES@ when accessing an index. You cannot use both @Select@ and @AttributesToGet@ together in a single request, unless the value for @Select@ is @SPECIFIC_ATTRIBUTES@ . (This usage is equivalent to specifying @AttributesToGet@ without any value for @Select@ .) sSelect :: Lens' Scan (Maybe Select) sSelect = lens _sSelect (\ s a -> s{_sSelect = a}); --- | For a parallel /Scan/ request, /Segment/ identifies an individual segment to be scanned by an application worker. Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a /Segment/ value of 0, the second thread specifies 1, and so on. The value of /LastEvaluatedKey/ returned from a parallel /Scan/ request must be used as /ExclusiveStartKey/ with the same segment ID in a subsequent /Scan/ operation. The value for /Segment/ must be greater than or equal to 0, and less than the value provided for /TotalSegments/ . If you provide /Segment/ , you must also provide /TotalSegments/ . +-- | For a parallel @Scan@ request, @Segment@ identifies an individual segment to be scanned by an application worker. Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a @Segment@ value of 0, the second thread specifies 1, and so on. The value of @LastEvaluatedKey@ returned from a parallel @Scan@ request must be used as @ExclusiveStartKey@ with the same segment ID in a subsequent @Scan@ operation. The value for @Segment@ must be greater than or equal to 0, and less than the value provided for @TotalSegments@ . If you provide @Segment@ , you must also provide @TotalSegments@ . sSegment :: Lens' Scan (Maybe Natural) sSegment = lens _sSegment (\ s a -> s{_sSegment = a}) . mapping _Nat; --- | /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /FilterExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. A logical operator to apply to the conditions in a /ScanFilter/ map: * @AND@ - If all of the conditions evaluate to true, then the entire map evaluates to true. * @OR@ - If at least one of the conditions evaluate to true, then the entire map evaluates to true. If you omit /ConditionalOperator/ , then @AND@ is the default. The operation will succeed only if the entire map evaluates to true. +-- | This is a legacy parameter. Use @FilterExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . sConditionalOperator :: Lens' Scan (Maybe ConditionalOperator) sConditionalOperator = lens _sConditionalOperator (\ s a -> s{_sConditionalOperator = a}); --- | The primary key of the first item that this operation will evaluate. Use the value that was returned for /LastEvaluatedKey/ in the previous operation. The data type for /ExclusiveStartKey/ must be String, Number or Binary. No set data types are allowed. In a parallel scan, a /Scan/ request that includes /ExclusiveStartKey/ must specify the same segment whose previous /Scan/ returned the corresponding value of /LastEvaluatedKey/ . +-- | The primary key of the first item that this operation will evaluate. Use the value that was returned for @LastEvaluatedKey@ in the previous operation. The data type for @ExclusiveStartKey@ must be String, Number or Binary. No set data types are allowed. In a parallel scan, a @Scan@ request that includes @ExclusiveStartKey@ must specify the same segment whose previous @Scan@ returned the corresponding value of @LastEvaluatedKey@ . sExclusiveStartKey :: Lens' Scan (HashMap Text AttributeValue) sExclusiveStartKey = lens _sExclusiveStartKey (\ s a -> s{_sExclusiveStartKey = a}) . _Default . _Map; @@ -221,9 +225,6 @@ instance AWSPager Scan where page rq rs | stop (rs ^. srsLastEvaluatedKey) = Nothing - | stop (rs ^. srsItems) = Nothing - | stop (rs ^. srsCount) = Nothing - | stop (rs ^. srsScannedCount) = Nothing | otherwise = Just $ rq & sExclusiveStartKey .~ rs ^. srsLastEvaluatedKey @@ -242,9 +243,9 @@ <*> (x .?> "ConsumedCapacity") <*> (pure (fromEnum s))) -instance Hashable Scan +instance Hashable Scan where -instance NFData Scan +instance NFData Scan where instance ToHeaders Scan where toHeaders @@ -285,57 +286,59 @@ instance ToQuery Scan where toQuery = const mempty --- | Represents the output of a /Scan/ operation. +-- | Represents the output of a @Scan@ operation. -- -- -- -- /See:/ 'scanResponse' smart constructor. data ScanResponse = ScanResponse' - { _srsLastEvaluatedKey :: !(Maybe (Map Text AttributeValue)) - , _srsCount :: !(Maybe Int) - , _srsScannedCount :: !(Maybe Int) - , _srsItems :: !(Maybe [Map Text AttributeValue]) - , _srsConsumedCapacity :: !(Maybe ConsumedCapacity) - , _srsResponseStatus :: !Int - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _srsLastEvaluatedKey :: !(Maybe (Map Text AttributeValue)) + , _srsCount :: !(Maybe Int) + , _srsScannedCount :: !(Maybe Int) + , _srsItems :: !(Maybe [Map Text AttributeValue]) + , _srsConsumedCapacity :: !(Maybe ConsumedCapacity) + , _srsResponseStatus :: !Int + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'ScanResponse' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'srsLastEvaluatedKey' - The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request. If /LastEvaluatedKey/ is empty, then the "last page" of results has been processed and there is no more data to be retrieved. If /LastEvaluatedKey/ is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when /LastEvaluatedKey/ is empty. +-- * 'srsLastEvaluatedKey' - The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request. If @LastEvaluatedKey@ is empty, then the "last page" of results has been processed and there is no more data to be retrieved. If @LastEvaluatedKey@ is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when @LastEvaluatedKey@ is empty. -- --- * 'srsCount' - The number of items in the response. If you set /ScanFilter/ in the request, then /Count/ is the number of items returned after the filter was applied, and /ScannedCount/ is the number of matching items before the filter was applied. If you did not use a filter in the request, then /Count/ is the same as /ScannedCount/ . +-- * 'srsCount' - The number of items in the response. If you set @ScanFilter@ in the request, then @Count@ is the number of items returned after the filter was applied, and @ScannedCount@ is the number of matching items before the filter was applied. If you did not use a filter in the request, then @Count@ is the same as @ScannedCount@ . -- --- * 'srsScannedCount' - The number of items evaluated, before any /ScanFilter/ is applied. A high /ScannedCount/ value with few, or no, /Count/ results indicates an inefficient /Scan/ operation. For more information, see in the /Amazon DynamoDB Developer Guide/ . If you did not use a filter in the request, then /ScannedCount/ is the same as /Count/ . +-- * 'srsScannedCount' - The number of items evaluated, before any @ScanFilter@ is applied. A high @ScannedCount@ value with few, or no, @Count@ results indicates an inefficient @Scan@ operation. For more information, see in the /Amazon DynamoDB Developer Guide/ . If you did not use a filter in the request, then @ScannedCount@ is the same as @Count@ . -- -- * 'srsItems' - An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute. -- --- * 'srsConsumedCapacity' - Undocumented member. +-- * 'srsConsumedCapacity' - The capacity units consumed by the @Scan@ operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. @ConsumedCapacity@ is only returned if the @ReturnConsumedCapacity@ parameter was specified. For more information, see in the /Amazon DynamoDB Developer Guide/ . -- -- * 'srsResponseStatus' - -- | The response status code. scanResponse :: Int -- ^ 'srsResponseStatus' -> ScanResponse scanResponse pResponseStatus_ = - ScanResponse' - { _srsLastEvaluatedKey = Nothing - , _srsCount = Nothing - , _srsScannedCount = Nothing - , _srsItems = Nothing - , _srsConsumedCapacity = Nothing - , _srsResponseStatus = pResponseStatus_ - } + ScanResponse' + { _srsLastEvaluatedKey = Nothing + , _srsCount = Nothing + , _srsScannedCount = Nothing + , _srsItems = Nothing + , _srsConsumedCapacity = Nothing + , _srsResponseStatus = pResponseStatus_ + } --- | 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. + +-- | 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. srsLastEvaluatedKey :: Lens' ScanResponse (HashMap Text AttributeValue) srsLastEvaluatedKey = lens _srsLastEvaluatedKey (\ s a -> s{_srsLastEvaluatedKey = a}) . _Default . _Map; --- | The number of items in the response. If you set /ScanFilter/ in the request, then /Count/ is the number of items returned after the filter was applied, and /ScannedCount/ is the number of matching items before the filter was applied. If you did not use a filter in the request, then /Count/ is the same as /ScannedCount/ . +-- | The number of items in the response. If you set @ScanFilter@ in the request, then @Count@ is the number of items returned after the filter was applied, and @ScannedCount@ is the number of matching items before the filter was applied. If you did not use a filter in the request, then @Count@ is the same as @ScannedCount@ . srsCount :: Lens' ScanResponse (Maybe Int) srsCount = lens _srsCount (\ s a -> s{_srsCount = a}); --- | The number of items evaluated, before any /ScanFilter/ is applied. A high /ScannedCount/ value with few, or no, /Count/ results indicates an inefficient /Scan/ operation. For more information, see in the /Amazon DynamoDB Developer Guide/ . If you did not use a filter in the request, then /ScannedCount/ is the same as /Count/ . +-- | The number of items evaluated, before any @ScanFilter@ is applied. A high @ScannedCount@ value with few, or no, @Count@ results indicates an inefficient @Scan@ operation. For more information, see in the /Amazon DynamoDB Developer Guide/ . If you did not use a filter in the request, then @ScannedCount@ is the same as @Count@ . srsScannedCount :: Lens' ScanResponse (Maybe Int) srsScannedCount = lens _srsScannedCount (\ s a -> s{_srsScannedCount = a}); @@ -343,7 +346,7 @@ srsItems :: Lens' ScanResponse [HashMap Text AttributeValue] srsItems = lens _srsItems (\ s a -> s{_srsItems = a}) . _Default . _Coerce; --- | Undocumented member. +-- | The capacity units consumed by the @Scan@ operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. @ConsumedCapacity@ is only returned if the @ReturnConsumedCapacity@ parameter was specified. For more information, see in the /Amazon DynamoDB Developer Guide/ . srsConsumedCapacity :: Lens' ScanResponse (Maybe ConsumedCapacity) srsConsumedCapacity = lens _srsConsumedCapacity (\ s a -> s{_srsConsumedCapacity = a}); @@ -351,4 +354,4 @@ srsResponseStatus :: Lens' ScanResponse Int srsResponseStatus = lens _srsResponseStatus (\ s a -> s{_srsResponseStatus = a}); -instance NFData ScanResponse +instance NFData ScanResponse where diff --git a/gen/Network/AWS/DynamoDB/TagResource.hs b/gen/Network/AWS/DynamoDB/TagResource.hs new file mode 100644 --- /dev/null +++ b/gen/Network/AWS/DynamoDB/TagResource.hs @@ -0,0 +1,120 @@ +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} +{-# LANGUAGE TypeFamilies #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} +{-# OPTIONS_GHC -fno-warn-unused-binds #-} +{-# OPTIONS_GHC -fno-warn-unused-matches #-} + +-- Derived from AWS service descriptions, licensed under Apache 2.0. + +-- | +-- Module : Network.AWS.DynamoDB.TagResource +-- Copyright : (c) 2013-2017 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +-- Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to 5 times per second, per account. +-- +-- +-- For an overview on tagging DynamoDB resources, see in the /Amazon DynamoDB Developer Guide/ . +-- +module Network.AWS.DynamoDB.TagResource + ( + -- * Creating a Request + tagResource + , TagResource + -- * Request Lenses + , trResourceARN + , trTags + + -- * Destructuring the Response + , tagResourceResponse + , TagResourceResponse + ) where + +import Network.AWS.DynamoDB.Types +import Network.AWS.DynamoDB.Types.Product +import Network.AWS.Lens +import Network.AWS.Prelude +import Network.AWS.Request +import Network.AWS.Response + +-- | /See:/ 'tagResource' smart constructor. +data TagResource = TagResource' + { _trResourceARN :: !Text + , _trTags :: ![Tag] + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'TagResource' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'trResourceARN' - Identifies the Amazon DynamoDB resource to which tags should be added. This value is an Amazon Resource Name (ARN). +-- +-- * 'trTags' - The tags to be assigned to the Amazon DynamoDB resource. +tagResource + :: Text -- ^ 'trResourceARN' + -> TagResource +tagResource pResourceARN_ = + TagResource' {_trResourceARN = pResourceARN_, _trTags = mempty} + + +-- | Identifies the Amazon DynamoDB resource to which tags should be added. This value is an Amazon Resource Name (ARN). +trResourceARN :: Lens' TagResource Text +trResourceARN = lens _trResourceARN (\ s a -> s{_trResourceARN = a}); + +-- | The tags to be assigned to the Amazon DynamoDB resource. +trTags :: Lens' TagResource [Tag] +trTags = lens _trTags (\ s a -> s{_trTags = a}) . _Coerce; + +instance AWSRequest TagResource where + type Rs TagResource = TagResourceResponse + request = postJSON dynamoDB + response = receiveNull TagResourceResponse' + +instance Hashable TagResource where + +instance NFData TagResource where + +instance ToHeaders TagResource where + toHeaders + = const + (mconcat + ["X-Amz-Target" =# + ("DynamoDB_20120810.TagResource" :: ByteString), + "Content-Type" =# + ("application/x-amz-json-1.0" :: ByteString)]) + +instance ToJSON TagResource where + toJSON TagResource'{..} + = object + (catMaybes + [Just ("ResourceArn" .= _trResourceARN), + Just ("Tags" .= _trTags)]) + +instance ToPath TagResource where + toPath = const "/" + +instance ToQuery TagResource where + toQuery = const mempty + +-- | /See:/ 'tagResourceResponse' smart constructor. +data TagResourceResponse = + TagResourceResponse' + deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'TagResourceResponse' with the minimum fields required to make a request. +-- +tagResourceResponse + :: TagResourceResponse +tagResourceResponse = TagResourceResponse' + + +instance NFData TagResourceResponse where diff --git a/gen/Network/AWS/DynamoDB/Types.hs b/gen/Network/AWS/DynamoDB/Types.hs --- a/gen/Network/AWS/DynamoDB/Types.hs +++ b/gen/Network/AWS/DynamoDB/Types.hs @@ -4,9 +4,9 @@ -- | -- Module : Network.AWS.DynamoDB.Types --- Copyright : (c) 2013-2016 Brendan Hay +-- Copyright : (c) 2013-2017 Brendan Hay -- License : Mozilla Public License, v. 2.0. --- Maintainer : Brendan Hay +-- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- @@ -63,6 +63,9 @@ -- * TableStatus , TableStatus (..) + -- * TimeToLiveStatus + , TimeToLiveStatus (..) + -- * AttributeDefinition , AttributeDefinition , attributeDefinition @@ -251,6 +254,24 @@ , tdTableName , tdStreamSpecification + -- * Tag + , Tag + , tag + , tagKey + , tagValue + + -- * TimeToLiveDescription + , TimeToLiveDescription + , timeToLiveDescription + , ttldTimeToLiveStatus + , ttldAttributeName + + -- * TimeToLiveSpecification + , TimeToLiveSpecification + , timeToLiveSpecification + , ttlsEnabled + , ttlsAttributeName + -- * UpdateGlobalSecondaryIndexAction , UpdateGlobalSecondaryIndexAction , updateGlobalSecondaryIndexAction @@ -264,43 +285,43 @@ , wrPutRequest ) where -import Network.AWS.DynamoDB.Types.Product -import Network.AWS.DynamoDB.Types.Sum -import Network.AWS.Lens -import Network.AWS.Prelude -import Network.AWS.Sign.V4 +import Network.AWS.DynamoDB.Types.Product +import Network.AWS.DynamoDB.Types.Sum +import Network.AWS.Lens +import Network.AWS.Prelude +import Network.AWS.Sign.V4 -- | API version @2012-08-10@ of the Amazon DynamoDB SDK configuration. dynamoDB :: Service dynamoDB = - Service - { _svcAbbrev = "DynamoDB" - , _svcSigner = v4 - , _svcPrefix = "dynamodb" - , _svcVersion = "2012-08-10" - , _svcEndpoint = defaultEndpoint dynamoDB - , _svcTimeout = Just 70 - , _svcCheck = statusSuccess - , _svcError = parseJSONError "DynamoDB" - , _svcRetry = retry - } + Service + { _svcAbbrev = "DynamoDB" + , _svcSigner = v4 + , _svcPrefix = "dynamodb" + , _svcVersion = "2012-08-10" + , _svcEndpoint = defaultEndpoint dynamoDB + , _svcTimeout = Just 70 + , _svcCheck = statusSuccess + , _svcError = parseJSONError "DynamoDB" + , _svcRetry = retry + } where retry = - Exponential - { _retryBase = 5.0e-2 - , _retryGrowth = 2 - , _retryAttempts = 5 - , _retryCheck = check - } + Exponential + { _retryBase = 5.0e-2 + , _retryGrowth = 2 + , _retryAttempts = 5 + , _retryCheck = check + } check e + | has (hasCode "ThrottledException" . hasStatus 400) e = + Just "throttled_exception" | has (hasStatus 429) e = Just "too_many_requests" | has (hasCode "ThrottlingException" . hasStatus 400) e = - Just "throttling_exception" + Just "throttling_exception" | has (hasCode "Throttling" . hasStatus 400) e = Just "throttling" - | has - (hasCode "ProvisionedThroughputExceededException" . hasStatus 400) - e = - Just "throughput_exceeded" + | has (hasCode "ProvisionedThroughputExceededException" . hasStatus 400) e = + Just "throughput_exceeded" | has (hasStatus 504) e = Just "gateway_timeout" | has (hasStatus 502) e = Just "bad_gateway" | has (hasStatus 503) e = Just "service_unavailable" @@ -308,40 +329,46 @@ | has (hasStatus 509) e = Just "limit_exceeded" | otherwise = Nothing --- | Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to in the /Amazon DynamoDB Developer Guide/ . + +-- | Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to in the /Amazon DynamoDB Developer Guide/ . -- -- _ProvisionedThroughputExceededException :: AsError a => Getting (First ServiceError) a ServiceError _ProvisionedThroughputExceededException = - _ServiceError . hasCode "ProvisionedThroughputExceededException" + _MatchServiceError dynamoDB "ProvisionedThroughputExceededException" + -- | A condition specified in the operation could not be evaluated. -- -- _ConditionalCheckFailedException :: AsError a => Getting (First ServiceError) a ServiceError _ConditionalCheckFailedException = - _ServiceError . hasCode "ConditionalCheckFailedException" + _MatchServiceError dynamoDB "ConditionalCheckFailedException" + -- | An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. -- -- _ItemCollectionSizeLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError _ItemCollectionSizeLimitExceededException = - _ServiceError . hasCode "ItemCollectionSizeLimitExceededException" + _MatchServiceError dynamoDB "ItemCollectionSizeLimitExceededException" + -- | An error occurred on the server side. -- -- _InternalServerError :: AsError a => Getting (First ServiceError) a ServiceError -_InternalServerError = _ServiceError . hasCode "InternalServerError" +_InternalServerError = _MatchServiceError dynamoDB "InternalServerError" + -- | The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be @ACTIVE@ . -- -- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError _ResourceNotFoundException = - _ServiceError . hasCode "ResourceNotFoundException" + _MatchServiceError dynamoDB "ResourceNotFoundException" + -- | The number of concurrent table requests (cumulative number of tables in the @CREATING@ , @DELETING@ or @UPDATING@ state) exceeds the maximum allowed of 10. -- -- @@ -350,10 +377,12 @@ -- The total limit of tables in the @ACTIVE@ state is 250. -- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError -_LimitExceededException = _ServiceError . hasCode "LimitExceededException" +_LimitExceededException = _MatchServiceError dynamoDB "LimitExceededException" + -- | The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the @CREATING@ state. -- -- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError -_ResourceInUseException = _ServiceError . hasCode "ResourceInUseException" +_ResourceInUseException = _MatchServiceError dynamoDB "ResourceInUseException" + diff --git a/gen/Network/AWS/DynamoDB/Types/Product.hs b/gen/Network/AWS/DynamoDB/Types/Product.hs --- a/gen/Network/AWS/DynamoDB/Types/Product.hs +++ b/gen/Network/AWS/DynamoDB/Types/Product.hs @@ -9,1692 +9,1873 @@ -- | -- Module : Network.AWS.DynamoDB.Types.Product --- Copyright : (c) 2013-2016 Brendan Hay --- License : Mozilla Public License, v. 2.0. --- Maintainer : Brendan Hay --- Stability : auto-generated --- Portability : non-portable (GHC extensions) --- -module Network.AWS.DynamoDB.Types.Product where - -import Network.AWS.DynamoDB.Types.Sum -import Network.AWS.Lens -import Network.AWS.Prelude - --- | Represents an attribute for describing the key schema for the table and indexes. --- --- --- --- /See:/ 'attributeDefinition' smart constructor. -data AttributeDefinition = AttributeDefinition' - { _adAttributeName :: !Text - , _adAttributeType :: !ScalarAttributeType - } deriving (Eq,Read,Show,Data,Typeable,Generic) - --- | Creates a value of 'AttributeDefinition' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'adAttributeName' - A name for the attribute. --- --- * 'adAttributeType' - The data type for the attribute, where: * @S@ - the attribute is of type String * @N@ - the attribute is of type Number * @B@ - the attribute is of type Binary -attributeDefinition - :: Text -- ^ 'adAttributeName' - -> ScalarAttributeType -- ^ 'adAttributeType' - -> AttributeDefinition -attributeDefinition pAttributeName_ pAttributeType_ = - AttributeDefinition' - { _adAttributeName = pAttributeName_ - , _adAttributeType = pAttributeType_ - } - --- | A name for the attribute. -adAttributeName :: Lens' AttributeDefinition Text -adAttributeName = lens _adAttributeName (\ s a -> s{_adAttributeName = a}); - --- | The data type for the attribute, where: * @S@ - the attribute is of type String * @N@ - the attribute is of type Number * @B@ - the attribute is of type Binary -adAttributeType :: Lens' AttributeDefinition ScalarAttributeType -adAttributeType = lens _adAttributeType (\ s a -> s{_adAttributeType = a}); - -instance FromJSON AttributeDefinition where - parseJSON - = withObject "AttributeDefinition" - (\ x -> - AttributeDefinition' <$> - (x .: "AttributeName") <*> (x .: "AttributeType")) - -instance Hashable AttributeDefinition - -instance NFData AttributeDefinition - -instance ToJSON AttributeDefinition where - toJSON AttributeDefinition'{..} - = object - (catMaybes - [Just ("AttributeName" .= _adAttributeName), - Just ("AttributeType" .= _adAttributeType)]) - --- | Represents the data for an attribute. You can set one, and only one, of the elements. --- --- --- Each attribute in an item is a name-value pair. An attribute can be single-valued or multi-valued set. For example, a book item can have title and authors attributes. Each book has one title but can have many authors. The multi-valued attribute is a set; duplicate values are not allowed. --- --- --- /See:/ 'attributeValue' smart constructor. -data AttributeValue = AttributeValue' - { _avL :: !(Maybe [AttributeValue]) - , _avNS :: !(Maybe [Text]) - , _avM :: !(Maybe (Map Text AttributeValue)) - , _avNULL :: !(Maybe Bool) - , _avN :: !(Maybe Text) - , _avBS :: !(Maybe [Base64]) - , _avB :: !(Maybe Base64) - , _avSS :: !(Maybe [Text]) - , _avS :: !(Maybe Text) - , _avBOOL :: !(Maybe Bool) - } deriving (Eq,Read,Show,Data,Typeable,Generic) - --- | Creates a value of 'AttributeValue' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'avL' - A List of attribute values. --- --- * 'avNS' - A Number Set data type. --- --- * 'avM' - A Map of attribute values. --- --- * 'avNULL' - A Null data type. --- --- * 'avN' - A Number data type. --- --- * 'avBS' - A Binary Set data type. --- --- * 'avB' - A Binary data type.-- /Note:/ This 'Lens' automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This 'Lens' accepts and returns only raw unencoded data. --- --- * 'avSS' - A String Set data type. --- --- * 'avS' - A String data type. --- --- * 'avBOOL' - A Boolean data type. -attributeValue - :: AttributeValue -attributeValue = - AttributeValue' - { _avL = Nothing - , _avNS = Nothing - , _avM = Nothing - , _avNULL = Nothing - , _avN = Nothing - , _avBS = Nothing - , _avB = Nothing - , _avSS = Nothing - , _avS = Nothing - , _avBOOL = Nothing - } - --- | A List of attribute values. -avL :: Lens' AttributeValue [AttributeValue] -avL = lens _avL (\ s a -> s{_avL = a}) . _Default . _Coerce; - --- | A Number Set data type. -avNS :: Lens' AttributeValue [Text] -avNS = lens _avNS (\ s a -> s{_avNS = a}) . _Default . _Coerce; - --- | A Map of attribute values. -avM :: Lens' AttributeValue (HashMap Text AttributeValue) -avM = lens _avM (\ s a -> s{_avM = a}) . _Default . _Map; - --- | A Null data type. -avNULL :: Lens' AttributeValue (Maybe Bool) -avNULL = lens _avNULL (\ s a -> s{_avNULL = a}); - --- | A Number data type. -avN :: Lens' AttributeValue (Maybe Text) -avN = lens _avN (\ s a -> s{_avN = a}); - --- | A Binary Set data type. -avBS :: Lens' AttributeValue [ByteString] -avBS = lens _avBS (\ s a -> s{_avBS = a}) . _Default . _Coerce; - --- | A Binary data type.-- /Note:/ This 'Lens' automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This 'Lens' accepts and returns only raw unencoded data. -avB :: Lens' AttributeValue (Maybe ByteString) -avB = lens _avB (\ s a -> s{_avB = a}) . mapping _Base64; - --- | A String Set data type. -avSS :: Lens' AttributeValue [Text] -avSS = lens _avSS (\ s a -> s{_avSS = a}) . _Default . _Coerce; - --- | A String data type. -avS :: Lens' AttributeValue (Maybe Text) -avS = lens _avS (\ s a -> s{_avS = a}); - --- | A Boolean data type. -avBOOL :: Lens' AttributeValue (Maybe Bool) -avBOOL = lens _avBOOL (\ s a -> s{_avBOOL = a}); - -instance FromJSON AttributeValue where - parseJSON - = withObject "AttributeValue" - (\ x -> - AttributeValue' <$> - (x .:? "L" .!= mempty) <*> (x .:? "NS" .!= mempty) - <*> (x .:? "M" .!= mempty) - <*> (x .:? "NULL") - <*> (x .:? "N") - <*> (x .:? "BS" .!= mempty) - <*> (x .:? "B") - <*> (x .:? "SS" .!= mempty) - <*> (x .:? "S") - <*> (x .:? "BOOL")) - -instance Hashable AttributeValue - -instance NFData AttributeValue - -instance ToJSON AttributeValue where - toJSON AttributeValue'{..} - = object - (catMaybes - [("L" .=) <$> _avL, ("NS" .=) <$> _avNS, - ("M" .=) <$> _avM, ("NULL" .=) <$> _avNULL, - ("N" .=) <$> _avN, ("BS" .=) <$> _avBS, - ("B" .=) <$> _avB, ("SS" .=) <$> _avSS, - ("S" .=) <$> _avS, ("BOOL" .=) <$> _avBOOL]) - --- | For the /UpdateItem/ operation, represents the attributes to be modified, the action to perform on each, and the new value for each. --- --- --- Attribute values cannot be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests with empty values will be rejected with a /ValidationException/ exception. --- --- --- /See:/ 'attributeValueUpdate' smart constructor. -data AttributeValueUpdate = AttributeValueUpdate' - { _avuValue :: !(Maybe AttributeValue) - , _avuAction :: !(Maybe AttributeAction) - } deriving (Eq,Read,Show,Data,Typeable,Generic) - --- | Creates a value of 'AttributeValueUpdate' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'avuValue' - Undocumented member. --- --- * 'avuAction' - Specifies how to perform the update. Valid values are @PUT@ (default), @DELETE@ , and @ADD@ . The behavior depends on whether the specified primary key already exists in the table. __If an item with the specified /Key/ is found in the table:__ * @PUT@ - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. * @DELETE@ - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type. If a /set/ of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set @[a,b,c]@ and the /DELETE/ action specified @[a,c]@ , then the final attribute value would be @[b]@ . Specifying an empty set is an error. * @ADD@ - If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior of @ADD@ depends on the data type of the attribute: * If the existing attribute is a number, and if /Value/ is also a number, then the /Value/ is mathematically added to the existing attribute. If /Value/ is a negative number, then it is subtracted from the existing attribute. * If the existing data type is a set, and if the /Value/ is also a set, then the /Value/ is added to the existing set. (This is a /set/ operation, not mathematical addition.) For example, if the attribute value was the set @[1,2]@ , and the @ADD@ action specified @[3]@ , then the final attribute value would be @[1,2,3]@ . An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the /Value/ must also be a set of strings. The same holds true for number sets and binary sets. This action is only valid for an existing attribute whose data type is number or is a set. Do not use @ADD@ for any other data types. __If no item with the specified /Key/ is found:__ * @PUT@ - DynamoDB creates a new item with the specified primary key, and then adds the attribute. * @DELETE@ - Nothing happens; there is no attribute to delete. * @ADD@ - DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified. -attributeValueUpdate - :: AttributeValueUpdate -attributeValueUpdate = - AttributeValueUpdate' - { _avuValue = Nothing - , _avuAction = Nothing - } - --- | Undocumented member. -avuValue :: Lens' AttributeValueUpdate (Maybe AttributeValue) -avuValue = lens _avuValue (\ s a -> s{_avuValue = a}); - --- | Specifies how to perform the update. Valid values are @PUT@ (default), @DELETE@ , and @ADD@ . The behavior depends on whether the specified primary key already exists in the table. __If an item with the specified /Key/ is found in the table:__ * @PUT@ - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. * @DELETE@ - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type. If a /set/ of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set @[a,b,c]@ and the /DELETE/ action specified @[a,c]@ , then the final attribute value would be @[b]@ . Specifying an empty set is an error. * @ADD@ - If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior of @ADD@ depends on the data type of the attribute: * If the existing attribute is a number, and if /Value/ is also a number, then the /Value/ is mathematically added to the existing attribute. If /Value/ is a negative number, then it is subtracted from the existing attribute. * If the existing data type is a set, and if the /Value/ is also a set, then the /Value/ is added to the existing set. (This is a /set/ operation, not mathematical addition.) For example, if the attribute value was the set @[1,2]@ , and the @ADD@ action specified @[3]@ , then the final attribute value would be @[1,2,3]@ . An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the /Value/ must also be a set of strings. The same holds true for number sets and binary sets. This action is only valid for an existing attribute whose data type is number or is a set. Do not use @ADD@ for any other data types. __If no item with the specified /Key/ is found:__ * @PUT@ - DynamoDB creates a new item with the specified primary key, and then adds the attribute. * @DELETE@ - Nothing happens; there is no attribute to delete. * @ADD@ - DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified. -avuAction :: Lens' AttributeValueUpdate (Maybe AttributeAction) -avuAction = lens _avuAction (\ s a -> s{_avuAction = a}); - -instance Hashable AttributeValueUpdate - -instance NFData AttributeValueUpdate - -instance ToJSON AttributeValueUpdate where - toJSON AttributeValueUpdate'{..} - = object - (catMaybes - [("Value" .=) <$> _avuValue, - ("Action" .=) <$> _avuAction]) - --- | Represents the amount of provisioned throughput capacity consumed on a table or an index. --- --- --- --- /See:/ 'capacity' smart constructor. -newtype Capacity = Capacity' - { _cCapacityUnits :: Maybe Double - } deriving (Eq,Read,Show,Data,Typeable,Generic) - --- | Creates a value of 'Capacity' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'cCapacityUnits' - The total number of capacity units consumed on a table or an index. -capacity - :: Capacity -capacity = - Capacity' - { _cCapacityUnits = Nothing - } - --- | The total number of capacity units consumed on a table or an index. -cCapacityUnits :: Lens' Capacity (Maybe Double) -cCapacityUnits = lens _cCapacityUnits (\ s a -> s{_cCapacityUnits = a}); - -instance FromJSON Capacity where - parseJSON - = withObject "Capacity" - (\ x -> Capacity' <$> (x .:? "CapacityUnits")) - -instance Hashable Capacity - -instance NFData Capacity - --- | Represents the selection criteria for a /Query/ or /Scan/ operation: --- --- --- * For a /Query/ operation, /Condition/ is used for specifying the /KeyConditions/ to use when querying a table or an index. For /KeyConditions/ , only the following comparison operators are supported: --- --- @EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN@ --- --- /Condition/ is also used in a /QueryFilter/ , which evaluates the query results and returns only the desired values. --- --- * For a /Scan/ operation, /Condition/ is used in a /ScanFilter/ , which evaluates the scan results and returns only the desired values. --- --- --- --- --- /See:/ 'condition' smart constructor. -data Condition = Condition' - { _cAttributeValueList :: !(Maybe [AttributeValue]) - , _cComparisonOperator :: !ComparisonOperator - } deriving (Eq,Read,Show,Data,Typeable,Generic) - --- | Creates a value of 'Condition' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'cAttributeValueList' - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the /ComparisonOperator/ being used. For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, @a@ is greater than @A@ , and @a@ is greater than @B@ . For a list of code values, see . For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. --- --- * 'cComparisonOperator' - A comparator for evaluating attributes. For example, equals, greater than, less than, etc. The following comparison operators are available: @EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN@ The following are descriptions of each comparison operator. * @EQ@ : Equal. @EQ@ is supported for all datatypes, including lists and maps. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @NE@ : Not equal. @NE@ is supported for all datatypes, including lists and maps. /AttributeValueList/ can contain only one /AttributeValue/ of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an /AttributeValue/ of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @LE@ : Less than or equal. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @LT@ : Less than. /AttributeValueList/ can contain only one /AttributeValue/ of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GE@ : Greater than or equal. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GT@ : Greater than. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @NOT_NULL@ : The attribute exists. @NOT_NULL@ is supported for all datatypes, including lists and maps. * @NULL@ : The attribute does not exist. @NULL@ is supported for all datatypes, including lists and maps. * @CONTAINS@ : Checks for a subsequence, or value in a set. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it finds an exact match with any member of the set. CONTAINS is supported for lists: When evaluating "@a CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @NOT_CONTAINS@ : Checks for absence of a subsequence, or absence of a value in a set. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it /does not/ find an exact match with any member of the set. NOT_CONTAINS is supported for lists: When evaluating "@a NOT CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @BEGINS_WITH@ : Checks for a prefix. /AttributeValueList/ can contain only one /AttributeValue/ of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). * @IN@ : Checks for matching elements within two sets. /AttributeValueList/ can contain one or more /AttributeValue/ elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true. * @BETWEEN@ : Greater than or equal to the first value, and less than or equal to the second value. /AttributeValueList/ must contain two /AttributeValue/ elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not compare to @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ For usage examples of /AttributeValueList/ and /ComparisonOperator/ , see in the /Amazon DynamoDB Developer Guide/ . -condition - :: ComparisonOperator -- ^ 'cComparisonOperator' - -> Condition -condition pComparisonOperator_ = - Condition' - { _cAttributeValueList = Nothing - , _cComparisonOperator = pComparisonOperator_ - } - --- | One or more values to evaluate against the supplied attribute. The number of values in the list depends on the /ComparisonOperator/ being used. For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, @a@ is greater than @A@ , and @a@ is greater than @B@ . For a list of code values, see . For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. -cAttributeValueList :: Lens' Condition [AttributeValue] -cAttributeValueList = lens _cAttributeValueList (\ s a -> s{_cAttributeValueList = a}) . _Default . _Coerce; - --- | A comparator for evaluating attributes. For example, equals, greater than, less than, etc. The following comparison operators are available: @EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN@ The following are descriptions of each comparison operator. * @EQ@ : Equal. @EQ@ is supported for all datatypes, including lists and maps. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @NE@ : Not equal. @NE@ is supported for all datatypes, including lists and maps. /AttributeValueList/ can contain only one /AttributeValue/ of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an /AttributeValue/ of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @LE@ : Less than or equal. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @LT@ : Less than. /AttributeValueList/ can contain only one /AttributeValue/ of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GE@ : Greater than or equal. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GT@ : Greater than. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @NOT_NULL@ : The attribute exists. @NOT_NULL@ is supported for all datatypes, including lists and maps. * @NULL@ : The attribute does not exist. @NULL@ is supported for all datatypes, including lists and maps. * @CONTAINS@ : Checks for a subsequence, or value in a set. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it finds an exact match with any member of the set. CONTAINS is supported for lists: When evaluating "@a CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @NOT_CONTAINS@ : Checks for absence of a subsequence, or absence of a value in a set. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it /does not/ find an exact match with any member of the set. NOT_CONTAINS is supported for lists: When evaluating "@a NOT CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @BEGINS_WITH@ : Checks for a prefix. /AttributeValueList/ can contain only one /AttributeValue/ of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). * @IN@ : Checks for matching elements within two sets. /AttributeValueList/ can contain one or more /AttributeValue/ elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true. * @BETWEEN@ : Greater than or equal to the first value, and less than or equal to the second value. /AttributeValueList/ must contain two /AttributeValue/ elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not compare to @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ For usage examples of /AttributeValueList/ and /ComparisonOperator/ , see in the /Amazon DynamoDB Developer Guide/ . -cComparisonOperator :: Lens' Condition ComparisonOperator -cComparisonOperator = lens _cComparisonOperator (\ s a -> s{_cComparisonOperator = a}); - -instance Hashable Condition - -instance NFData Condition - -instance ToJSON Condition where - toJSON Condition'{..} - = object - (catMaybes - [("AttributeValueList" .=) <$> _cAttributeValueList, - Just ("ComparisonOperator" .= _cComparisonOperator)]) - --- | The capacity units consumed by an 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 request asked for it. For more information, see in the /Amazon DynamoDB Developer Guide/ . --- --- --- --- /See:/ 'consumedCapacity' smart constructor. -data ConsumedCapacity = ConsumedCapacity' - { _ccGlobalSecondaryIndexes :: !(Maybe (Map Text Capacity)) - , _ccCapacityUnits :: !(Maybe Double) - , _ccLocalSecondaryIndexes :: !(Maybe (Map Text Capacity)) - , _ccTable :: !(Maybe Capacity) - , _ccTableName :: !(Maybe Text) - } deriving (Eq,Read,Show,Data,Typeable,Generic) - --- | Creates a value of 'ConsumedCapacity' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'ccGlobalSecondaryIndexes' - The amount of throughput consumed on each global index affected by the operation. --- --- * 'ccCapacityUnits' - The total number of capacity units consumed by the operation. --- --- * 'ccLocalSecondaryIndexes' - The amount of throughput consumed on each local index affected by the operation. --- --- * 'ccTable' - The amount of throughput consumed on the table affected by the operation. --- --- * 'ccTableName' - The name of the table that was affected by the operation. -consumedCapacity - :: ConsumedCapacity -consumedCapacity = - ConsumedCapacity' - { _ccGlobalSecondaryIndexes = Nothing - , _ccCapacityUnits = Nothing - , _ccLocalSecondaryIndexes = Nothing - , _ccTable = Nothing - , _ccTableName = Nothing - } - --- | The amount of throughput consumed on each global index affected by the operation. -ccGlobalSecondaryIndexes :: Lens' ConsumedCapacity (HashMap Text Capacity) -ccGlobalSecondaryIndexes = lens _ccGlobalSecondaryIndexes (\ s a -> s{_ccGlobalSecondaryIndexes = a}) . _Default . _Map; - --- | The total number of capacity units consumed by the operation. -ccCapacityUnits :: Lens' ConsumedCapacity (Maybe Double) -ccCapacityUnits = lens _ccCapacityUnits (\ s a -> s{_ccCapacityUnits = a}); - --- | The amount of throughput consumed on each local index affected by the operation. -ccLocalSecondaryIndexes :: Lens' ConsumedCapacity (HashMap Text Capacity) -ccLocalSecondaryIndexes = lens _ccLocalSecondaryIndexes (\ s a -> s{_ccLocalSecondaryIndexes = a}) . _Default . _Map; - --- | The amount of throughput consumed on the table affected by the operation. -ccTable :: Lens' ConsumedCapacity (Maybe Capacity) -ccTable = lens _ccTable (\ s a -> s{_ccTable = a}); - --- | The name of the table that was affected by the operation. -ccTableName :: Lens' ConsumedCapacity (Maybe Text) -ccTableName = lens _ccTableName (\ s a -> s{_ccTableName = a}); - -instance FromJSON ConsumedCapacity where - parseJSON - = withObject "ConsumedCapacity" - (\ x -> - ConsumedCapacity' <$> - (x .:? "GlobalSecondaryIndexes" .!= mempty) <*> - (x .:? "CapacityUnits") - <*> (x .:? "LocalSecondaryIndexes" .!= mempty) - <*> (x .:? "Table") - <*> (x .:? "TableName")) - -instance Hashable ConsumedCapacity - -instance NFData ConsumedCapacity - --- | Represents a new global secondary index to be added to an existing table. --- --- --- --- /See:/ 'createGlobalSecondaryIndexAction' smart constructor. -data CreateGlobalSecondaryIndexAction = CreateGlobalSecondaryIndexAction' - { _cgsiaIndexName :: !Text - , _cgsiaKeySchema :: !(List1 KeySchemaElement) - , _cgsiaProjection :: !Projection - , _cgsiaProvisionedThroughput :: !ProvisionedThroughput - } deriving (Eq,Read,Show,Data,Typeable,Generic) - --- | Creates a value of 'CreateGlobalSecondaryIndexAction' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'cgsiaIndexName' - The name of the global secondary index to be created. --- --- * 'cgsiaKeySchema' - The key schema for the global secondary index. --- --- * 'cgsiaProjection' - Undocumented member. --- --- * 'cgsiaProvisionedThroughput' - Undocumented member. -createGlobalSecondaryIndexAction - :: Text -- ^ 'cgsiaIndexName' - -> NonEmpty KeySchemaElement -- ^ 'cgsiaKeySchema' - -> Projection -- ^ 'cgsiaProjection' - -> ProvisionedThroughput -- ^ 'cgsiaProvisionedThroughput' - -> CreateGlobalSecondaryIndexAction -createGlobalSecondaryIndexAction pIndexName_ pKeySchema_ pProjection_ pProvisionedThroughput_ = - CreateGlobalSecondaryIndexAction' - { _cgsiaIndexName = pIndexName_ - , _cgsiaKeySchema = _List1 # pKeySchema_ - , _cgsiaProjection = pProjection_ - , _cgsiaProvisionedThroughput = pProvisionedThroughput_ - } - --- | The name of the global secondary index to be created. -cgsiaIndexName :: Lens' CreateGlobalSecondaryIndexAction Text -cgsiaIndexName = lens _cgsiaIndexName (\ s a -> s{_cgsiaIndexName = a}); - --- | The key schema for the global secondary index. -cgsiaKeySchema :: Lens' CreateGlobalSecondaryIndexAction (NonEmpty KeySchemaElement) -cgsiaKeySchema = lens _cgsiaKeySchema (\ s a -> s{_cgsiaKeySchema = a}) . _List1; - --- | Undocumented member. -cgsiaProjection :: Lens' CreateGlobalSecondaryIndexAction Projection -cgsiaProjection = lens _cgsiaProjection (\ s a -> s{_cgsiaProjection = a}); - --- | Undocumented member. -cgsiaProvisionedThroughput :: Lens' CreateGlobalSecondaryIndexAction ProvisionedThroughput -cgsiaProvisionedThroughput = lens _cgsiaProvisionedThroughput (\ s a -> s{_cgsiaProvisionedThroughput = a}); - -instance Hashable CreateGlobalSecondaryIndexAction - -instance NFData CreateGlobalSecondaryIndexAction - -instance ToJSON CreateGlobalSecondaryIndexAction - where - toJSON CreateGlobalSecondaryIndexAction'{..} - = object - (catMaybes - [Just ("IndexName" .= _cgsiaIndexName), - Just ("KeySchema" .= _cgsiaKeySchema), - Just ("Projection" .= _cgsiaProjection), - Just - ("ProvisionedThroughput" .= - _cgsiaProvisionedThroughput)]) - --- | Represents a global secondary index to be deleted from an existing table. --- --- --- --- /See:/ 'deleteGlobalSecondaryIndexAction' smart constructor. -newtype DeleteGlobalSecondaryIndexAction = DeleteGlobalSecondaryIndexAction' - { _dgsiaIndexName :: Text - } deriving (Eq,Read,Show,Data,Typeable,Generic) - --- | Creates a value of 'DeleteGlobalSecondaryIndexAction' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'dgsiaIndexName' - The name of the global secondary index to be deleted. -deleteGlobalSecondaryIndexAction - :: Text -- ^ 'dgsiaIndexName' - -> DeleteGlobalSecondaryIndexAction -deleteGlobalSecondaryIndexAction pIndexName_ = - DeleteGlobalSecondaryIndexAction' - { _dgsiaIndexName = pIndexName_ - } - --- | The name of the global secondary index to be deleted. -dgsiaIndexName :: Lens' DeleteGlobalSecondaryIndexAction Text -dgsiaIndexName = lens _dgsiaIndexName (\ s a -> s{_dgsiaIndexName = a}); - -instance Hashable DeleteGlobalSecondaryIndexAction - -instance NFData DeleteGlobalSecondaryIndexAction - -instance ToJSON DeleteGlobalSecondaryIndexAction - where - toJSON DeleteGlobalSecondaryIndexAction'{..} - = object - (catMaybes [Just ("IndexName" .= _dgsiaIndexName)]) - --- | Represents a request to perform a /DeleteItem/ operation on an item. --- --- --- --- /See:/ 'deleteRequest' smart constructor. -newtype DeleteRequest = DeleteRequest' - { _drKey :: Map Text AttributeValue - } deriving (Eq,Read,Show,Data,Typeable,Generic) - --- | Creates a value of 'DeleteRequest' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'drKey' - A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. -deleteRequest - :: DeleteRequest -deleteRequest = - DeleteRequest' - { _drKey = mempty - } - --- | A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. -drKey :: Lens' DeleteRequest (HashMap Text AttributeValue) -drKey = lens _drKey (\ s a -> s{_drKey = a}) . _Map; - -instance FromJSON DeleteRequest where - parseJSON - = withObject "DeleteRequest" - (\ x -> DeleteRequest' <$> (x .:? "Key" .!= mempty)) - -instance Hashable DeleteRequest - -instance NFData DeleteRequest - -instance ToJSON DeleteRequest where - toJSON DeleteRequest'{..} - = object (catMaybes [Just ("Key" .= _drKey)]) - --- | Represents a condition to be compared with an attribute value. This condition can be used with /DeleteItem/ , /PutItem/ or /UpdateItem/ operations; if the comparison evaluates to true, the operation succeeds; if not, the operation fails. You can use /ExpectedAttributeValue/ in one of two different ways: --- --- --- * Use /AttributeValueList/ to specify one or more values to compare against an attribute. Use /ComparisonOperator/ to specify how you want to perform the comparison. If the comparison evaluates to true, then the conditional operation succeeds. --- --- * Use /Value/ to specify a value that DynamoDB will compare against an attribute. If the values match, then /ExpectedAttributeValue/ evaluates to true and the conditional operation succeeds. Optionally, you can also set /Exists/ to false, indicating that you /do not/ expect to find the attribute value in the table. In this case, the conditional operation succeeds only if the comparison evaluates to false. --- --- --- --- /Value/ and /Exists/ are incompatible with /AttributeValueList/ and /ComparisonOperator/ . Note that if you use both sets of parameters at once, DynamoDB will return a /ValidationException/ exception. --- --- --- /See:/ 'expectedAttributeValue' smart constructor. -data ExpectedAttributeValue = ExpectedAttributeValue' - { _eavAttributeValueList :: !(Maybe [AttributeValue]) - , _eavExists :: !(Maybe Bool) - , _eavValue :: !(Maybe AttributeValue) - , _eavComparisonOperator :: !(Maybe ComparisonOperator) - } deriving (Eq,Read,Show,Data,Typeable,Generic) - --- | Creates a value of 'ExpectedAttributeValue' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'eavAttributeValueList' - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the /ComparisonOperator/ being used. For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, @a@ is greater than @A@ , and @a@ is greater than @B@ . For a list of code values, see . For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. For information on specifying data types in JSON, see in the /Amazon DynamoDB Developer Guide/ . --- --- * 'eavExists' - Causes DynamoDB to evaluate the value before attempting a conditional operation: * If /Exists/ is @true@ , DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a /ConditionalCheckFailedException/ . * If /Exists/ is @false@ , DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a /ConditionalCheckFailedException/ . The default setting for /Exists/ is @true@ . If you supply a /Value/ all by itself, DynamoDB assumes the attribute exists: You don't have to set /Exists/ to @true@ , because it is implied. DynamoDB returns a /ValidationException/ if: * /Exists/ is @true@ but there is no /Value/ to check. (You expect a value to exist, but don't specify what that value is.) * /Exists/ is @false@ but you also provide a /Value/ . (You cannot expect an attribute to have a value, while also expecting it not to exist.) --- --- * 'eavValue' - Undocumented member. --- --- * 'eavComparisonOperator' - A comparator for evaluating attributes in the /AttributeValueList/ . For example, equals, greater than, less than, etc. The following comparison operators are available: @EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN@ The following are descriptions of each comparison operator. * @EQ@ : Equal. @EQ@ is supported for all datatypes, including lists and maps. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @NE@ : Not equal. @NE@ is supported for all datatypes, including lists and maps. /AttributeValueList/ can contain only one /AttributeValue/ of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an /AttributeValue/ of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @LE@ : Less than or equal. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @LT@ : Less than. /AttributeValueList/ can contain only one /AttributeValue/ of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GE@ : Greater than or equal. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GT@ : Greater than. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @NOT_NULL@ : The attribute exists. @NOT_NULL@ is supported for all datatypes, including lists and maps. * @NULL@ : The attribute does not exist. @NULL@ is supported for all datatypes, including lists and maps. * @CONTAINS@ : Checks for a subsequence, or value in a set. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it finds an exact match with any member of the set. CONTAINS is supported for lists: When evaluating "@a CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @NOT_CONTAINS@ : Checks for absence of a subsequence, or absence of a value in a set. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it /does not/ find an exact match with any member of the set. NOT_CONTAINS is supported for lists: When evaluating "@a NOT CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @BEGINS_WITH@ : Checks for a prefix. /AttributeValueList/ can contain only one /AttributeValue/ of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). * @IN@ : Checks for matching elements within two sets. /AttributeValueList/ can contain one or more /AttributeValue/ elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true. * @BETWEEN@ : Greater than or equal to the first value, and less than or equal to the second value. /AttributeValueList/ must contain two /AttributeValue/ elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not compare to @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ -expectedAttributeValue - :: ExpectedAttributeValue -expectedAttributeValue = - ExpectedAttributeValue' - { _eavAttributeValueList = Nothing - , _eavExists = Nothing - , _eavValue = Nothing - , _eavComparisonOperator = Nothing - } - --- | One or more values to evaluate against the supplied attribute. The number of values in the list depends on the /ComparisonOperator/ being used. For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, @a@ is greater than @A@ , and @a@ is greater than @B@ . For a list of code values, see . For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. For information on specifying data types in JSON, see in the /Amazon DynamoDB Developer Guide/ . -eavAttributeValueList :: Lens' ExpectedAttributeValue [AttributeValue] -eavAttributeValueList = lens _eavAttributeValueList (\ s a -> s{_eavAttributeValueList = a}) . _Default . _Coerce; - --- | Causes DynamoDB to evaluate the value before attempting a conditional operation: * If /Exists/ is @true@ , DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a /ConditionalCheckFailedException/ . * If /Exists/ is @false@ , DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a /ConditionalCheckFailedException/ . The default setting for /Exists/ is @true@ . If you supply a /Value/ all by itself, DynamoDB assumes the attribute exists: You don't have to set /Exists/ to @true@ , because it is implied. DynamoDB returns a /ValidationException/ if: * /Exists/ is @true@ but there is no /Value/ to check. (You expect a value to exist, but don't specify what that value is.) * /Exists/ is @false@ but you also provide a /Value/ . (You cannot expect an attribute to have a value, while also expecting it not to exist.) -eavExists :: Lens' ExpectedAttributeValue (Maybe Bool) -eavExists = lens _eavExists (\ s a -> s{_eavExists = a}); - --- | Undocumented member. -eavValue :: Lens' ExpectedAttributeValue (Maybe AttributeValue) -eavValue = lens _eavValue (\ s a -> s{_eavValue = a}); - --- | A comparator for evaluating attributes in the /AttributeValueList/ . For example, equals, greater than, less than, etc. The following comparison operators are available: @EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN@ The following are descriptions of each comparison operator. * @EQ@ : Equal. @EQ@ is supported for all datatypes, including lists and maps. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @NE@ : Not equal. @NE@ is supported for all datatypes, including lists and maps. /AttributeValueList/ can contain only one /AttributeValue/ of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an /AttributeValue/ of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @LE@ : Less than or equal. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @LT@ : Less than. /AttributeValueList/ can contain only one /AttributeValue/ of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GE@ : Greater than or equal. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GT@ : Greater than. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @NOT_NULL@ : The attribute exists. @NOT_NULL@ is supported for all datatypes, including lists and maps. * @NULL@ : The attribute does not exist. @NULL@ is supported for all datatypes, including lists and maps. * @CONTAINS@ : Checks for a subsequence, or value in a set. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it finds an exact match with any member of the set. CONTAINS is supported for lists: When evaluating "@a CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @NOT_CONTAINS@ : Checks for absence of a subsequence, or absence of a value in a set. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it /does not/ find an exact match with any member of the set. NOT_CONTAINS is supported for lists: When evaluating "@a NOT CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @BEGINS_WITH@ : Checks for a prefix. /AttributeValueList/ can contain only one /AttributeValue/ of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). * @IN@ : Checks for matching elements within two sets. /AttributeValueList/ can contain one or more /AttributeValue/ elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true. * @BETWEEN@ : Greater than or equal to the first value, and less than or equal to the second value. /AttributeValueList/ must contain two /AttributeValue/ elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not compare to @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ -eavComparisonOperator :: Lens' ExpectedAttributeValue (Maybe ComparisonOperator) -eavComparisonOperator = lens _eavComparisonOperator (\ s a -> s{_eavComparisonOperator = a}); - -instance Hashable ExpectedAttributeValue - -instance NFData ExpectedAttributeValue - -instance ToJSON ExpectedAttributeValue where - toJSON ExpectedAttributeValue'{..} - = object - (catMaybes - [("AttributeValueList" .=) <$> - _eavAttributeValueList, - ("Exists" .=) <$> _eavExists, - ("Value" .=) <$> _eavValue, - ("ComparisonOperator" .=) <$> - _eavComparisonOperator]) - --- | Represents the properties of a global secondary index. --- --- --- --- /See:/ 'globalSecondaryIndex' smart constructor. -data GlobalSecondaryIndex = GlobalSecondaryIndex' - { _gsiIndexName :: !Text - , _gsiKeySchema :: !(List1 KeySchemaElement) - , _gsiProjection :: !Projection - , _gsiProvisionedThroughput :: !ProvisionedThroughput - } deriving (Eq,Read,Show,Data,Typeable,Generic) - --- | Creates a value of 'GlobalSecondaryIndex' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'gsiIndexName' - The name of the global secondary index. The name must be unique among all other indexes on this table. --- --- * 'gsiKeySchema' - The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: * @HASH@ - partition key * @RANGE@ - sort key --- --- * 'gsiProjection' - Undocumented member. --- --- * 'gsiProvisionedThroughput' - Undocumented member. -globalSecondaryIndex - :: Text -- ^ 'gsiIndexName' - -> NonEmpty KeySchemaElement -- ^ 'gsiKeySchema' - -> Projection -- ^ 'gsiProjection' - -> ProvisionedThroughput -- ^ 'gsiProvisionedThroughput' - -> GlobalSecondaryIndex -globalSecondaryIndex pIndexName_ pKeySchema_ pProjection_ pProvisionedThroughput_ = - GlobalSecondaryIndex' - { _gsiIndexName = pIndexName_ - , _gsiKeySchema = _List1 # pKeySchema_ - , _gsiProjection = pProjection_ - , _gsiProvisionedThroughput = pProvisionedThroughput_ - } - --- | The name of the global secondary index. The name must be unique among all other indexes on this table. -gsiIndexName :: Lens' GlobalSecondaryIndex Text -gsiIndexName = lens _gsiIndexName (\ s a -> s{_gsiIndexName = a}); - --- | The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: * @HASH@ - partition key * @RANGE@ - sort key -gsiKeySchema :: Lens' GlobalSecondaryIndex (NonEmpty KeySchemaElement) -gsiKeySchema = lens _gsiKeySchema (\ s a -> s{_gsiKeySchema = a}) . _List1; - --- | Undocumented member. -gsiProjection :: Lens' GlobalSecondaryIndex Projection -gsiProjection = lens _gsiProjection (\ s a -> s{_gsiProjection = a}); - --- | Undocumented member. -gsiProvisionedThroughput :: Lens' GlobalSecondaryIndex ProvisionedThroughput -gsiProvisionedThroughput = lens _gsiProvisionedThroughput (\ s a -> s{_gsiProvisionedThroughput = a}); - -instance Hashable GlobalSecondaryIndex - -instance NFData GlobalSecondaryIndex - -instance ToJSON GlobalSecondaryIndex where - toJSON GlobalSecondaryIndex'{..} - = object - (catMaybes - [Just ("IndexName" .= _gsiIndexName), - Just ("KeySchema" .= _gsiKeySchema), - Just ("Projection" .= _gsiProjection), - Just - ("ProvisionedThroughput" .= - _gsiProvisionedThroughput)]) - --- | Represents the properties of a global secondary index. --- --- --- --- /See:/ 'globalSecondaryIndexDescription' smart constructor. -data GlobalSecondaryIndexDescription = GlobalSecondaryIndexDescription' - { _gsidBackfilling :: !(Maybe Bool) - , _gsidIndexSizeBytes :: !(Maybe Integer) - , _gsidIndexStatus :: !(Maybe IndexStatus) - , _gsidProvisionedThroughput :: !(Maybe ProvisionedThroughputDescription) - , _gsidIndexARN :: !(Maybe Text) - , _gsidKeySchema :: !(Maybe (List1 KeySchemaElement)) - , _gsidProjection :: !(Maybe Projection) - , _gsidItemCount :: !(Maybe Integer) - , _gsidIndexName :: !(Maybe Text) - } deriving (Eq,Read,Show,Data,Typeable,Generic) - --- | Creates a value of 'GlobalSecondaryIndexDescription' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'gsidBackfilling' - Indicates whether the index is currently backfilling. /Backfilling/ is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and /Backfilling/ is false. --- --- * 'gsidIndexSizeBytes' - The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. --- --- * 'gsidIndexStatus' - The current state of the global secondary index: * /CREATING/ - The index is being created. * /UPDATING/ - The index is being updated. * /DELETING/ - The index is being deleted. * /ACTIVE/ - The index is ready for use. --- --- * 'gsidProvisionedThroughput' - Undocumented member. --- --- * 'gsidIndexARN' - The Amazon Resource Name (ARN) that uniquely identifies the index. --- --- * 'gsidKeySchema' - The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: * @HASH@ - partition key * @RANGE@ - sort key --- --- * 'gsidProjection' - Undocumented member. --- --- * 'gsidItemCount' - The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. --- --- * 'gsidIndexName' - The name of the global secondary index. -globalSecondaryIndexDescription - :: GlobalSecondaryIndexDescription -globalSecondaryIndexDescription = - GlobalSecondaryIndexDescription' - { _gsidBackfilling = Nothing - , _gsidIndexSizeBytes = Nothing - , _gsidIndexStatus = Nothing - , _gsidProvisionedThroughput = Nothing - , _gsidIndexARN = Nothing - , _gsidKeySchema = Nothing - , _gsidProjection = Nothing - , _gsidItemCount = Nothing - , _gsidIndexName = Nothing - } - --- | Indicates whether the index is currently backfilling. /Backfilling/ is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and /Backfilling/ is false. -gsidBackfilling :: Lens' GlobalSecondaryIndexDescription (Maybe Bool) -gsidBackfilling = lens _gsidBackfilling (\ s a -> s{_gsidBackfilling = a}); - --- | The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -gsidIndexSizeBytes :: Lens' GlobalSecondaryIndexDescription (Maybe Integer) -gsidIndexSizeBytes = lens _gsidIndexSizeBytes (\ s a -> s{_gsidIndexSizeBytes = a}); - --- | The current state of the global secondary index: * /CREATING/ - The index is being created. * /UPDATING/ - The index is being updated. * /DELETING/ - The index is being deleted. * /ACTIVE/ - The index is ready for use. -gsidIndexStatus :: Lens' GlobalSecondaryIndexDescription (Maybe IndexStatus) -gsidIndexStatus = lens _gsidIndexStatus (\ s a -> s{_gsidIndexStatus = a}); - --- | Undocumented member. -gsidProvisionedThroughput :: Lens' GlobalSecondaryIndexDescription (Maybe ProvisionedThroughputDescription) -gsidProvisionedThroughput = lens _gsidProvisionedThroughput (\ s a -> s{_gsidProvisionedThroughput = a}); - --- | The Amazon Resource Name (ARN) that uniquely identifies the index. -gsidIndexARN :: Lens' GlobalSecondaryIndexDescription (Maybe Text) -gsidIndexARN = lens _gsidIndexARN (\ s a -> s{_gsidIndexARN = a}); - --- | The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: * @HASH@ - partition key * @RANGE@ - sort key -gsidKeySchema :: Lens' GlobalSecondaryIndexDescription (Maybe (NonEmpty KeySchemaElement)) -gsidKeySchema = lens _gsidKeySchema (\ s a -> s{_gsidKeySchema = a}) . mapping _List1; - --- | Undocumented member. -gsidProjection :: Lens' GlobalSecondaryIndexDescription (Maybe Projection) -gsidProjection = lens _gsidProjection (\ s a -> s{_gsidProjection = a}); - --- | The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -gsidItemCount :: Lens' GlobalSecondaryIndexDescription (Maybe Integer) -gsidItemCount = lens _gsidItemCount (\ s a -> s{_gsidItemCount = a}); - --- | The name of the global secondary index. -gsidIndexName :: Lens' GlobalSecondaryIndexDescription (Maybe Text) -gsidIndexName = lens _gsidIndexName (\ s a -> s{_gsidIndexName = a}); - -instance FromJSON GlobalSecondaryIndexDescription - where - parseJSON - = withObject "GlobalSecondaryIndexDescription" - (\ x -> - GlobalSecondaryIndexDescription' <$> - (x .:? "Backfilling") <*> (x .:? "IndexSizeBytes") - <*> (x .:? "IndexStatus") - <*> (x .:? "ProvisionedThroughput") - <*> (x .:? "IndexArn") - <*> (x .:? "KeySchema") - <*> (x .:? "Projection") - <*> (x .:? "ItemCount") - <*> (x .:? "IndexName")) - -instance Hashable GlobalSecondaryIndexDescription - -instance NFData GlobalSecondaryIndexDescription - --- | Represents one of the following: --- --- --- * A new global secondary index to be added to an existing table. --- --- * New provisioned throughput parameters for an existing global secondary index. --- --- * An existing global secondary index to be removed from an existing table. --- --- --- --- --- /See:/ 'globalSecondaryIndexUpdate' smart constructor. -data GlobalSecondaryIndexUpdate = GlobalSecondaryIndexUpdate' - { _gsiuCreate :: !(Maybe CreateGlobalSecondaryIndexAction) - , _gsiuDelete :: !(Maybe DeleteGlobalSecondaryIndexAction) - , _gsiuUpdate :: !(Maybe UpdateGlobalSecondaryIndexAction) - } deriving (Eq,Read,Show,Data,Typeable,Generic) - --- | Creates a value of 'GlobalSecondaryIndexUpdate' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'gsiuCreate' - The parameters required for creating a global secondary index on an existing table: * @IndexName @ * @KeySchema @ * @AttributeDefinitions @ * @Projection @ * @ProvisionedThroughput @ --- --- * 'gsiuDelete' - The name of an existing global secondary index to be removed. --- --- * 'gsiuUpdate' - The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index. -globalSecondaryIndexUpdate - :: GlobalSecondaryIndexUpdate -globalSecondaryIndexUpdate = - GlobalSecondaryIndexUpdate' - { _gsiuCreate = Nothing - , _gsiuDelete = Nothing - , _gsiuUpdate = Nothing - } - --- | The parameters required for creating a global secondary index on an existing table: * @IndexName @ * @KeySchema @ * @AttributeDefinitions @ * @Projection @ * @ProvisionedThroughput @ -gsiuCreate :: Lens' GlobalSecondaryIndexUpdate (Maybe CreateGlobalSecondaryIndexAction) -gsiuCreate = lens _gsiuCreate (\ s a -> s{_gsiuCreate = a}); - --- | The name of an existing global secondary index to be removed. -gsiuDelete :: Lens' GlobalSecondaryIndexUpdate (Maybe DeleteGlobalSecondaryIndexAction) -gsiuDelete = lens _gsiuDelete (\ s a -> s{_gsiuDelete = a}); - --- | The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index. -gsiuUpdate :: Lens' GlobalSecondaryIndexUpdate (Maybe UpdateGlobalSecondaryIndexAction) -gsiuUpdate = lens _gsiuUpdate (\ s a -> s{_gsiuUpdate = a}); - -instance Hashable GlobalSecondaryIndexUpdate - -instance NFData GlobalSecondaryIndexUpdate - -instance ToJSON GlobalSecondaryIndexUpdate where - toJSON GlobalSecondaryIndexUpdate'{..} - = object - (catMaybes - [("Create" .=) <$> _gsiuCreate, - ("Delete" .=) <$> _gsiuDelete, - ("Update" .=) <$> _gsiuUpdate]) - --- | Information about item collections, if any, that were affected by the operation. /ItemCollectionMetrics/ is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response. --- --- --- --- /See:/ 'itemCollectionMetrics' smart constructor. -data ItemCollectionMetrics = ItemCollectionMetrics' - { _icmItemCollectionKey :: !(Maybe (Map Text AttributeValue)) - , _icmSizeEstimateRangeGB :: !(Maybe [Double]) - } deriving (Eq,Read,Show,Data,Typeable,Generic) - --- | Creates a value of 'ItemCollectionMetrics' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'icmItemCollectionKey' - The partition key value of the item collection. This value is the same as the partition key value of the item. --- --- * 'icmSizeEstimateRangeGB' - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. -itemCollectionMetrics - :: ItemCollectionMetrics -itemCollectionMetrics = - ItemCollectionMetrics' - { _icmItemCollectionKey = Nothing - , _icmSizeEstimateRangeGB = Nothing - } - --- | The partition key value of the item collection. This value is the same as the partition key value of the item. -icmItemCollectionKey :: Lens' ItemCollectionMetrics (HashMap Text AttributeValue) -icmItemCollectionKey = lens _icmItemCollectionKey (\ s a -> s{_icmItemCollectionKey = a}) . _Default . _Map; - --- | An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. -icmSizeEstimateRangeGB :: Lens' ItemCollectionMetrics [Double] -icmSizeEstimateRangeGB = lens _icmSizeEstimateRangeGB (\ s a -> s{_icmSizeEstimateRangeGB = a}) . _Default . _Coerce; - -instance FromJSON ItemCollectionMetrics where - parseJSON - = withObject "ItemCollectionMetrics" - (\ x -> - ItemCollectionMetrics' <$> - (x .:? "ItemCollectionKey" .!= mempty) <*> - (x .:? "SizeEstimateRangeGB" .!= mempty)) - -instance Hashable ItemCollectionMetrics - -instance NFData ItemCollectionMetrics - --- | Represents /a single element/ of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index. --- --- --- A /KeySchemaElement/ represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one /KeySchemaElement/ (for the partition key). A composite primary key would require one /KeySchemaElement/ for the partition key, and another /KeySchemaElement/ for the sort key. --- --- A /KeySchemaElement/ must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map. --- --- --- /See:/ 'keySchemaElement' smart constructor. -data KeySchemaElement = KeySchemaElement' - { _kseAttributeName :: !Text - , _kseKeyType :: !KeyType - } deriving (Eq,Read,Show,Data,Typeable,Generic) - --- | Creates a value of 'KeySchemaElement' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'kseAttributeName' - The name of a key attribute. --- --- * 'kseKeyType' - The role that this key attribute will assume: * @HASH@ - partition key * @RANGE@ - sort key -keySchemaElement - :: Text -- ^ 'kseAttributeName' - -> KeyType -- ^ 'kseKeyType' - -> KeySchemaElement -keySchemaElement pAttributeName_ pKeyType_ = - KeySchemaElement' - { _kseAttributeName = pAttributeName_ - , _kseKeyType = pKeyType_ - } - --- | The name of a key attribute. -kseAttributeName :: Lens' KeySchemaElement Text -kseAttributeName = lens _kseAttributeName (\ s a -> s{_kseAttributeName = a}); - --- | The role that this key attribute will assume: * @HASH@ - partition key * @RANGE@ - sort key -kseKeyType :: Lens' KeySchemaElement KeyType -kseKeyType = lens _kseKeyType (\ s a -> s{_kseKeyType = a}); - -instance FromJSON KeySchemaElement where - parseJSON - = withObject "KeySchemaElement" - (\ x -> - KeySchemaElement' <$> - (x .: "AttributeName") <*> (x .: "KeyType")) - -instance Hashable KeySchemaElement - -instance NFData KeySchemaElement - -instance ToJSON KeySchemaElement where - toJSON KeySchemaElement'{..} - = object - (catMaybes - [Just ("AttributeName" .= _kseAttributeName), - Just ("KeyType" .= _kseKeyType)]) - --- | Represents a set of primary keys and, for each key, the attributes to retrieve from the table. --- --- --- For each primary key, you must provide /all/ of the key attributes. For example, with a simple primary key, you only need to provide the partition key. For a composite primary key, you must provide /both/ the partition key and the sort key. --- --- --- /See:/ 'keysAndAttributes' smart constructor. -data KeysAndAttributes = KeysAndAttributes' - { _kaaProjectionExpression :: !(Maybe Text) - , _kaaAttributesToGet :: !(Maybe (List1 Text)) - , _kaaExpressionAttributeNames :: !(Maybe (Map Text Text)) - , _kaaConsistentRead :: !(Maybe Bool) - , _kaaKeys :: !(List1 (Map Text AttributeValue)) - } deriving (Eq,Read,Show,Data,Typeable,Generic) - --- | Creates a value of 'KeysAndAttributes' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'kaaProjectionExpression' - 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 /ProjectionExpression/ 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 in the /Amazon DynamoDB Developer Guide/ . --- --- * 'kaaAttributesToGet' - One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result. --- --- * 'kaaExpressionAttributeNames' - 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for /ExpressionAttributeNames/ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . --- --- * 'kaaConsistentRead' - The consistency of a read operation. If set to @true@ , then a strongly consistent read is used; otherwise, an eventually consistent read is used. --- --- * 'kaaKeys' - The primary key attribute values that define the items and the attributes associated with the items. -keysAndAttributes - :: NonEmpty (HashMap Text AttributeValue) -- ^ 'kaaKeys' - -> KeysAndAttributes -keysAndAttributes pKeys_ = - KeysAndAttributes' - { _kaaProjectionExpression = Nothing - , _kaaAttributesToGet = Nothing - , _kaaExpressionAttributeNames = Nothing - , _kaaConsistentRead = Nothing - , _kaaKeys = _List1 # pKeys_ - } - --- | 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 /ProjectionExpression/ 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 in the /Amazon DynamoDB Developer Guide/ . -kaaProjectionExpression :: Lens' KeysAndAttributes (Maybe Text) -kaaProjectionExpression = lens _kaaProjectionExpression (\ s a -> s{_kaaProjectionExpression = a}); - --- | One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result. -kaaAttributesToGet :: Lens' KeysAndAttributes (Maybe (NonEmpty Text)) -kaaAttributesToGet = lens _kaaAttributesToGet (\ s a -> s{_kaaAttributesToGet = a}) . mapping _List1; - --- | 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for /ExpressionAttributeNames/ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . -kaaExpressionAttributeNames :: Lens' KeysAndAttributes (HashMap Text Text) -kaaExpressionAttributeNames = lens _kaaExpressionAttributeNames (\ s a -> s{_kaaExpressionAttributeNames = a}) . _Default . _Map; - --- | The consistency of a read operation. If set to @true@ , then a strongly consistent read is used; otherwise, an eventually consistent read is used. -kaaConsistentRead :: Lens' KeysAndAttributes (Maybe Bool) -kaaConsistentRead = lens _kaaConsistentRead (\ s a -> s{_kaaConsistentRead = a}); - --- | The primary key attribute values that define the items and the attributes associated with the items. -kaaKeys :: Lens' KeysAndAttributes (NonEmpty (HashMap Text AttributeValue)) -kaaKeys = lens _kaaKeys (\ s a -> s{_kaaKeys = a}) . _List1; - -instance FromJSON KeysAndAttributes where - parseJSON - = withObject "KeysAndAttributes" - (\ x -> - KeysAndAttributes' <$> - (x .:? "ProjectionExpression") <*> - (x .:? "AttributesToGet") - <*> (x .:? "ExpressionAttributeNames" .!= mempty) - <*> (x .:? "ConsistentRead") - <*> (x .: "Keys")) - -instance Hashable KeysAndAttributes - -instance NFData KeysAndAttributes - -instance ToJSON KeysAndAttributes where - toJSON KeysAndAttributes'{..} - = object - (catMaybes - [("ProjectionExpression" .=) <$> - _kaaProjectionExpression, - ("AttributesToGet" .=) <$> _kaaAttributesToGet, - ("ExpressionAttributeNames" .=) <$> - _kaaExpressionAttributeNames, - ("ConsistentRead" .=) <$> _kaaConsistentRead, - Just ("Keys" .= _kaaKeys)]) - --- | Represents the properties of a local secondary index. --- --- --- --- /See:/ 'localSecondaryIndex' smart constructor. -data LocalSecondaryIndex = LocalSecondaryIndex' - { _lsiIndexName :: !Text - , _lsiKeySchema :: !(List1 KeySchemaElement) - , _lsiProjection :: !Projection - } deriving (Eq,Read,Show,Data,Typeable,Generic) - --- | Creates a value of 'LocalSecondaryIndex' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'lsiIndexName' - The name of the local secondary index. The name must be unique among all other indexes on this table. --- --- * 'lsiKeySchema' - The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: * @HASH@ - partition key * @RANGE@ - sort key --- --- * 'lsiProjection' - Undocumented member. -localSecondaryIndex - :: Text -- ^ 'lsiIndexName' - -> NonEmpty KeySchemaElement -- ^ 'lsiKeySchema' - -> Projection -- ^ 'lsiProjection' - -> LocalSecondaryIndex -localSecondaryIndex pIndexName_ pKeySchema_ pProjection_ = - LocalSecondaryIndex' - { _lsiIndexName = pIndexName_ - , _lsiKeySchema = _List1 # pKeySchema_ - , _lsiProjection = pProjection_ - } - --- | The name of the local secondary index. The name must be unique among all other indexes on this table. -lsiIndexName :: Lens' LocalSecondaryIndex Text -lsiIndexName = lens _lsiIndexName (\ s a -> s{_lsiIndexName = a}); - --- | The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: * @HASH@ - partition key * @RANGE@ - sort key -lsiKeySchema :: Lens' LocalSecondaryIndex (NonEmpty KeySchemaElement) -lsiKeySchema = lens _lsiKeySchema (\ s a -> s{_lsiKeySchema = a}) . _List1; - --- | Undocumented member. -lsiProjection :: Lens' LocalSecondaryIndex Projection -lsiProjection = lens _lsiProjection (\ s a -> s{_lsiProjection = a}); - -instance Hashable LocalSecondaryIndex - -instance NFData LocalSecondaryIndex - -instance ToJSON LocalSecondaryIndex where - toJSON LocalSecondaryIndex'{..} - = object - (catMaybes - [Just ("IndexName" .= _lsiIndexName), - Just ("KeySchema" .= _lsiKeySchema), - Just ("Projection" .= _lsiProjection)]) - --- | Represents the properties of a local secondary index. --- --- --- --- /See:/ 'localSecondaryIndexDescription' smart constructor. -data LocalSecondaryIndexDescription = LocalSecondaryIndexDescription' - { _lsidIndexSizeBytes :: !(Maybe Integer) - , _lsidIndexARN :: !(Maybe Text) - , _lsidKeySchema :: !(Maybe (List1 KeySchemaElement)) - , _lsidProjection :: !(Maybe Projection) - , _lsidItemCount :: !(Maybe Integer) - , _lsidIndexName :: !(Maybe Text) - } deriving (Eq,Read,Show,Data,Typeable,Generic) - --- | Creates a value of 'LocalSecondaryIndexDescription' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'lsidIndexSizeBytes' - The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. --- --- * 'lsidIndexARN' - The Amazon Resource Name (ARN) that uniquely identifies the index. --- --- * 'lsidKeySchema' - The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: * @HASH@ - partition key * @RANGE@ - sort key --- --- * 'lsidProjection' - Undocumented member. --- --- * 'lsidItemCount' - The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. --- --- * 'lsidIndexName' - Represents the name of the local secondary index. -localSecondaryIndexDescription - :: LocalSecondaryIndexDescription -localSecondaryIndexDescription = - LocalSecondaryIndexDescription' - { _lsidIndexSizeBytes = Nothing - , _lsidIndexARN = Nothing - , _lsidKeySchema = Nothing - , _lsidProjection = Nothing - , _lsidItemCount = Nothing - , _lsidIndexName = Nothing - } - --- | The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -lsidIndexSizeBytes :: Lens' LocalSecondaryIndexDescription (Maybe Integer) -lsidIndexSizeBytes = lens _lsidIndexSizeBytes (\ s a -> s{_lsidIndexSizeBytes = a}); - --- | The Amazon Resource Name (ARN) that uniquely identifies the index. -lsidIndexARN :: Lens' LocalSecondaryIndexDescription (Maybe Text) -lsidIndexARN = lens _lsidIndexARN (\ s a -> s{_lsidIndexARN = a}); - --- | The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: * @HASH@ - partition key * @RANGE@ - sort key -lsidKeySchema :: Lens' LocalSecondaryIndexDescription (Maybe (NonEmpty KeySchemaElement)) -lsidKeySchema = lens _lsidKeySchema (\ s a -> s{_lsidKeySchema = a}) . mapping _List1; - --- | Undocumented member. -lsidProjection :: Lens' LocalSecondaryIndexDescription (Maybe Projection) -lsidProjection = lens _lsidProjection (\ s a -> s{_lsidProjection = a}); - --- | The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -lsidItemCount :: Lens' LocalSecondaryIndexDescription (Maybe Integer) -lsidItemCount = lens _lsidItemCount (\ s a -> s{_lsidItemCount = a}); - --- | Represents the name of the local secondary index. -lsidIndexName :: Lens' LocalSecondaryIndexDescription (Maybe Text) -lsidIndexName = lens _lsidIndexName (\ s a -> s{_lsidIndexName = a}); - -instance FromJSON LocalSecondaryIndexDescription - where - parseJSON - = withObject "LocalSecondaryIndexDescription" - (\ x -> - LocalSecondaryIndexDescription' <$> - (x .:? "IndexSizeBytes") <*> (x .:? "IndexArn") <*> - (x .:? "KeySchema") - <*> (x .:? "Projection") - <*> (x .:? "ItemCount") - <*> (x .:? "IndexName")) - -instance Hashable LocalSecondaryIndexDescription - -instance NFData LocalSecondaryIndexDescription - --- | Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. --- --- --- --- /See:/ 'projection' smart constructor. -data Projection = Projection' - { _pProjectionType :: !(Maybe ProjectionType) - , _pNonKeyAttributes :: !(Maybe (List1 Text)) - } deriving (Eq,Read,Show,Data,Typeable,Generic) - --- | Creates a value of 'Projection' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'pProjectionType' - The set of attributes that are projected into the index: * @KEYS_ONLY@ - Only the index and primary keys are projected into the index. * @INCLUDE@ - Only the specified table attributes are projected into the index. The list of projected attributes are in /NonKeyAttributes/ . * @ALL@ - All of the table attributes are projected into the index. --- --- * 'pNonKeyAttributes' - Represents the non-key attribute names which will be projected into the index. For local secondary indexes, the total count of /NonKeyAttributes/ summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. -projection - :: Projection -projection = - Projection' - { _pProjectionType = Nothing - , _pNonKeyAttributes = Nothing - } - --- | The set of attributes that are projected into the index: * @KEYS_ONLY@ - Only the index and primary keys are projected into the index. * @INCLUDE@ - Only the specified table attributes are projected into the index. The list of projected attributes are in /NonKeyAttributes/ . * @ALL@ - All of the table attributes are projected into the index. -pProjectionType :: Lens' Projection (Maybe ProjectionType) -pProjectionType = lens _pProjectionType (\ s a -> s{_pProjectionType = a}); - --- | Represents the non-key attribute names which will be projected into the index. For local secondary indexes, the total count of /NonKeyAttributes/ summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. -pNonKeyAttributes :: Lens' Projection (Maybe (NonEmpty Text)) -pNonKeyAttributes = lens _pNonKeyAttributes (\ s a -> s{_pNonKeyAttributes = a}) . mapping _List1; - -instance FromJSON Projection where - parseJSON - = withObject "Projection" - (\ x -> - Projection' <$> - (x .:? "ProjectionType") <*> - (x .:? "NonKeyAttributes")) - -instance Hashable Projection - -instance NFData Projection - -instance ToJSON Projection where - toJSON Projection'{..} - = object - (catMaybes - [("ProjectionType" .=) <$> _pProjectionType, - ("NonKeyAttributes" .=) <$> _pNonKeyAttributes]) - --- | Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the /UpdateTable/ operation. --- --- --- For current minimum and maximum provisioned throughput values, see in the /Amazon DynamoDB Developer Guide/ . --- --- --- /See:/ 'provisionedThroughput' smart constructor. -data ProvisionedThroughput = ProvisionedThroughput' - { _ptReadCapacityUnits :: !Nat - , _ptWriteCapacityUnits :: !Nat - } deriving (Eq,Read,Show,Data,Typeable,Generic) - --- | Creates a value of 'ProvisionedThroughput' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'ptReadCapacityUnits' - The maximum number of strongly consistent reads consumed per second before DynamoDB returns a /ThrottlingException/ . For more information, see in the /Amazon DynamoDB Developer Guide/ . --- --- * 'ptWriteCapacityUnits' - The maximum number of writes consumed per second before DynamoDB returns a /ThrottlingException/ . For more information, see in the /Amazon DynamoDB Developer Guide/ . -provisionedThroughput - :: Natural -- ^ 'ptReadCapacityUnits' - -> Natural -- ^ 'ptWriteCapacityUnits' - -> ProvisionedThroughput -provisionedThroughput pReadCapacityUnits_ pWriteCapacityUnits_ = - ProvisionedThroughput' - { _ptReadCapacityUnits = _Nat # pReadCapacityUnits_ - , _ptWriteCapacityUnits = _Nat # pWriteCapacityUnits_ - } - --- | The maximum number of strongly consistent reads consumed per second before DynamoDB returns a /ThrottlingException/ . For more information, see in the /Amazon DynamoDB Developer Guide/ . -ptReadCapacityUnits :: Lens' ProvisionedThroughput Natural -ptReadCapacityUnits = lens _ptReadCapacityUnits (\ s a -> s{_ptReadCapacityUnits = a}) . _Nat; - --- | The maximum number of writes consumed per second before DynamoDB returns a /ThrottlingException/ . For more information, see in the /Amazon DynamoDB Developer Guide/ . -ptWriteCapacityUnits :: Lens' ProvisionedThroughput Natural -ptWriteCapacityUnits = lens _ptWriteCapacityUnits (\ s a -> s{_ptWriteCapacityUnits = a}) . _Nat; - -instance Hashable ProvisionedThroughput - -instance NFData ProvisionedThroughput - -instance ToJSON ProvisionedThroughput where - toJSON ProvisionedThroughput'{..} - = object - (catMaybes - [Just ("ReadCapacityUnits" .= _ptReadCapacityUnits), - Just - ("WriteCapacityUnits" .= _ptWriteCapacityUnits)]) - --- | Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases. --- --- --- --- /See:/ 'provisionedThroughputDescription' smart constructor. -data ProvisionedThroughputDescription = ProvisionedThroughputDescription' - { _ptdReadCapacityUnits :: !(Maybe Nat) - , _ptdLastDecreaseDateTime :: !(Maybe POSIX) - , _ptdWriteCapacityUnits :: !(Maybe Nat) - , _ptdNumberOfDecreasesToday :: !(Maybe Nat) - , _ptdLastIncreaseDateTime :: !(Maybe POSIX) - } deriving (Eq,Read,Show,Data,Typeable,Generic) - --- | Creates a value of 'ProvisionedThroughputDescription' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'ptdReadCapacityUnits' - The maximum number of strongly consistent reads consumed per second before DynamoDB returns a /ThrottlingException/ . Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 /ReadCapacityUnits/ per second provides 100 eventually consistent /ReadCapacityUnits/ per second. --- --- * 'ptdLastDecreaseDateTime' - The date and time of the last provisioned throughput decrease for this table. --- --- * 'ptdWriteCapacityUnits' - The maximum number of writes consumed per second before DynamoDB returns a /ThrottlingException/ . --- --- * 'ptdNumberOfDecreasesToday' - The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see in the /Amazon DynamoDB Developer Guide/ . --- --- * 'ptdLastIncreaseDateTime' - The date and time of the last provisioned throughput increase for this table. -provisionedThroughputDescription - :: ProvisionedThroughputDescription -provisionedThroughputDescription = - ProvisionedThroughputDescription' - { _ptdReadCapacityUnits = Nothing - , _ptdLastDecreaseDateTime = Nothing - , _ptdWriteCapacityUnits = Nothing - , _ptdNumberOfDecreasesToday = Nothing - , _ptdLastIncreaseDateTime = Nothing - } - --- | The maximum number of strongly consistent reads consumed per second before DynamoDB returns a /ThrottlingException/ . Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 /ReadCapacityUnits/ per second provides 100 eventually consistent /ReadCapacityUnits/ per second. -ptdReadCapacityUnits :: Lens' ProvisionedThroughputDescription (Maybe Natural) -ptdReadCapacityUnits = lens _ptdReadCapacityUnits (\ s a -> s{_ptdReadCapacityUnits = a}) . mapping _Nat; - --- | The date and time of the last provisioned throughput decrease for this table. -ptdLastDecreaseDateTime :: Lens' ProvisionedThroughputDescription (Maybe UTCTime) -ptdLastDecreaseDateTime = lens _ptdLastDecreaseDateTime (\ s a -> s{_ptdLastDecreaseDateTime = a}) . mapping _Time; - --- | The maximum number of writes consumed per second before DynamoDB returns a /ThrottlingException/ . -ptdWriteCapacityUnits :: Lens' ProvisionedThroughputDescription (Maybe Natural) -ptdWriteCapacityUnits = lens _ptdWriteCapacityUnits (\ s a -> s{_ptdWriteCapacityUnits = a}) . mapping _Nat; - --- | The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see in the /Amazon DynamoDB Developer Guide/ . -ptdNumberOfDecreasesToday :: Lens' ProvisionedThroughputDescription (Maybe Natural) -ptdNumberOfDecreasesToday = lens _ptdNumberOfDecreasesToday (\ s a -> s{_ptdNumberOfDecreasesToday = a}) . mapping _Nat; - --- | The date and time of the last provisioned throughput increase for this table. -ptdLastIncreaseDateTime :: Lens' ProvisionedThroughputDescription (Maybe UTCTime) -ptdLastIncreaseDateTime = lens _ptdLastIncreaseDateTime (\ s a -> s{_ptdLastIncreaseDateTime = a}) . mapping _Time; - -instance FromJSON ProvisionedThroughputDescription - where - parseJSON - = withObject "ProvisionedThroughputDescription" - (\ x -> - ProvisionedThroughputDescription' <$> - (x .:? "ReadCapacityUnits") <*> - (x .:? "LastDecreaseDateTime") - <*> (x .:? "WriteCapacityUnits") - <*> (x .:? "NumberOfDecreasesToday") - <*> (x .:? "LastIncreaseDateTime")) - -instance Hashable ProvisionedThroughputDescription - -instance NFData ProvisionedThroughputDescription - --- | Represents a request to perform a /PutItem/ operation on an item. --- --- --- --- /See:/ 'putRequest' smart constructor. -newtype PutRequest = PutRequest' - { _prItem :: Map Text AttributeValue - } deriving (Eq,Read,Show,Data,Typeable,Generic) - --- | Creates a value of 'PutRequest' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'prItem' - A map of attribute name to attribute values, representing the primary key of an item to be processed by /PutItem/ . All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item which are part of an index key schema for the table, their types must match the index key schema. -putRequest - :: PutRequest -putRequest = - PutRequest' - { _prItem = mempty - } - --- | A map of attribute name to attribute values, representing the primary key of an item to be processed by /PutItem/ . All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item which are part of an index key schema for the table, their types must match the index key schema. -prItem :: Lens' PutRequest (HashMap Text AttributeValue) -prItem = lens _prItem (\ s a -> s{_prItem = a}) . _Map; - -instance FromJSON PutRequest where - parseJSON - = withObject "PutRequest" - (\ x -> PutRequest' <$> (x .:? "Item" .!= mempty)) - -instance Hashable PutRequest - -instance NFData PutRequest - -instance ToJSON PutRequest where - toJSON PutRequest'{..} - = object (catMaybes [Just ("Item" .= _prItem)]) - --- | Represents the DynamoDB Streams configuration for a table in DynamoDB. --- --- --- --- /See:/ 'streamSpecification' smart constructor. -data StreamSpecification = StreamSpecification' - { _ssStreamViewType :: !(Maybe StreamViewType) - , _ssStreamEnabled :: !(Maybe Bool) - } deriving (Eq,Read,Show,Data,Typeable,Generic) - --- | Creates a value of 'StreamSpecification' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'ssStreamViewType' - The DynamoDB Streams settings for the table. These settings consist of: * /StreamEnabled/ - Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table. * /StreamViewType/ - When an item in the table is modified, /StreamViewType/ determines what information is written to the stream for this table. Valid values for /StreamViewType/ are: * /KEYS_ONLY/ - Only the key attributes of the modified item are written to the stream. * /NEW_IMAGE/ - The entire item, as it appears after it was modified, is written to the stream. * /OLD_IMAGE/ - The entire item, as it appeared before it was modified, is written to the stream. * /NEW_AND_OLD_IMAGES/ - Both the new and the old item images of the item are written to the stream. --- --- * 'ssStreamEnabled' - Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table. -streamSpecification - :: StreamSpecification -streamSpecification = - StreamSpecification' - { _ssStreamViewType = Nothing - , _ssStreamEnabled = Nothing - } - --- | The DynamoDB Streams settings for the table. These settings consist of: * /StreamEnabled/ - Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table. * /StreamViewType/ - When an item in the table is modified, /StreamViewType/ determines what information is written to the stream for this table. Valid values for /StreamViewType/ are: * /KEYS_ONLY/ - Only the key attributes of the modified item are written to the stream. * /NEW_IMAGE/ - The entire item, as it appears after it was modified, is written to the stream. * /OLD_IMAGE/ - The entire item, as it appeared before it was modified, is written to the stream. * /NEW_AND_OLD_IMAGES/ - Both the new and the old item images of the item are written to the stream. -ssStreamViewType :: Lens' StreamSpecification (Maybe StreamViewType) -ssStreamViewType = lens _ssStreamViewType (\ s a -> s{_ssStreamViewType = a}); - --- | Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table. -ssStreamEnabled :: Lens' StreamSpecification (Maybe Bool) -ssStreamEnabled = lens _ssStreamEnabled (\ s a -> s{_ssStreamEnabled = a}); - -instance FromJSON StreamSpecification where - parseJSON - = withObject "StreamSpecification" - (\ x -> - StreamSpecification' <$> - (x .:? "StreamViewType") <*> (x .:? "StreamEnabled")) - -instance Hashable StreamSpecification - -instance NFData StreamSpecification - -instance ToJSON StreamSpecification where - toJSON StreamSpecification'{..} - = object - (catMaybes - [("StreamViewType" .=) <$> _ssStreamViewType, - ("StreamEnabled" .=) <$> _ssStreamEnabled]) - --- | Represents the properties of a table. --- --- --- --- /See:/ 'tableDescription' smart constructor. -data TableDescription = TableDescription' - { _tdTableSizeBytes :: !(Maybe Integer) - , _tdAttributeDefinitions :: !(Maybe [AttributeDefinition]) - , _tdLatestStreamARN :: !(Maybe Text) - , _tdProvisionedThroughput :: !(Maybe ProvisionedThroughputDescription) - , _tdTableStatus :: !(Maybe TableStatus) - , _tdTableARN :: !(Maybe Text) - , _tdKeySchema :: !(Maybe (List1 KeySchemaElement)) - , _tdGlobalSecondaryIndexes :: !(Maybe [GlobalSecondaryIndexDescription]) - , _tdLatestStreamLabel :: !(Maybe Text) - , _tdLocalSecondaryIndexes :: !(Maybe [LocalSecondaryIndexDescription]) - , _tdCreationDateTime :: !(Maybe POSIX) - , _tdItemCount :: !(Maybe Integer) - , _tdTableName :: !(Maybe Text) - , _tdStreamSpecification :: !(Maybe StreamSpecification) - } deriving (Eq,Read,Show,Data,Typeable,Generic) - --- | Creates a value of 'TableDescription' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'tdTableSizeBytes' - The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. --- --- * 'tdAttributeDefinitions' - An array of /AttributeDefinition/ objects. Each of these objects describes one attribute in the table and index key schema. Each /AttributeDefinition/ object in this array is composed of: * /AttributeName/ - The name of the attribute. * /AttributeType/ - The data type for the attribute. --- --- * 'tdLatestStreamARN' - The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table. --- --- * 'tdProvisionedThroughput' - The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases. --- --- * 'tdTableStatus' - The current state of the table: * /CREATING/ - The table is being created. * /UPDATING/ - The table is being updated. * /DELETING/ - The table is being deleted. * /ACTIVE/ - The table is ready for use. --- --- * 'tdTableARN' - The Amazon Resource Name (ARN) that uniquely identifies the table. --- --- * 'tdKeySchema' - The primary key structure for the table. Each /KeySchemaElement/ consists of: * /AttributeName/ - The name of the attribute. * /KeyType/ - The role of the attribute: * @HASH@ - partition key * @RANGE@ - sort key For more information about primary keys, see in the /Amazon DynamoDB Developer Guide/ . --- --- * 'tdGlobalSecondaryIndexes' - The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of: * /Backfilling/ - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table; it is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a /CreateTable/ operation.) * /IndexName/ - The name of the global secondary index. * /IndexSizeBytes/ - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. * /IndexStatus/ - The current status of the global secondary index: * /CREATING/ - The index is being created. * /UPDATING/ - The index is being updated. * /DELETING/ - The index is being deleted. * /ACTIVE/ - The index is ready for use. * /ItemCount/ - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. * /KeySchema/ - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table. * /Projection/ - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: * /ProjectionType/ - One of the following: * @KEYS_ONLY@ - Only the index and primary keys are projected into the index. * @INCLUDE@ - Only the specified table attributes are projected into the index. The list of projected attributes are in /NonKeyAttributes/ . * @ALL@ - All of the table attributes are projected into the index. * /NonKeyAttributes/ - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in /NonKeyAttributes/ , summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. * /ProvisionedThroughput/ - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases. If the table is in the @DELETING@ state, no information about indexes will be returned. --- --- * 'tdLatestStreamLabel' - A timestamp, in ISO 8601 format, for this stream. Note that /LatestStreamLabel/ is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique: * the AWS customer ID. * the table name. * the /StreamLabel/ . --- --- * 'tdLocalSecondaryIndexes' - Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of: * /IndexName/ - The name of the local secondary index. * /KeySchema/ - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table. * /Projection/ - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: * /ProjectionType/ - One of the following: * @KEYS_ONLY@ - Only the index and primary keys are projected into the index. * @INCLUDE@ - Only the specified table attributes are projected into the index. The list of projected attributes are in /NonKeyAttributes/ . * @ALL@ - All of the table attributes are projected into the index. * /NonKeyAttributes/ - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in /NonKeyAttributes/ , summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. * /IndexSizeBytes/ - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. * /ItemCount/ - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. If the table is in the @DELETING@ state, no information about indexes will be returned. --- --- * 'tdCreationDateTime' - The date and time when the table was created, in format. --- --- * 'tdItemCount' - The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. --- --- * 'tdTableName' - The name of the table. --- --- * 'tdStreamSpecification' - The current DynamoDB Streams configuration for the table. -tableDescription - :: TableDescription -tableDescription = - TableDescription' - { _tdTableSizeBytes = Nothing - , _tdAttributeDefinitions = Nothing - , _tdLatestStreamARN = Nothing - , _tdProvisionedThroughput = Nothing - , _tdTableStatus = Nothing - , _tdTableARN = Nothing - , _tdKeySchema = Nothing - , _tdGlobalSecondaryIndexes = Nothing - , _tdLatestStreamLabel = Nothing - , _tdLocalSecondaryIndexes = Nothing - , _tdCreationDateTime = Nothing - , _tdItemCount = Nothing - , _tdTableName = Nothing - , _tdStreamSpecification = Nothing - } - --- | The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -tdTableSizeBytes :: Lens' TableDescription (Maybe Integer) -tdTableSizeBytes = lens _tdTableSizeBytes (\ s a -> s{_tdTableSizeBytes = a}); - --- | An array of /AttributeDefinition/ objects. Each of these objects describes one attribute in the table and index key schema. Each /AttributeDefinition/ object in this array is composed of: * /AttributeName/ - The name of the attribute. * /AttributeType/ - The data type for the attribute. -tdAttributeDefinitions :: Lens' TableDescription [AttributeDefinition] -tdAttributeDefinitions = lens _tdAttributeDefinitions (\ s a -> s{_tdAttributeDefinitions = a}) . _Default . _Coerce; - --- | The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table. -tdLatestStreamARN :: Lens' TableDescription (Maybe Text) -tdLatestStreamARN = lens _tdLatestStreamARN (\ s a -> s{_tdLatestStreamARN = a}); - --- | The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases. -tdProvisionedThroughput :: Lens' TableDescription (Maybe ProvisionedThroughputDescription) -tdProvisionedThroughput = lens _tdProvisionedThroughput (\ s a -> s{_tdProvisionedThroughput = a}); - --- | The current state of the table: * /CREATING/ - The table is being created. * /UPDATING/ - The table is being updated. * /DELETING/ - The table is being deleted. * /ACTIVE/ - The table is ready for use. -tdTableStatus :: Lens' TableDescription (Maybe TableStatus) -tdTableStatus = lens _tdTableStatus (\ s a -> s{_tdTableStatus = a}); - --- | The Amazon Resource Name (ARN) that uniquely identifies the table. -tdTableARN :: Lens' TableDescription (Maybe Text) -tdTableARN = lens _tdTableARN (\ s a -> s{_tdTableARN = a}); - --- | The primary key structure for the table. Each /KeySchemaElement/ consists of: * /AttributeName/ - The name of the attribute. * /KeyType/ - The role of the attribute: * @HASH@ - partition key * @RANGE@ - sort key For more information about primary keys, see in the /Amazon DynamoDB Developer Guide/ . -tdKeySchema :: Lens' TableDescription (Maybe (NonEmpty KeySchemaElement)) -tdKeySchema = lens _tdKeySchema (\ s a -> s{_tdKeySchema = a}) . mapping _List1; - --- | The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of: * /Backfilling/ - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table; it is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a /CreateTable/ operation.) * /IndexName/ - The name of the global secondary index. * /IndexSizeBytes/ - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. * /IndexStatus/ - The current status of the global secondary index: * /CREATING/ - The index is being created. * /UPDATING/ - The index is being updated. * /DELETING/ - The index is being deleted. * /ACTIVE/ - The index is ready for use. * /ItemCount/ - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. * /KeySchema/ - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table. * /Projection/ - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: * /ProjectionType/ - One of the following: * @KEYS_ONLY@ - Only the index and primary keys are projected into the index. * @INCLUDE@ - Only the specified table attributes are projected into the index. The list of projected attributes are in /NonKeyAttributes/ . * @ALL@ - All of the table attributes are projected into the index. * /NonKeyAttributes/ - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in /NonKeyAttributes/ , summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. * /ProvisionedThroughput/ - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases. If the table is in the @DELETING@ state, no information about indexes will be returned. -tdGlobalSecondaryIndexes :: Lens' TableDescription [GlobalSecondaryIndexDescription] -tdGlobalSecondaryIndexes = lens _tdGlobalSecondaryIndexes (\ s a -> s{_tdGlobalSecondaryIndexes = a}) . _Default . _Coerce; - --- | A timestamp, in ISO 8601 format, for this stream. Note that /LatestStreamLabel/ is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique: * the AWS customer ID. * the table name. * the /StreamLabel/ . -tdLatestStreamLabel :: Lens' TableDescription (Maybe Text) -tdLatestStreamLabel = lens _tdLatestStreamLabel (\ s a -> s{_tdLatestStreamLabel = a}); - --- | Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of: * /IndexName/ - The name of the local secondary index. * /KeySchema/ - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table. * /Projection/ - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: * /ProjectionType/ - One of the following: * @KEYS_ONLY@ - Only the index and primary keys are projected into the index. * @INCLUDE@ - Only the specified table attributes are projected into the index. The list of projected attributes are in /NonKeyAttributes/ . * @ALL@ - All of the table attributes are projected into the index. * /NonKeyAttributes/ - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in /NonKeyAttributes/ , summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. * /IndexSizeBytes/ - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. * /ItemCount/ - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. If the table is in the @DELETING@ state, no information about indexes will be returned. -tdLocalSecondaryIndexes :: Lens' TableDescription [LocalSecondaryIndexDescription] -tdLocalSecondaryIndexes = lens _tdLocalSecondaryIndexes (\ s a -> s{_tdLocalSecondaryIndexes = a}) . _Default . _Coerce; - --- | The date and time when the table was created, in format. -tdCreationDateTime :: Lens' TableDescription (Maybe UTCTime) -tdCreationDateTime = lens _tdCreationDateTime (\ s a -> s{_tdCreationDateTime = a}) . mapping _Time; - --- | The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -tdItemCount :: Lens' TableDescription (Maybe Integer) -tdItemCount = lens _tdItemCount (\ s a -> s{_tdItemCount = a}); - --- | The name of the table. -tdTableName :: Lens' TableDescription (Maybe Text) -tdTableName = lens _tdTableName (\ s a -> s{_tdTableName = a}); - --- | The current DynamoDB Streams configuration for the table. -tdStreamSpecification :: Lens' TableDescription (Maybe StreamSpecification) -tdStreamSpecification = lens _tdStreamSpecification (\ s a -> s{_tdStreamSpecification = a}); - -instance FromJSON TableDescription where - parseJSON - = withObject "TableDescription" - (\ x -> - TableDescription' <$> - (x .:? "TableSizeBytes") <*> - (x .:? "AttributeDefinitions" .!= mempty) - <*> (x .:? "LatestStreamArn") - <*> (x .:? "ProvisionedThroughput") - <*> (x .:? "TableStatus") - <*> (x .:? "TableArn") - <*> (x .:? "KeySchema") - <*> (x .:? "GlobalSecondaryIndexes" .!= mempty) - <*> (x .:? "LatestStreamLabel") - <*> (x .:? "LocalSecondaryIndexes" .!= mempty) - <*> (x .:? "CreationDateTime") - <*> (x .:? "ItemCount") - <*> (x .:? "TableName") - <*> (x .:? "StreamSpecification")) - -instance Hashable TableDescription - -instance NFData TableDescription - --- | Represents the new provisioned throughput settings to be applied to a global secondary index. --- --- --- --- /See:/ 'updateGlobalSecondaryIndexAction' smart constructor. -data UpdateGlobalSecondaryIndexAction = UpdateGlobalSecondaryIndexAction' - { _ugsiaIndexName :: !Text - , _ugsiaProvisionedThroughput :: !ProvisionedThroughput - } deriving (Eq,Read,Show,Data,Typeable,Generic) - --- | Creates a value of 'UpdateGlobalSecondaryIndexAction' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'ugsiaIndexName' - The name of the global secondary index to be updated. --- --- * 'ugsiaProvisionedThroughput' - Undocumented member. -updateGlobalSecondaryIndexAction - :: Text -- ^ 'ugsiaIndexName' - -> ProvisionedThroughput -- ^ 'ugsiaProvisionedThroughput' - -> UpdateGlobalSecondaryIndexAction -updateGlobalSecondaryIndexAction pIndexName_ pProvisionedThroughput_ = - UpdateGlobalSecondaryIndexAction' - { _ugsiaIndexName = pIndexName_ - , _ugsiaProvisionedThroughput = pProvisionedThroughput_ - } - --- | The name of the global secondary index to be updated. -ugsiaIndexName :: Lens' UpdateGlobalSecondaryIndexAction Text -ugsiaIndexName = lens _ugsiaIndexName (\ s a -> s{_ugsiaIndexName = a}); - --- | Undocumented member. -ugsiaProvisionedThroughput :: Lens' UpdateGlobalSecondaryIndexAction ProvisionedThroughput -ugsiaProvisionedThroughput = lens _ugsiaProvisionedThroughput (\ s a -> s{_ugsiaProvisionedThroughput = a}); - -instance Hashable UpdateGlobalSecondaryIndexAction - -instance NFData UpdateGlobalSecondaryIndexAction - -instance ToJSON UpdateGlobalSecondaryIndexAction - where - toJSON UpdateGlobalSecondaryIndexAction'{..} - = object - (catMaybes - [Just ("IndexName" .= _ugsiaIndexName), - Just - ("ProvisionedThroughput" .= - _ugsiaProvisionedThroughput)]) - --- | Represents an operation to perform - either /DeleteItem/ or /PutItem/ . You can only request one of these operations, not both, in a single /WriteRequest/ . If you do need to perform both of these operations, you will need to provide two separate /WriteRequest/ objects. --- --- --- --- /See:/ 'writeRequest' smart constructor. -data WriteRequest = WriteRequest' - { _wrDeleteRequest :: !(Maybe DeleteRequest) - , _wrPutRequest :: !(Maybe PutRequest) - } deriving (Eq,Read,Show,Data,Typeable,Generic) - --- | Creates a value of 'WriteRequest' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'wrDeleteRequest' - A request to perform a /DeleteItem/ operation. --- --- * 'wrPutRequest' - A request to perform a /PutItem/ operation. -writeRequest - :: WriteRequest -writeRequest = - WriteRequest' - { _wrDeleteRequest = Nothing - , _wrPutRequest = Nothing - } - --- | A request to perform a /DeleteItem/ operation. -wrDeleteRequest :: Lens' WriteRequest (Maybe DeleteRequest) -wrDeleteRequest = lens _wrDeleteRequest (\ s a -> s{_wrDeleteRequest = a}); - --- | A request to perform a /PutItem/ operation. -wrPutRequest :: Lens' WriteRequest (Maybe PutRequest) -wrPutRequest = lens _wrPutRequest (\ s a -> s{_wrPutRequest = a}); - -instance FromJSON WriteRequest where - parseJSON - = withObject "WriteRequest" - (\ x -> - WriteRequest' <$> - (x .:? "DeleteRequest") <*> (x .:? "PutRequest")) - -instance Hashable WriteRequest - -instance NFData WriteRequest +-- Copyright : (c) 2013-2017 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +module Network.AWS.DynamoDB.Types.Product where + +import Network.AWS.DynamoDB.Types.Sum +import Network.AWS.Lens +import Network.AWS.Prelude + +-- | Represents an attribute for describing the key schema for the table and indexes. +-- +-- +-- +-- /See:/ 'attributeDefinition' smart constructor. +data AttributeDefinition = AttributeDefinition' + { _adAttributeName :: !Text + , _adAttributeType :: !ScalarAttributeType + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'AttributeDefinition' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'adAttributeName' - A name for the attribute. +-- +-- * 'adAttributeType' - The data type for the attribute, where: * @S@ - the attribute is of type String * @N@ - the attribute is of type Number * @B@ - the attribute is of type Binary +attributeDefinition + :: Text -- ^ 'adAttributeName' + -> ScalarAttributeType -- ^ 'adAttributeType' + -> AttributeDefinition +attributeDefinition pAttributeName_ pAttributeType_ = + AttributeDefinition' + {_adAttributeName = pAttributeName_, _adAttributeType = pAttributeType_} + + +-- | A name for the attribute. +adAttributeName :: Lens' AttributeDefinition Text +adAttributeName = lens _adAttributeName (\ s a -> s{_adAttributeName = a}); + +-- | The data type for the attribute, where: * @S@ - the attribute is of type String * @N@ - the attribute is of type Number * @B@ - the attribute is of type Binary +adAttributeType :: Lens' AttributeDefinition ScalarAttributeType +adAttributeType = lens _adAttributeType (\ s a -> s{_adAttributeType = a}); + +instance FromJSON AttributeDefinition where + parseJSON + = withObject "AttributeDefinition" + (\ x -> + AttributeDefinition' <$> + (x .: "AttributeName") <*> (x .: "AttributeType")) + +instance Hashable AttributeDefinition where + +instance NFData AttributeDefinition where + +instance ToJSON AttributeDefinition where + toJSON AttributeDefinition'{..} + = object + (catMaybes + [Just ("AttributeName" .= _adAttributeName), + Just ("AttributeType" .= _adAttributeType)]) + +-- | Represents the data for an attribute. +-- +-- +-- Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. +-- +-- For more information, see in the /Amazon DynamoDB Developer Guide/ . +-- +-- +-- /See:/ 'attributeValue' smart constructor. +data AttributeValue = AttributeValue' + { _avL :: !(Maybe [AttributeValue]) + , _avNS :: !(Maybe [Text]) + , _avM :: !(Maybe (Map Text AttributeValue)) + , _avNULL :: !(Maybe Bool) + , _avN :: !(Maybe Text) + , _avBS :: !(Maybe [Base64]) + , _avB :: !(Maybe Base64) + , _avSS :: !(Maybe [Text]) + , _avS :: !(Maybe Text) + , _avBOOL :: !(Maybe Bool) + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'AttributeValue' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'avL' - An attribute of type List. For example: @"L": ["Cookies", "Coffee", 3.14159]@ +-- +-- * 'avNS' - An attribute of type Number Set. For example: @"NS": ["42.2", "-19", "7.5", "3.14"]@ Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. +-- +-- * 'avM' - An attribute of type Map. For example: @"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}@ +-- +-- * 'avNULL' - An attribute of type Null. For example: @"NULL": true@ +-- +-- * 'avN' - An attribute of type Number. For example: @"N": "123.45"@ Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. +-- +-- * 'avBS' - An attribute of type Binary Set. For example: @"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]@ +-- +-- * 'avB' - An attribute of type Binary. For example: @"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"@ -- /Note:/ This 'Lens' automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This 'Lens' accepts and returns only raw unencoded data. +-- +-- * 'avSS' - An attribute of type String Set. For example: @"SS": ["Giraffe", "Hippo" ,"Zebra"]@ +-- +-- * 'avS' - An attribute of type String. For example: @"S": "Hello"@ +-- +-- * 'avBOOL' - An attribute of type Boolean. For example: @"BOOL": true@ +attributeValue + :: AttributeValue +attributeValue = + AttributeValue' + { _avL = Nothing + , _avNS = Nothing + , _avM = Nothing + , _avNULL = Nothing + , _avN = Nothing + , _avBS = Nothing + , _avB = Nothing + , _avSS = Nothing + , _avS = Nothing + , _avBOOL = Nothing + } + + +-- | An attribute of type List. For example: @"L": ["Cookies", "Coffee", 3.14159]@ +avL :: Lens' AttributeValue [AttributeValue] +avL = lens _avL (\ s a -> s{_avL = a}) . _Default . _Coerce; + +-- | An attribute of type Number Set. For example: @"NS": ["42.2", "-19", "7.5", "3.14"]@ Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. +avNS :: Lens' AttributeValue [Text] +avNS = lens _avNS (\ s a -> s{_avNS = a}) . _Default . _Coerce; + +-- | An attribute of type Map. For example: @"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}@ +avM :: Lens' AttributeValue (HashMap Text AttributeValue) +avM = lens _avM (\ s a -> s{_avM = a}) . _Default . _Map; + +-- | An attribute of type Null. For example: @"NULL": true@ +avNULL :: Lens' AttributeValue (Maybe Bool) +avNULL = lens _avNULL (\ s a -> s{_avNULL = a}); + +-- | An attribute of type Number. For example: @"N": "123.45"@ Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations. +avN :: Lens' AttributeValue (Maybe Text) +avN = lens _avN (\ s a -> s{_avN = a}); + +-- | An attribute of type Binary Set. For example: @"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]@ +avBS :: Lens' AttributeValue [ByteString] +avBS = lens _avBS (\ s a -> s{_avBS = a}) . _Default . _Coerce; + +-- | An attribute of type Binary. For example: @"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"@ -- /Note:/ This 'Lens' automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This 'Lens' accepts and returns only raw unencoded data. +avB :: Lens' AttributeValue (Maybe ByteString) +avB = lens _avB (\ s a -> s{_avB = a}) . mapping _Base64; + +-- | An attribute of type String Set. For example: @"SS": ["Giraffe", "Hippo" ,"Zebra"]@ +avSS :: Lens' AttributeValue [Text] +avSS = lens _avSS (\ s a -> s{_avSS = a}) . _Default . _Coerce; + +-- | An attribute of type String. For example: @"S": "Hello"@ +avS :: Lens' AttributeValue (Maybe Text) +avS = lens _avS (\ s a -> s{_avS = a}); + +-- | An attribute of type Boolean. For example: @"BOOL": true@ +avBOOL :: Lens' AttributeValue (Maybe Bool) +avBOOL = lens _avBOOL (\ s a -> s{_avBOOL = a}); + +instance FromJSON AttributeValue where + parseJSON + = withObject "AttributeValue" + (\ x -> + AttributeValue' <$> + (x .:? "L" .!= mempty) <*> (x .:? "NS" .!= mempty) + <*> (x .:? "M" .!= mempty) + <*> (x .:? "NULL") + <*> (x .:? "N") + <*> (x .:? "BS" .!= mempty) + <*> (x .:? "B") + <*> (x .:? "SS" .!= mempty) + <*> (x .:? "S") + <*> (x .:? "BOOL")) + +instance Hashable AttributeValue where + +instance NFData AttributeValue where + +instance ToJSON AttributeValue where + toJSON AttributeValue'{..} + = object + (catMaybes + [("L" .=) <$> _avL, ("NS" .=) <$> _avNS, + ("M" .=) <$> _avM, ("NULL" .=) <$> _avNULL, + ("N" .=) <$> _avN, ("BS" .=) <$> _avBS, + ("B" .=) <$> _avB, ("SS" .=) <$> _avSS, + ("S" .=) <$> _avS, ("BOOL" .=) <$> _avBOOL]) + +-- | For the @UpdateItem@ operation, represents the attributes to be modified, the action to perform on each, and the new value for each. +-- +-- +-- Attribute values cannot be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests with empty values will be rejected with a @ValidationException@ exception. +-- +-- +-- /See:/ 'attributeValueUpdate' smart constructor. +data AttributeValueUpdate = AttributeValueUpdate' + { _avuValue :: !(Maybe AttributeValue) + , _avuAction :: !(Maybe AttributeAction) + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'AttributeValueUpdate' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'avuValue' - Represents the data for an attribute. Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. For more information, see in the /Amazon DynamoDB Developer Guide/ . +-- +-- * 'avuAction' - Specifies how to perform the update. Valid values are @PUT@ (default), @DELETE@ , and @ADD@ . The behavior depends on whether the specified primary key already exists in the table. __If an item with the specified /Key/ is found in the table:__ * @PUT@ - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. * @DELETE@ - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type. If a /set/ of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set @[a,b,c]@ and the @DELETE@ action specified @[a,c]@ , then the final attribute value would be @[b]@ . Specifying an empty set is an error. * @ADD@ - If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior of @ADD@ depends on the data type of the attribute: * If the existing attribute is a number, and if @Value@ is also a number, then the @Value@ is mathematically added to the existing attribute. If @Value@ is a negative number, then it is subtracted from the existing attribute. * If the existing data type is a set, and if the @Value@ is also a set, then the @Value@ is added to the existing set. (This is a /set/ operation, not mathematical addition.) For example, if the attribute value was the set @[1,2]@ , and the @ADD@ action specified @[3]@ , then the final attribute value would be @[1,2,3]@ . An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the @Value@ must also be a set of strings. The same holds true for number sets and binary sets. This action is only valid for an existing attribute whose data type is number or is a set. Do not use @ADD@ for any other data types. __If no item with the specified /Key/ is found:__ * @PUT@ - DynamoDB creates a new item with the specified primary key, and then adds the attribute. * @DELETE@ - Nothing happens; there is no attribute to delete. * @ADD@ - DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified. +attributeValueUpdate + :: AttributeValueUpdate +attributeValueUpdate = + AttributeValueUpdate' {_avuValue = Nothing, _avuAction = Nothing} + + +-- | Represents the data for an attribute. Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. For more information, see in the /Amazon DynamoDB Developer Guide/ . +avuValue :: Lens' AttributeValueUpdate (Maybe AttributeValue) +avuValue = lens _avuValue (\ s a -> s{_avuValue = a}); + +-- | Specifies how to perform the update. Valid values are @PUT@ (default), @DELETE@ , and @ADD@ . The behavior depends on whether the specified primary key already exists in the table. __If an item with the specified /Key/ is found in the table:__ * @PUT@ - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. * @DELETE@ - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type. If a /set/ of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set @[a,b,c]@ and the @DELETE@ action specified @[a,c]@ , then the final attribute value would be @[b]@ . Specifying an empty set is an error. * @ADD@ - If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior of @ADD@ depends on the data type of the attribute: * If the existing attribute is a number, and if @Value@ is also a number, then the @Value@ is mathematically added to the existing attribute. If @Value@ is a negative number, then it is subtracted from the existing attribute. * If the existing data type is a set, and if the @Value@ is also a set, then the @Value@ is added to the existing set. (This is a /set/ operation, not mathematical addition.) For example, if the attribute value was the set @[1,2]@ , and the @ADD@ action specified @[3]@ , then the final attribute value would be @[1,2,3]@ . An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the @Value@ must also be a set of strings. The same holds true for number sets and binary sets. This action is only valid for an existing attribute whose data type is number or is a set. Do not use @ADD@ for any other data types. __If no item with the specified /Key/ is found:__ * @PUT@ - DynamoDB creates a new item with the specified primary key, and then adds the attribute. * @DELETE@ - Nothing happens; there is no attribute to delete. * @ADD@ - DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified. +avuAction :: Lens' AttributeValueUpdate (Maybe AttributeAction) +avuAction = lens _avuAction (\ s a -> s{_avuAction = a}); + +instance Hashable AttributeValueUpdate where + +instance NFData AttributeValueUpdate where + +instance ToJSON AttributeValueUpdate where + toJSON AttributeValueUpdate'{..} + = object + (catMaybes + [("Value" .=) <$> _avuValue, + ("Action" .=) <$> _avuAction]) + +-- | Represents the amount of provisioned throughput capacity consumed on a table or an index. +-- +-- +-- +-- /See:/ 'capacity' smart constructor. +newtype Capacity = Capacity' + { _cCapacityUnits :: Maybe Double + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Capacity' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cCapacityUnits' - The total number of capacity units consumed on a table or an index. +capacity + :: Capacity +capacity = Capacity' {_cCapacityUnits = Nothing} + + +-- | The total number of capacity units consumed on a table or an index. +cCapacityUnits :: Lens' Capacity (Maybe Double) +cCapacityUnits = lens _cCapacityUnits (\ s a -> s{_cCapacityUnits = a}); + +instance FromJSON Capacity where + parseJSON + = withObject "Capacity" + (\ x -> Capacity' <$> (x .:? "CapacityUnits")) + +instance Hashable Capacity where + +instance NFData Capacity where + +-- | Represents the selection criteria for a @Query@ or @Scan@ operation: +-- +-- +-- * For a @Query@ operation, @Condition@ is used for specifying the @KeyConditions@ to use when querying a table or an index. For @KeyConditions@ , only the following comparison operators are supported: +-- +-- @EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN@ +-- +-- @Condition@ is also used in a @QueryFilter@ , which evaluates the query results and returns only the desired values. +-- +-- * For a @Scan@ operation, @Condition@ is used in a @ScanFilter@ , which evaluates the scan results and returns only the desired values. +-- +-- +-- +-- +-- /See:/ 'condition' smart constructor. +data Condition = Condition' + { _cAttributeValueList :: !(Maybe [AttributeValue]) + , _cComparisonOperator :: !ComparisonOperator + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Condition' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cAttributeValueList' - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the @ComparisonOperator@ being used. For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, @a@ is greater than @A@ , and @a@ is greater than @B@ . For a list of code values, see . For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. +-- +-- * 'cComparisonOperator' - A comparator for evaluating attributes. For example, equals, greater than, less than, etc. The following comparison operators are available: @EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN@ The following are descriptions of each comparison operator. * @EQ@ : Equal. @EQ@ is supported for all data types, including lists and maps. @AttributeValueList@ can contain only one @AttributeValue@ element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an @AttributeValue@ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @NE@ : Not equal. @NE@ is supported for all data types, including lists and maps. @AttributeValueList@ can contain only one @AttributeValue@ of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an @AttributeValue@ of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @LE@ : Less than or equal. @AttributeValueList@ can contain only one @AttributeValue@ element of type String, Number, or Binary (not a set type). If an item contains an @AttributeValue@ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @LT@ : Less than. @AttributeValueList@ can contain only one @AttributeValue@ of type String, Number, or Binary (not a set type). If an item contains an @AttributeValue@ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GE@ : Greater than or equal. @AttributeValueList@ can contain only one @AttributeValue@ element of type String, Number, or Binary (not a set type). If an item contains an @AttributeValue@ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GT@ : Greater than. @AttributeValueList@ can contain only one @AttributeValue@ element of type String, Number, or Binary (not a set type). If an item contains an @AttributeValue@ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @NOT_NULL@ : The attribute exists. @NOT_NULL@ is supported for all data types, including lists and maps. * @NULL@ : The attribute does not exist. @NULL@ is supported for all data types, including lists and maps. * @CONTAINS@ : Checks for a subsequence, or value in a set. @AttributeValueList@ can contain only one @AttributeValue@ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it finds an exact match with any member of the set. CONTAINS is supported for lists: When evaluating "@a CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @NOT_CONTAINS@ : Checks for absence of a subsequence, or absence of a value in a set. @AttributeValueList@ can contain only one @AttributeValue@ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it /does not/ find an exact match with any member of the set. NOT_CONTAINS is supported for lists: When evaluating "@a NOT CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @BEGINS_WITH@ : Checks for a prefix. @AttributeValueList@ can contain only one @AttributeValue@ of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). * @IN@ : Checks for matching elements in a list. @AttributeValueList@ can contain one or more @AttributeValue@ elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true. * @BETWEEN@ : Greater than or equal to the first value, and less than or equal to the second value. @AttributeValueList@ must contain two @AttributeValue@ elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an @AttributeValue@ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not compare to @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ For usage examples of @AttributeValueList@ and @ComparisonOperator@ , see in the /Amazon DynamoDB Developer Guide/ . +condition + :: ComparisonOperator -- ^ 'cComparisonOperator' + -> Condition +condition pComparisonOperator_ = + Condition' + {_cAttributeValueList = Nothing, _cComparisonOperator = pComparisonOperator_} + + +-- | One or more values to evaluate against the supplied attribute. The number of values in the list depends on the @ComparisonOperator@ being used. For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, @a@ is greater than @A@ , and @a@ is greater than @B@ . For a list of code values, see . For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. +cAttributeValueList :: Lens' Condition [AttributeValue] +cAttributeValueList = lens _cAttributeValueList (\ s a -> s{_cAttributeValueList = a}) . _Default . _Coerce; + +-- | A comparator for evaluating attributes. For example, equals, greater than, less than, etc. The following comparison operators are available: @EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN@ The following are descriptions of each comparison operator. * @EQ@ : Equal. @EQ@ is supported for all data types, including lists and maps. @AttributeValueList@ can contain only one @AttributeValue@ element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an @AttributeValue@ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @NE@ : Not equal. @NE@ is supported for all data types, including lists and maps. @AttributeValueList@ can contain only one @AttributeValue@ of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an @AttributeValue@ of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @LE@ : Less than or equal. @AttributeValueList@ can contain only one @AttributeValue@ element of type String, Number, or Binary (not a set type). If an item contains an @AttributeValue@ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @LT@ : Less than. @AttributeValueList@ can contain only one @AttributeValue@ of type String, Number, or Binary (not a set type). If an item contains an @AttributeValue@ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GE@ : Greater than or equal. @AttributeValueList@ can contain only one @AttributeValue@ element of type String, Number, or Binary (not a set type). If an item contains an @AttributeValue@ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GT@ : Greater than. @AttributeValueList@ can contain only one @AttributeValue@ element of type String, Number, or Binary (not a set type). If an item contains an @AttributeValue@ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @NOT_NULL@ : The attribute exists. @NOT_NULL@ is supported for all data types, including lists and maps. * @NULL@ : The attribute does not exist. @NULL@ is supported for all data types, including lists and maps. * @CONTAINS@ : Checks for a subsequence, or value in a set. @AttributeValueList@ can contain only one @AttributeValue@ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it finds an exact match with any member of the set. CONTAINS is supported for lists: When evaluating "@a CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @NOT_CONTAINS@ : Checks for absence of a subsequence, or absence of a value in a set. @AttributeValueList@ can contain only one @AttributeValue@ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it /does not/ find an exact match with any member of the set. NOT_CONTAINS is supported for lists: When evaluating "@a NOT CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @BEGINS_WITH@ : Checks for a prefix. @AttributeValueList@ can contain only one @AttributeValue@ of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). * @IN@ : Checks for matching elements in a list. @AttributeValueList@ can contain one or more @AttributeValue@ elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true. * @BETWEEN@ : Greater than or equal to the first value, and less than or equal to the second value. @AttributeValueList@ must contain two @AttributeValue@ elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an @AttributeValue@ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not compare to @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ For usage examples of @AttributeValueList@ and @ComparisonOperator@ , see in the /Amazon DynamoDB Developer Guide/ . +cComparisonOperator :: Lens' Condition ComparisonOperator +cComparisonOperator = lens _cComparisonOperator (\ s a -> s{_cComparisonOperator = a}); + +instance Hashable Condition where + +instance NFData Condition where + +instance ToJSON Condition where + toJSON Condition'{..} + = object + (catMaybes + [("AttributeValueList" .=) <$> _cAttributeValueList, + Just ("ComparisonOperator" .= _cComparisonOperator)]) + +-- | The capacity units consumed by an 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 request asked for it. For more information, see in the /Amazon DynamoDB Developer Guide/ . +-- +-- +-- +-- /See:/ 'consumedCapacity' smart constructor. +data ConsumedCapacity = ConsumedCapacity' + { _ccGlobalSecondaryIndexes :: !(Maybe (Map Text Capacity)) + , _ccCapacityUnits :: !(Maybe Double) + , _ccLocalSecondaryIndexes :: !(Maybe (Map Text Capacity)) + , _ccTable :: !(Maybe Capacity) + , _ccTableName :: !(Maybe Text) + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ConsumedCapacity' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ccGlobalSecondaryIndexes' - The amount of throughput consumed on each global index affected by the operation. +-- +-- * 'ccCapacityUnits' - The total number of capacity units consumed by the operation. +-- +-- * 'ccLocalSecondaryIndexes' - The amount of throughput consumed on each local index affected by the operation. +-- +-- * 'ccTable' - The amount of throughput consumed on the table affected by the operation. +-- +-- * 'ccTableName' - The name of the table that was affected by the operation. +consumedCapacity + :: ConsumedCapacity +consumedCapacity = + ConsumedCapacity' + { _ccGlobalSecondaryIndexes = Nothing + , _ccCapacityUnits = Nothing + , _ccLocalSecondaryIndexes = Nothing + , _ccTable = Nothing + , _ccTableName = Nothing + } + + +-- | The amount of throughput consumed on each global index affected by the operation. +ccGlobalSecondaryIndexes :: Lens' ConsumedCapacity (HashMap Text Capacity) +ccGlobalSecondaryIndexes = lens _ccGlobalSecondaryIndexes (\ s a -> s{_ccGlobalSecondaryIndexes = a}) . _Default . _Map; + +-- | The total number of capacity units consumed by the operation. +ccCapacityUnits :: Lens' ConsumedCapacity (Maybe Double) +ccCapacityUnits = lens _ccCapacityUnits (\ s a -> s{_ccCapacityUnits = a}); + +-- | The amount of throughput consumed on each local index affected by the operation. +ccLocalSecondaryIndexes :: Lens' ConsumedCapacity (HashMap Text Capacity) +ccLocalSecondaryIndexes = lens _ccLocalSecondaryIndexes (\ s a -> s{_ccLocalSecondaryIndexes = a}) . _Default . _Map; + +-- | The amount of throughput consumed on the table affected by the operation. +ccTable :: Lens' ConsumedCapacity (Maybe Capacity) +ccTable = lens _ccTable (\ s a -> s{_ccTable = a}); + +-- | The name of the table that was affected by the operation. +ccTableName :: Lens' ConsumedCapacity (Maybe Text) +ccTableName = lens _ccTableName (\ s a -> s{_ccTableName = a}); + +instance FromJSON ConsumedCapacity where + parseJSON + = withObject "ConsumedCapacity" + (\ x -> + ConsumedCapacity' <$> + (x .:? "GlobalSecondaryIndexes" .!= mempty) <*> + (x .:? "CapacityUnits") + <*> (x .:? "LocalSecondaryIndexes" .!= mempty) + <*> (x .:? "Table") + <*> (x .:? "TableName")) + +instance Hashable ConsumedCapacity where + +instance NFData ConsumedCapacity where + +-- | Represents a new global secondary index to be added to an existing table. +-- +-- +-- +-- /See:/ 'createGlobalSecondaryIndexAction' smart constructor. +data CreateGlobalSecondaryIndexAction = CreateGlobalSecondaryIndexAction' + { _cgsiaIndexName :: !Text + , _cgsiaKeySchema :: !(List1 KeySchemaElement) + , _cgsiaProjection :: !Projection + , _cgsiaProvisionedThroughput :: !ProvisionedThroughput + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CreateGlobalSecondaryIndexAction' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cgsiaIndexName' - The name of the global secondary index to be created. +-- +-- * 'cgsiaKeySchema' - The key schema for the global secondary index. +-- +-- * 'cgsiaProjection' - Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. +-- +-- * 'cgsiaProvisionedThroughput' - Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see in the /Amazon DynamoDB Developer Guide/ . +createGlobalSecondaryIndexAction + :: Text -- ^ 'cgsiaIndexName' + -> NonEmpty KeySchemaElement -- ^ 'cgsiaKeySchema' + -> Projection -- ^ 'cgsiaProjection' + -> ProvisionedThroughput -- ^ 'cgsiaProvisionedThroughput' + -> CreateGlobalSecondaryIndexAction +createGlobalSecondaryIndexAction pIndexName_ pKeySchema_ pProjection_ pProvisionedThroughput_ = + CreateGlobalSecondaryIndexAction' + { _cgsiaIndexName = pIndexName_ + , _cgsiaKeySchema = _List1 # pKeySchema_ + , _cgsiaProjection = pProjection_ + , _cgsiaProvisionedThroughput = pProvisionedThroughput_ + } + + +-- | The name of the global secondary index to be created. +cgsiaIndexName :: Lens' CreateGlobalSecondaryIndexAction Text +cgsiaIndexName = lens _cgsiaIndexName (\ s a -> s{_cgsiaIndexName = a}); + +-- | The key schema for the global secondary index. +cgsiaKeySchema :: Lens' CreateGlobalSecondaryIndexAction (NonEmpty KeySchemaElement) +cgsiaKeySchema = lens _cgsiaKeySchema (\ s a -> s{_cgsiaKeySchema = a}) . _List1; + +-- | Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. +cgsiaProjection :: Lens' CreateGlobalSecondaryIndexAction Projection +cgsiaProjection = lens _cgsiaProjection (\ s a -> s{_cgsiaProjection = a}); + +-- | Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see in the /Amazon DynamoDB Developer Guide/ . +cgsiaProvisionedThroughput :: Lens' CreateGlobalSecondaryIndexAction ProvisionedThroughput +cgsiaProvisionedThroughput = lens _cgsiaProvisionedThroughput (\ s a -> s{_cgsiaProvisionedThroughput = a}); + +instance Hashable CreateGlobalSecondaryIndexAction + where + +instance NFData CreateGlobalSecondaryIndexAction + where + +instance ToJSON CreateGlobalSecondaryIndexAction + where + toJSON CreateGlobalSecondaryIndexAction'{..} + = object + (catMaybes + [Just ("IndexName" .= _cgsiaIndexName), + Just ("KeySchema" .= _cgsiaKeySchema), + Just ("Projection" .= _cgsiaProjection), + Just + ("ProvisionedThroughput" .= + _cgsiaProvisionedThroughput)]) + +-- | Represents a global secondary index to be deleted from an existing table. +-- +-- +-- +-- /See:/ 'deleteGlobalSecondaryIndexAction' smart constructor. +newtype DeleteGlobalSecondaryIndexAction = DeleteGlobalSecondaryIndexAction' + { _dgsiaIndexName :: Text + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'DeleteGlobalSecondaryIndexAction' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'dgsiaIndexName' - The name of the global secondary index to be deleted. +deleteGlobalSecondaryIndexAction + :: Text -- ^ 'dgsiaIndexName' + -> DeleteGlobalSecondaryIndexAction +deleteGlobalSecondaryIndexAction pIndexName_ = + DeleteGlobalSecondaryIndexAction' {_dgsiaIndexName = pIndexName_} + + +-- | The name of the global secondary index to be deleted. +dgsiaIndexName :: Lens' DeleteGlobalSecondaryIndexAction Text +dgsiaIndexName = lens _dgsiaIndexName (\ s a -> s{_dgsiaIndexName = a}); + +instance Hashable DeleteGlobalSecondaryIndexAction + where + +instance NFData DeleteGlobalSecondaryIndexAction + where + +instance ToJSON DeleteGlobalSecondaryIndexAction + where + toJSON DeleteGlobalSecondaryIndexAction'{..} + = object + (catMaybes [Just ("IndexName" .= _dgsiaIndexName)]) + +-- | Represents a request to perform a @DeleteItem@ operation on an item. +-- +-- +-- +-- /See:/ 'deleteRequest' smart constructor. +newtype DeleteRequest = DeleteRequest' + { _drKey :: Map Text AttributeValue + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'DeleteRequest' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'drKey' - A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. +deleteRequest + :: DeleteRequest +deleteRequest = DeleteRequest' {_drKey = mempty} + + +-- | A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. +drKey :: Lens' DeleteRequest (HashMap Text AttributeValue) +drKey = lens _drKey (\ s a -> s{_drKey = a}) . _Map; + +instance FromJSON DeleteRequest where + parseJSON + = withObject "DeleteRequest" + (\ x -> DeleteRequest' <$> (x .:? "Key" .!= mempty)) + +instance Hashable DeleteRequest where + +instance NFData DeleteRequest where + +instance ToJSON DeleteRequest where + toJSON DeleteRequest'{..} + = object (catMaybes [Just ("Key" .= _drKey)]) + +-- | Represents a condition to be compared with an attribute value. This condition can be used with @DeleteItem@ , @PutItem@ or @UpdateItem@ operations; if the comparison evaluates to true, the operation succeeds; if not, the operation fails. You can use @ExpectedAttributeValue@ in one of two different ways: +-- +-- +-- * Use @AttributeValueList@ to specify one or more values to compare against an attribute. Use @ComparisonOperator@ to specify how you want to perform the comparison. If the comparison evaluates to true, then the conditional operation succeeds. +-- +-- * Use @Value@ to specify a value that DynamoDB will compare against an attribute. If the values match, then @ExpectedAttributeValue@ evaluates to true and the conditional operation succeeds. Optionally, you can also set @Exists@ to false, indicating that you /do not/ expect to find the attribute value in the table. In this case, the conditional operation succeeds only if the comparison evaluates to false. +-- +-- +-- +-- @Value@ and @Exists@ are incompatible with @AttributeValueList@ and @ComparisonOperator@ . Note that if you use both sets of parameters at once, DynamoDB will return a @ValidationException@ exception. +-- +-- +-- /See:/ 'expectedAttributeValue' smart constructor. +data ExpectedAttributeValue = ExpectedAttributeValue' + { _eavAttributeValueList :: !(Maybe [AttributeValue]) + , _eavExists :: !(Maybe Bool) + , _eavValue :: !(Maybe AttributeValue) + , _eavComparisonOperator :: !(Maybe ComparisonOperator) + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ExpectedAttributeValue' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'eavAttributeValueList' - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the @ComparisonOperator@ being used. For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, @a@ is greater than @A@ , and @a@ is greater than @B@ . For a list of code values, see . For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. For information on specifying data types in JSON, see in the /Amazon DynamoDB Developer Guide/ . +-- +-- * 'eavExists' - Causes DynamoDB to evaluate the value before attempting a conditional operation: * If @Exists@ is @true@ , DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a @ConditionalCheckFailedException@ . * If @Exists@ is @false@ , DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a @ConditionalCheckFailedException@ . The default setting for @Exists@ is @true@ . If you supply a @Value@ all by itself, DynamoDB assumes the attribute exists: You don't have to set @Exists@ to @true@ , because it is implied. DynamoDB returns a @ValidationException@ if: * @Exists@ is @true@ but there is no @Value@ to check. (You expect a value to exist, but don't specify what that value is.) * @Exists@ is @false@ but you also provide a @Value@ . (You cannot expect an attribute to have a value, while also expecting it not to exist.) +-- +-- * 'eavValue' - Represents the data for the expected attribute. Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. For more information, see in the /Amazon DynamoDB Developer Guide/ . +-- +-- * 'eavComparisonOperator' - A comparator for evaluating attributes in the @AttributeValueList@ . For example, equals, greater than, less than, etc. The following comparison operators are available: @EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN@ The following are descriptions of each comparison operator. * @EQ@ : Equal. @EQ@ is supported for all data types, including lists and maps. @AttributeValueList@ can contain only one @AttributeValue@ element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an @AttributeValue@ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @NE@ : Not equal. @NE@ is supported for all data types, including lists and maps. @AttributeValueList@ can contain only one @AttributeValue@ of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an @AttributeValue@ of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @LE@ : Less than or equal. @AttributeValueList@ can contain only one @AttributeValue@ element of type String, Number, or Binary (not a set type). If an item contains an @AttributeValue@ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @LT@ : Less than. @AttributeValueList@ can contain only one @AttributeValue@ of type String, Number, or Binary (not a set type). If an item contains an @AttributeValue@ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GE@ : Greater than or equal. @AttributeValueList@ can contain only one @AttributeValue@ element of type String, Number, or Binary (not a set type). If an item contains an @AttributeValue@ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GT@ : Greater than. @AttributeValueList@ can contain only one @AttributeValue@ element of type String, Number, or Binary (not a set type). If an item contains an @AttributeValue@ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @NOT_NULL@ : The attribute exists. @NOT_NULL@ is supported for all data types, including lists and maps. * @NULL@ : The attribute does not exist. @NULL@ is supported for all data types, including lists and maps. * @CONTAINS@ : Checks for a subsequence, or value in a set. @AttributeValueList@ can contain only one @AttributeValue@ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it finds an exact match with any member of the set. CONTAINS is supported for lists: When evaluating "@a CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @NOT_CONTAINS@ : Checks for absence of a subsequence, or absence of a value in a set. @AttributeValueList@ can contain only one @AttributeValue@ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it /does not/ find an exact match with any member of the set. NOT_CONTAINS is supported for lists: When evaluating "@a NOT CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @BEGINS_WITH@ : Checks for a prefix. @AttributeValueList@ can contain only one @AttributeValue@ of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). * @IN@ : Checks for matching elements in a list. @AttributeValueList@ can contain one or more @AttributeValue@ elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true. * @BETWEEN@ : Greater than or equal to the first value, and less than or equal to the second value. @AttributeValueList@ must contain two @AttributeValue@ elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an @AttributeValue@ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not compare to @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ +expectedAttributeValue + :: ExpectedAttributeValue +expectedAttributeValue = + ExpectedAttributeValue' + { _eavAttributeValueList = Nothing + , _eavExists = Nothing + , _eavValue = Nothing + , _eavComparisonOperator = Nothing + } + + +-- | One or more values to evaluate against the supplied attribute. The number of values in the list depends on the @ComparisonOperator@ being used. For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, @a@ is greater than @A@ , and @a@ is greater than @B@ . For a list of code values, see . For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. For information on specifying data types in JSON, see in the /Amazon DynamoDB Developer Guide/ . +eavAttributeValueList :: Lens' ExpectedAttributeValue [AttributeValue] +eavAttributeValueList = lens _eavAttributeValueList (\ s a -> s{_eavAttributeValueList = a}) . _Default . _Coerce; + +-- | Causes DynamoDB to evaluate the value before attempting a conditional operation: * If @Exists@ is @true@ , DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a @ConditionalCheckFailedException@ . * If @Exists@ is @false@ , DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a @ConditionalCheckFailedException@ . The default setting for @Exists@ is @true@ . If you supply a @Value@ all by itself, DynamoDB assumes the attribute exists: You don't have to set @Exists@ to @true@ , because it is implied. DynamoDB returns a @ValidationException@ if: * @Exists@ is @true@ but there is no @Value@ to check. (You expect a value to exist, but don't specify what that value is.) * @Exists@ is @false@ but you also provide a @Value@ . (You cannot expect an attribute to have a value, while also expecting it not to exist.) +eavExists :: Lens' ExpectedAttributeValue (Maybe Bool) +eavExists = lens _eavExists (\ s a -> s{_eavExists = a}); + +-- | Represents the data for the expected attribute. Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. For more information, see in the /Amazon DynamoDB Developer Guide/ . +eavValue :: Lens' ExpectedAttributeValue (Maybe AttributeValue) +eavValue = lens _eavValue (\ s a -> s{_eavValue = a}); + +-- | A comparator for evaluating attributes in the @AttributeValueList@ . For example, equals, greater than, less than, etc. The following comparison operators are available: @EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN@ The following are descriptions of each comparison operator. * @EQ@ : Equal. @EQ@ is supported for all data types, including lists and maps. @AttributeValueList@ can contain only one @AttributeValue@ element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an @AttributeValue@ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @NE@ : Not equal. @NE@ is supported for all data types, including lists and maps. @AttributeValueList@ can contain only one @AttributeValue@ of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an @AttributeValue@ of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @LE@ : Less than or equal. @AttributeValueList@ can contain only one @AttributeValue@ element of type String, Number, or Binary (not a set type). If an item contains an @AttributeValue@ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @LT@ : Less than. @AttributeValueList@ can contain only one @AttributeValue@ of type String, Number, or Binary (not a set type). If an item contains an @AttributeValue@ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GE@ : Greater than or equal. @AttributeValueList@ can contain only one @AttributeValue@ element of type String, Number, or Binary (not a set type). If an item contains an @AttributeValue@ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GT@ : Greater than. @AttributeValueList@ can contain only one @AttributeValue@ element of type String, Number, or Binary (not a set type). If an item contains an @AttributeValue@ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @NOT_NULL@ : The attribute exists. @NOT_NULL@ is supported for all data types, including lists and maps. * @NULL@ : The attribute does not exist. @NULL@ is supported for all data types, including lists and maps. * @CONTAINS@ : Checks for a subsequence, or value in a set. @AttributeValueList@ can contain only one @AttributeValue@ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it finds an exact match with any member of the set. CONTAINS is supported for lists: When evaluating "@a CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @NOT_CONTAINS@ : Checks for absence of a subsequence, or absence of a value in a set. @AttributeValueList@ can contain only one @AttributeValue@ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it /does not/ find an exact match with any member of the set. NOT_CONTAINS is supported for lists: When evaluating "@a NOT CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @BEGINS_WITH@ : Checks for a prefix. @AttributeValueList@ can contain only one @AttributeValue@ of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). * @IN@ : Checks for matching elements in a list. @AttributeValueList@ can contain one or more @AttributeValue@ elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true. * @BETWEEN@ : Greater than or equal to the first value, and less than or equal to the second value. @AttributeValueList@ must contain two @AttributeValue@ elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an @AttributeValue@ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not compare to @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ +eavComparisonOperator :: Lens' ExpectedAttributeValue (Maybe ComparisonOperator) +eavComparisonOperator = lens _eavComparisonOperator (\ s a -> s{_eavComparisonOperator = a}); + +instance Hashable ExpectedAttributeValue where + +instance NFData ExpectedAttributeValue where + +instance ToJSON ExpectedAttributeValue where + toJSON ExpectedAttributeValue'{..} + = object + (catMaybes + [("AttributeValueList" .=) <$> + _eavAttributeValueList, + ("Exists" .=) <$> _eavExists, + ("Value" .=) <$> _eavValue, + ("ComparisonOperator" .=) <$> + _eavComparisonOperator]) + +-- | Represents the properties of a global secondary index. +-- +-- +-- +-- /See:/ 'globalSecondaryIndex' smart constructor. +data GlobalSecondaryIndex = GlobalSecondaryIndex' + { _gsiIndexName :: !Text + , _gsiKeySchema :: !(List1 KeySchemaElement) + , _gsiProjection :: !Projection + , _gsiProvisionedThroughput :: !ProvisionedThroughput + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'GlobalSecondaryIndex' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'gsiIndexName' - The name of the global secondary index. The name must be unique among all other indexes on this table. +-- +-- * 'gsiKeySchema' - The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: * @HASH@ - partition key * @RANGE@ - sort key +-- +-- * 'gsiProjection' - Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. +-- +-- * 'gsiProvisionedThroughput' - Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see in the /Amazon DynamoDB Developer Guide/ . +globalSecondaryIndex + :: Text -- ^ 'gsiIndexName' + -> NonEmpty KeySchemaElement -- ^ 'gsiKeySchema' + -> Projection -- ^ 'gsiProjection' + -> ProvisionedThroughput -- ^ 'gsiProvisionedThroughput' + -> GlobalSecondaryIndex +globalSecondaryIndex pIndexName_ pKeySchema_ pProjection_ pProvisionedThroughput_ = + GlobalSecondaryIndex' + { _gsiIndexName = pIndexName_ + , _gsiKeySchema = _List1 # pKeySchema_ + , _gsiProjection = pProjection_ + , _gsiProvisionedThroughput = pProvisionedThroughput_ + } + + +-- | The name of the global secondary index. The name must be unique among all other indexes on this table. +gsiIndexName :: Lens' GlobalSecondaryIndex Text +gsiIndexName = lens _gsiIndexName (\ s a -> s{_gsiIndexName = a}); + +-- | The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: * @HASH@ - partition key * @RANGE@ - sort key +gsiKeySchema :: Lens' GlobalSecondaryIndex (NonEmpty KeySchemaElement) +gsiKeySchema = lens _gsiKeySchema (\ s a -> s{_gsiKeySchema = a}) . _List1; + +-- | Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. +gsiProjection :: Lens' GlobalSecondaryIndex Projection +gsiProjection = lens _gsiProjection (\ s a -> s{_gsiProjection = a}); + +-- | Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see in the /Amazon DynamoDB Developer Guide/ . +gsiProvisionedThroughput :: Lens' GlobalSecondaryIndex ProvisionedThroughput +gsiProvisionedThroughput = lens _gsiProvisionedThroughput (\ s a -> s{_gsiProvisionedThroughput = a}); + +instance Hashable GlobalSecondaryIndex where + +instance NFData GlobalSecondaryIndex where + +instance ToJSON GlobalSecondaryIndex where + toJSON GlobalSecondaryIndex'{..} + = object + (catMaybes + [Just ("IndexName" .= _gsiIndexName), + Just ("KeySchema" .= _gsiKeySchema), + Just ("Projection" .= _gsiProjection), + Just + ("ProvisionedThroughput" .= + _gsiProvisionedThroughput)]) + +-- | Represents the properties of a global secondary index. +-- +-- +-- +-- /See:/ 'globalSecondaryIndexDescription' smart constructor. +data GlobalSecondaryIndexDescription = GlobalSecondaryIndexDescription' + { _gsidBackfilling :: !(Maybe Bool) + , _gsidIndexSizeBytes :: !(Maybe Integer) + , _gsidIndexStatus :: !(Maybe IndexStatus) + , _gsidProvisionedThroughput :: !(Maybe ProvisionedThroughputDescription) + , _gsidIndexARN :: !(Maybe Text) + , _gsidKeySchema :: !(Maybe (List1 KeySchemaElement)) + , _gsidProjection :: !(Maybe Projection) + , _gsidItemCount :: !(Maybe Integer) + , _gsidIndexName :: !(Maybe Text) + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'GlobalSecondaryIndexDescription' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'gsidBackfilling' - Indicates whether the index is currently backfilling. /Backfilling/ is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and @Backfilling@ is false. +-- +-- * 'gsidIndexSizeBytes' - The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. +-- +-- * 'gsidIndexStatus' - The current state of the global secondary index: * @CREATING@ - The index is being created. * @UPDATING@ - The index is being updated. * @DELETING@ - The index is being deleted. * @ACTIVE@ - The index is ready for use. +-- +-- * 'gsidProvisionedThroughput' - Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see in the /Amazon DynamoDB Developer Guide/ . +-- +-- * 'gsidIndexARN' - The Amazon Resource Name (ARN) that uniquely identifies the index. +-- +-- * 'gsidKeySchema' - The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: * @HASH@ - partition key * @RANGE@ - sort key +-- +-- * 'gsidProjection' - Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. +-- +-- * 'gsidItemCount' - The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. +-- +-- * 'gsidIndexName' - The name of the global secondary index. +globalSecondaryIndexDescription + :: GlobalSecondaryIndexDescription +globalSecondaryIndexDescription = + GlobalSecondaryIndexDescription' + { _gsidBackfilling = Nothing + , _gsidIndexSizeBytes = Nothing + , _gsidIndexStatus = Nothing + , _gsidProvisionedThroughput = Nothing + , _gsidIndexARN = Nothing + , _gsidKeySchema = Nothing + , _gsidProjection = Nothing + , _gsidItemCount = Nothing + , _gsidIndexName = Nothing + } + + +-- | Indicates whether the index is currently backfilling. /Backfilling/ is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and @Backfilling@ is false. +gsidBackfilling :: Lens' GlobalSecondaryIndexDescription (Maybe Bool) +gsidBackfilling = lens _gsidBackfilling (\ s a -> s{_gsidBackfilling = a}); + +-- | The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. +gsidIndexSizeBytes :: Lens' GlobalSecondaryIndexDescription (Maybe Integer) +gsidIndexSizeBytes = lens _gsidIndexSizeBytes (\ s a -> s{_gsidIndexSizeBytes = a}); + +-- | The current state of the global secondary index: * @CREATING@ - The index is being created. * @UPDATING@ - The index is being updated. * @DELETING@ - The index is being deleted. * @ACTIVE@ - The index is ready for use. +gsidIndexStatus :: Lens' GlobalSecondaryIndexDescription (Maybe IndexStatus) +gsidIndexStatus = lens _gsidIndexStatus (\ s a -> s{_gsidIndexStatus = a}); + +-- | Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see in the /Amazon DynamoDB Developer Guide/ . +gsidProvisionedThroughput :: Lens' GlobalSecondaryIndexDescription (Maybe ProvisionedThroughputDescription) +gsidProvisionedThroughput = lens _gsidProvisionedThroughput (\ s a -> s{_gsidProvisionedThroughput = a}); + +-- | The Amazon Resource Name (ARN) that uniquely identifies the index. +gsidIndexARN :: Lens' GlobalSecondaryIndexDescription (Maybe Text) +gsidIndexARN = lens _gsidIndexARN (\ s a -> s{_gsidIndexARN = a}); + +-- | The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: * @HASH@ - partition key * @RANGE@ - sort key +gsidKeySchema :: Lens' GlobalSecondaryIndexDescription (Maybe (NonEmpty KeySchemaElement)) +gsidKeySchema = lens _gsidKeySchema (\ s a -> s{_gsidKeySchema = a}) . mapping _List1; + +-- | Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. +gsidProjection :: Lens' GlobalSecondaryIndexDescription (Maybe Projection) +gsidProjection = lens _gsidProjection (\ s a -> s{_gsidProjection = a}); + +-- | The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. +gsidItemCount :: Lens' GlobalSecondaryIndexDescription (Maybe Integer) +gsidItemCount = lens _gsidItemCount (\ s a -> s{_gsidItemCount = a}); + +-- | The name of the global secondary index. +gsidIndexName :: Lens' GlobalSecondaryIndexDescription (Maybe Text) +gsidIndexName = lens _gsidIndexName (\ s a -> s{_gsidIndexName = a}); + +instance FromJSON GlobalSecondaryIndexDescription + where + parseJSON + = withObject "GlobalSecondaryIndexDescription" + (\ x -> + GlobalSecondaryIndexDescription' <$> + (x .:? "Backfilling") <*> (x .:? "IndexSizeBytes") + <*> (x .:? "IndexStatus") + <*> (x .:? "ProvisionedThroughput") + <*> (x .:? "IndexArn") + <*> (x .:? "KeySchema") + <*> (x .:? "Projection") + <*> (x .:? "ItemCount") + <*> (x .:? "IndexName")) + +instance Hashable GlobalSecondaryIndexDescription + where + +instance NFData GlobalSecondaryIndexDescription where + +-- | Represents one of the following: +-- +-- +-- * A new global secondary index to be added to an existing table. +-- +-- * New provisioned throughput parameters for an existing global secondary index. +-- +-- * An existing global secondary index to be removed from an existing table. +-- +-- +-- +-- +-- /See:/ 'globalSecondaryIndexUpdate' smart constructor. +data GlobalSecondaryIndexUpdate = GlobalSecondaryIndexUpdate' + { _gsiuCreate :: !(Maybe CreateGlobalSecondaryIndexAction) + , _gsiuDelete :: !(Maybe DeleteGlobalSecondaryIndexAction) + , _gsiuUpdate :: !(Maybe UpdateGlobalSecondaryIndexAction) + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'GlobalSecondaryIndexUpdate' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'gsiuCreate' - The parameters required for creating a global secondary index on an existing table: * @IndexName @ * @KeySchema @ * @AttributeDefinitions @ * @Projection @ * @ProvisionedThroughput @ +-- +-- * 'gsiuDelete' - The name of an existing global secondary index to be removed. +-- +-- * 'gsiuUpdate' - The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index. +globalSecondaryIndexUpdate + :: GlobalSecondaryIndexUpdate +globalSecondaryIndexUpdate = + GlobalSecondaryIndexUpdate' + {_gsiuCreate = Nothing, _gsiuDelete = Nothing, _gsiuUpdate = Nothing} + + +-- | The parameters required for creating a global secondary index on an existing table: * @IndexName @ * @KeySchema @ * @AttributeDefinitions @ * @Projection @ * @ProvisionedThroughput @ +gsiuCreate :: Lens' GlobalSecondaryIndexUpdate (Maybe CreateGlobalSecondaryIndexAction) +gsiuCreate = lens _gsiuCreate (\ s a -> s{_gsiuCreate = a}); + +-- | The name of an existing global secondary index to be removed. +gsiuDelete :: Lens' GlobalSecondaryIndexUpdate (Maybe DeleteGlobalSecondaryIndexAction) +gsiuDelete = lens _gsiuDelete (\ s a -> s{_gsiuDelete = a}); + +-- | The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index. +gsiuUpdate :: Lens' GlobalSecondaryIndexUpdate (Maybe UpdateGlobalSecondaryIndexAction) +gsiuUpdate = lens _gsiuUpdate (\ s a -> s{_gsiuUpdate = a}); + +instance Hashable GlobalSecondaryIndexUpdate where + +instance NFData GlobalSecondaryIndexUpdate where + +instance ToJSON GlobalSecondaryIndexUpdate where + toJSON GlobalSecondaryIndexUpdate'{..} + = object + (catMaybes + [("Create" .=) <$> _gsiuCreate, + ("Delete" .=) <$> _gsiuDelete, + ("Update" .=) <$> _gsiuUpdate]) + +-- | Information about item collections, if any, that were affected by the operation. @ItemCollectionMetrics@ is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response. +-- +-- +-- +-- /See:/ 'itemCollectionMetrics' smart constructor. +data ItemCollectionMetrics = ItemCollectionMetrics' + { _icmItemCollectionKey :: !(Maybe (Map Text AttributeValue)) + , _icmSizeEstimateRangeGB :: !(Maybe [Double]) + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ItemCollectionMetrics' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'icmItemCollectionKey' - The partition key value of the item collection. This value is the same as the partition key value of the item. +-- +-- * 'icmSizeEstimateRangeGB' - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. +itemCollectionMetrics + :: ItemCollectionMetrics +itemCollectionMetrics = + ItemCollectionMetrics' + {_icmItemCollectionKey = Nothing, _icmSizeEstimateRangeGB = Nothing} + + +-- | The partition key value of the item collection. This value is the same as the partition key value of the item. +icmItemCollectionKey :: Lens' ItemCollectionMetrics (HashMap Text AttributeValue) +icmItemCollectionKey = lens _icmItemCollectionKey (\ s a -> s{_icmItemCollectionKey = a}) . _Default . _Map; + +-- | An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. +icmSizeEstimateRangeGB :: Lens' ItemCollectionMetrics [Double] +icmSizeEstimateRangeGB = lens _icmSizeEstimateRangeGB (\ s a -> s{_icmSizeEstimateRangeGB = a}) . _Default . _Coerce; + +instance FromJSON ItemCollectionMetrics where + parseJSON + = withObject "ItemCollectionMetrics" + (\ x -> + ItemCollectionMetrics' <$> + (x .:? "ItemCollectionKey" .!= mempty) <*> + (x .:? "SizeEstimateRangeGB" .!= mempty)) + +instance Hashable ItemCollectionMetrics where + +instance NFData ItemCollectionMetrics where + +-- | Represents /a single element/ of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index. +-- +-- +-- A @KeySchemaElement@ represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one @KeySchemaElement@ (for the partition key). A composite primary key would require one @KeySchemaElement@ for the partition key, and another @KeySchemaElement@ for the sort key. +-- +-- A @KeySchemaElement@ must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map. +-- +-- +-- /See:/ 'keySchemaElement' smart constructor. +data KeySchemaElement = KeySchemaElement' + { _kseAttributeName :: !Text + , _kseKeyType :: !KeyType + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'KeySchemaElement' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'kseAttributeName' - The name of a key attribute. +-- +-- * 'kseKeyType' - The role that this key attribute will assume: * @HASH@ - partition key * @RANGE@ - sort key +keySchemaElement + :: Text -- ^ 'kseAttributeName' + -> KeyType -- ^ 'kseKeyType' + -> KeySchemaElement +keySchemaElement pAttributeName_ pKeyType_ = + KeySchemaElement' + {_kseAttributeName = pAttributeName_, _kseKeyType = pKeyType_} + + +-- | The name of a key attribute. +kseAttributeName :: Lens' KeySchemaElement Text +kseAttributeName = lens _kseAttributeName (\ s a -> s{_kseAttributeName = a}); + +-- | The role that this key attribute will assume: * @HASH@ - partition key * @RANGE@ - sort key +kseKeyType :: Lens' KeySchemaElement KeyType +kseKeyType = lens _kseKeyType (\ s a -> s{_kseKeyType = a}); + +instance FromJSON KeySchemaElement where + parseJSON + = withObject "KeySchemaElement" + (\ x -> + KeySchemaElement' <$> + (x .: "AttributeName") <*> (x .: "KeyType")) + +instance Hashable KeySchemaElement where + +instance NFData KeySchemaElement where + +instance ToJSON KeySchemaElement where + toJSON KeySchemaElement'{..} + = object + (catMaybes + [Just ("AttributeName" .= _kseAttributeName), + Just ("KeyType" .= _kseKeyType)]) + +-- | Represents a set of primary keys and, for each key, the attributes to retrieve from the table. +-- +-- +-- For each primary key, you must provide /all/ of the key attributes. For example, with a simple primary key, you only need to provide the partition key. For a composite primary key, you must provide /both/ the partition key and the sort key. +-- +-- +-- /See:/ 'keysAndAttributes' smart constructor. +data KeysAndAttributes = KeysAndAttributes' + { _kaaProjectionExpression :: !(Maybe Text) + , _kaaAttributesToGet :: !(Maybe (List1 Text)) + , _kaaExpressionAttributeNames :: !(Maybe (Map Text Text)) + , _kaaConsistentRead :: !(Maybe Bool) + , _kaaKeys :: !(List1 (Map Text AttributeValue)) + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'KeysAndAttributes' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'kaaProjectionExpression' - 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 @ProjectionExpression@ 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 in the /Amazon DynamoDB Developer Guide/ . +-- +-- * 'kaaAttributesToGet' - This is a legacy parameter. Use @ProjectionExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . +-- +-- * 'kaaExpressionAttributeNames' - 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for @ExpressionAttributeNames@ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . +-- +-- * 'kaaConsistentRead' - The consistency of a read operation. If set to @true@ , then a strongly consistent read is used; otherwise, an eventually consistent read is used. +-- +-- * 'kaaKeys' - The primary key attribute values that define the items and the attributes associated with the items. +keysAndAttributes + :: NonEmpty (HashMap Text AttributeValue) -- ^ 'kaaKeys' + -> KeysAndAttributes +keysAndAttributes pKeys_ = + KeysAndAttributes' + { _kaaProjectionExpression = Nothing + , _kaaAttributesToGet = Nothing + , _kaaExpressionAttributeNames = Nothing + , _kaaConsistentRead = Nothing + , _kaaKeys = _List1 # pKeys_ + } + + +-- | 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 @ProjectionExpression@ 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 in the /Amazon DynamoDB Developer Guide/ . +kaaProjectionExpression :: Lens' KeysAndAttributes (Maybe Text) +kaaProjectionExpression = lens _kaaProjectionExpression (\ s a -> s{_kaaProjectionExpression = a}); + +-- | This is a legacy parameter. Use @ProjectionExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . +kaaAttributesToGet :: Lens' KeysAndAttributes (Maybe (NonEmpty Text)) +kaaAttributesToGet = lens _kaaAttributesToGet (\ s a -> s{_kaaAttributesToGet = a}) . mapping _List1; + +-- | 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for @ExpressionAttributeNames@ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . +kaaExpressionAttributeNames :: Lens' KeysAndAttributes (HashMap Text Text) +kaaExpressionAttributeNames = lens _kaaExpressionAttributeNames (\ s a -> s{_kaaExpressionAttributeNames = a}) . _Default . _Map; + +-- | The consistency of a read operation. If set to @true@ , then a strongly consistent read is used; otherwise, an eventually consistent read is used. +kaaConsistentRead :: Lens' KeysAndAttributes (Maybe Bool) +kaaConsistentRead = lens _kaaConsistentRead (\ s a -> s{_kaaConsistentRead = a}); + +-- | The primary key attribute values that define the items and the attributes associated with the items. +kaaKeys :: Lens' KeysAndAttributes (NonEmpty (HashMap Text AttributeValue)) +kaaKeys = lens _kaaKeys (\ s a -> s{_kaaKeys = a}) . _List1; + +instance FromJSON KeysAndAttributes where + parseJSON + = withObject "KeysAndAttributes" + (\ x -> + KeysAndAttributes' <$> + (x .:? "ProjectionExpression") <*> + (x .:? "AttributesToGet") + <*> (x .:? "ExpressionAttributeNames" .!= mempty) + <*> (x .:? "ConsistentRead") + <*> (x .: "Keys")) + +instance Hashable KeysAndAttributes where + +instance NFData KeysAndAttributes where + +instance ToJSON KeysAndAttributes where + toJSON KeysAndAttributes'{..} + = object + (catMaybes + [("ProjectionExpression" .=) <$> + _kaaProjectionExpression, + ("AttributesToGet" .=) <$> _kaaAttributesToGet, + ("ExpressionAttributeNames" .=) <$> + _kaaExpressionAttributeNames, + ("ConsistentRead" .=) <$> _kaaConsistentRead, + Just ("Keys" .= _kaaKeys)]) + +-- | Represents the properties of a local secondary index. +-- +-- +-- +-- /See:/ 'localSecondaryIndex' smart constructor. +data LocalSecondaryIndex = LocalSecondaryIndex' + { _lsiIndexName :: !Text + , _lsiKeySchema :: !(List1 KeySchemaElement) + , _lsiProjection :: !Projection + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'LocalSecondaryIndex' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'lsiIndexName' - The name of the local secondary index. The name must be unique among all other indexes on this table. +-- +-- * 'lsiKeySchema' - The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: * @HASH@ - partition key * @RANGE@ - sort key +-- +-- * 'lsiProjection' - Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. +localSecondaryIndex + :: Text -- ^ 'lsiIndexName' + -> NonEmpty KeySchemaElement -- ^ 'lsiKeySchema' + -> Projection -- ^ 'lsiProjection' + -> LocalSecondaryIndex +localSecondaryIndex pIndexName_ pKeySchema_ pProjection_ = + LocalSecondaryIndex' + { _lsiIndexName = pIndexName_ + , _lsiKeySchema = _List1 # pKeySchema_ + , _lsiProjection = pProjection_ + } + + +-- | The name of the local secondary index. The name must be unique among all other indexes on this table. +lsiIndexName :: Lens' LocalSecondaryIndex Text +lsiIndexName = lens _lsiIndexName (\ s a -> s{_lsiIndexName = a}); + +-- | The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: * @HASH@ - partition key * @RANGE@ - sort key +lsiKeySchema :: Lens' LocalSecondaryIndex (NonEmpty KeySchemaElement) +lsiKeySchema = lens _lsiKeySchema (\ s a -> s{_lsiKeySchema = a}) . _List1; + +-- | Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. +lsiProjection :: Lens' LocalSecondaryIndex Projection +lsiProjection = lens _lsiProjection (\ s a -> s{_lsiProjection = a}); + +instance Hashable LocalSecondaryIndex where + +instance NFData LocalSecondaryIndex where + +instance ToJSON LocalSecondaryIndex where + toJSON LocalSecondaryIndex'{..} + = object + (catMaybes + [Just ("IndexName" .= _lsiIndexName), + Just ("KeySchema" .= _lsiKeySchema), + Just ("Projection" .= _lsiProjection)]) + +-- | Represents the properties of a local secondary index. +-- +-- +-- +-- /See:/ 'localSecondaryIndexDescription' smart constructor. +data LocalSecondaryIndexDescription = LocalSecondaryIndexDescription' + { _lsidIndexSizeBytes :: !(Maybe Integer) + , _lsidIndexARN :: !(Maybe Text) + , _lsidKeySchema :: !(Maybe (List1 KeySchemaElement)) + , _lsidProjection :: !(Maybe Projection) + , _lsidItemCount :: !(Maybe Integer) + , _lsidIndexName :: !(Maybe Text) + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'LocalSecondaryIndexDescription' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'lsidIndexSizeBytes' - The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. +-- +-- * 'lsidIndexARN' - The Amazon Resource Name (ARN) that uniquely identifies the index. +-- +-- * 'lsidKeySchema' - The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: * @HASH@ - partition key * @RANGE@ - sort key +-- +-- * 'lsidProjection' - Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. +-- +-- * 'lsidItemCount' - The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. +-- +-- * 'lsidIndexName' - Represents the name of the local secondary index. +localSecondaryIndexDescription + :: LocalSecondaryIndexDescription +localSecondaryIndexDescription = + LocalSecondaryIndexDescription' + { _lsidIndexSizeBytes = Nothing + , _lsidIndexARN = Nothing + , _lsidKeySchema = Nothing + , _lsidProjection = Nothing + , _lsidItemCount = Nothing + , _lsidIndexName = Nothing + } + + +-- | The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. +lsidIndexSizeBytes :: Lens' LocalSecondaryIndexDescription (Maybe Integer) +lsidIndexSizeBytes = lens _lsidIndexSizeBytes (\ s a -> s{_lsidIndexSizeBytes = a}); + +-- | The Amazon Resource Name (ARN) that uniquely identifies the index. +lsidIndexARN :: Lens' LocalSecondaryIndexDescription (Maybe Text) +lsidIndexARN = lens _lsidIndexARN (\ s a -> s{_lsidIndexARN = a}); + +-- | The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: * @HASH@ - partition key * @RANGE@ - sort key +lsidKeySchema :: Lens' LocalSecondaryIndexDescription (Maybe (NonEmpty KeySchemaElement)) +lsidKeySchema = lens _lsidKeySchema (\ s a -> s{_lsidKeySchema = a}) . mapping _List1; + +-- | Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. +lsidProjection :: Lens' LocalSecondaryIndexDescription (Maybe Projection) +lsidProjection = lens _lsidProjection (\ s a -> s{_lsidProjection = a}); + +-- | The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. +lsidItemCount :: Lens' LocalSecondaryIndexDescription (Maybe Integer) +lsidItemCount = lens _lsidItemCount (\ s a -> s{_lsidItemCount = a}); + +-- | Represents the name of the local secondary index. +lsidIndexName :: Lens' LocalSecondaryIndexDescription (Maybe Text) +lsidIndexName = lens _lsidIndexName (\ s a -> s{_lsidIndexName = a}); + +instance FromJSON LocalSecondaryIndexDescription + where + parseJSON + = withObject "LocalSecondaryIndexDescription" + (\ x -> + LocalSecondaryIndexDescription' <$> + (x .:? "IndexSizeBytes") <*> (x .:? "IndexArn") <*> + (x .:? "KeySchema") + <*> (x .:? "Projection") + <*> (x .:? "ItemCount") + <*> (x .:? "IndexName")) + +instance Hashable LocalSecondaryIndexDescription + where + +instance NFData LocalSecondaryIndexDescription where + +-- | Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. +-- +-- +-- +-- /See:/ 'projection' smart constructor. +data Projection = Projection' + { _pProjectionType :: !(Maybe ProjectionType) + , _pNonKeyAttributes :: !(Maybe (List1 Text)) + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Projection' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'pProjectionType' - The set of attributes that are projected into the index: * @KEYS_ONLY@ - Only the index and primary keys are projected into the index. * @INCLUDE@ - Only the specified table attributes are projected into the index. The list of projected attributes are in @NonKeyAttributes@ . * @ALL@ - All of the table attributes are projected into the index. +-- +-- * 'pNonKeyAttributes' - Represents the non-key attribute names which will be projected into the index. For local secondary indexes, the total count of @NonKeyAttributes@ summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. +projection + :: Projection +projection = + Projection' {_pProjectionType = Nothing, _pNonKeyAttributes = Nothing} + + +-- | The set of attributes that are projected into the index: * @KEYS_ONLY@ - Only the index and primary keys are projected into the index. * @INCLUDE@ - Only the specified table attributes are projected into the index. The list of projected attributes are in @NonKeyAttributes@ . * @ALL@ - All of the table attributes are projected into the index. +pProjectionType :: Lens' Projection (Maybe ProjectionType) +pProjectionType = lens _pProjectionType (\ s a -> s{_pProjectionType = a}); + +-- | Represents the non-key attribute names which will be projected into the index. For local secondary indexes, the total count of @NonKeyAttributes@ summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. +pNonKeyAttributes :: Lens' Projection (Maybe (NonEmpty Text)) +pNonKeyAttributes = lens _pNonKeyAttributes (\ s a -> s{_pNonKeyAttributes = a}) . mapping _List1; + +instance FromJSON Projection where + parseJSON + = withObject "Projection" + (\ x -> + Projection' <$> + (x .:? "ProjectionType") <*> + (x .:? "NonKeyAttributes")) + +instance Hashable Projection where + +instance NFData Projection where + +instance ToJSON Projection where + toJSON Projection'{..} + = object + (catMaybes + [("ProjectionType" .=) <$> _pProjectionType, + ("NonKeyAttributes" .=) <$> _pNonKeyAttributes]) + +-- | Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the @UpdateTable@ operation. +-- +-- +-- For current minimum and maximum provisioned throughput values, see in the /Amazon DynamoDB Developer Guide/ . +-- +-- +-- /See:/ 'provisionedThroughput' smart constructor. +data ProvisionedThroughput = ProvisionedThroughput' + { _ptReadCapacityUnits :: !Nat + , _ptWriteCapacityUnits :: !Nat + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ProvisionedThroughput' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ptReadCapacityUnits' - The maximum number of strongly consistent reads consumed per second before DynamoDB returns a @ThrottlingException@ . For more information, see in the /Amazon DynamoDB Developer Guide/ . +-- +-- * 'ptWriteCapacityUnits' - The maximum number of writes consumed per second before DynamoDB returns a @ThrottlingException@ . For more information, see in the /Amazon DynamoDB Developer Guide/ . +provisionedThroughput + :: Natural -- ^ 'ptReadCapacityUnits' + -> Natural -- ^ 'ptWriteCapacityUnits' + -> ProvisionedThroughput +provisionedThroughput pReadCapacityUnits_ pWriteCapacityUnits_ = + ProvisionedThroughput' + { _ptReadCapacityUnits = _Nat # pReadCapacityUnits_ + , _ptWriteCapacityUnits = _Nat # pWriteCapacityUnits_ + } + + +-- | The maximum number of strongly consistent reads consumed per second before DynamoDB returns a @ThrottlingException@ . For more information, see in the /Amazon DynamoDB Developer Guide/ . +ptReadCapacityUnits :: Lens' ProvisionedThroughput Natural +ptReadCapacityUnits = lens _ptReadCapacityUnits (\ s a -> s{_ptReadCapacityUnits = a}) . _Nat; + +-- | The maximum number of writes consumed per second before DynamoDB returns a @ThrottlingException@ . For more information, see in the /Amazon DynamoDB Developer Guide/ . +ptWriteCapacityUnits :: Lens' ProvisionedThroughput Natural +ptWriteCapacityUnits = lens _ptWriteCapacityUnits (\ s a -> s{_ptWriteCapacityUnits = a}) . _Nat; + +instance Hashable ProvisionedThroughput where + +instance NFData ProvisionedThroughput where + +instance ToJSON ProvisionedThroughput where + toJSON ProvisionedThroughput'{..} + = object + (catMaybes + [Just ("ReadCapacityUnits" .= _ptReadCapacityUnits), + Just + ("WriteCapacityUnits" .= _ptWriteCapacityUnits)]) + +-- | Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases. +-- +-- +-- +-- /See:/ 'provisionedThroughputDescription' smart constructor. +data ProvisionedThroughputDescription = ProvisionedThroughputDescription' + { _ptdReadCapacityUnits :: !(Maybe Nat) + , _ptdLastDecreaseDateTime :: !(Maybe POSIX) + , _ptdWriteCapacityUnits :: !(Maybe Nat) + , _ptdNumberOfDecreasesToday :: !(Maybe Nat) + , _ptdLastIncreaseDateTime :: !(Maybe POSIX) + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ProvisionedThroughputDescription' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ptdReadCapacityUnits' - The maximum number of strongly consistent reads consumed per second before DynamoDB returns a @ThrottlingException@ . Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 @ReadCapacityUnits@ per second provides 100 eventually consistent @ReadCapacityUnits@ per second. +-- +-- * 'ptdLastDecreaseDateTime' - The date and time of the last provisioned throughput decrease for this table. +-- +-- * 'ptdWriteCapacityUnits' - The maximum number of writes consumed per second before DynamoDB returns a @ThrottlingException@ . +-- +-- * 'ptdNumberOfDecreasesToday' - The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see in the /Amazon DynamoDB Developer Guide/ . +-- +-- * 'ptdLastIncreaseDateTime' - The date and time of the last provisioned throughput increase for this table. +provisionedThroughputDescription + :: ProvisionedThroughputDescription +provisionedThroughputDescription = + ProvisionedThroughputDescription' + { _ptdReadCapacityUnits = Nothing + , _ptdLastDecreaseDateTime = Nothing + , _ptdWriteCapacityUnits = Nothing + , _ptdNumberOfDecreasesToday = Nothing + , _ptdLastIncreaseDateTime = Nothing + } + + +-- | The maximum number of strongly consistent reads consumed per second before DynamoDB returns a @ThrottlingException@ . Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 @ReadCapacityUnits@ per second provides 100 eventually consistent @ReadCapacityUnits@ per second. +ptdReadCapacityUnits :: Lens' ProvisionedThroughputDescription (Maybe Natural) +ptdReadCapacityUnits = lens _ptdReadCapacityUnits (\ s a -> s{_ptdReadCapacityUnits = a}) . mapping _Nat; + +-- | The date and time of the last provisioned throughput decrease for this table. +ptdLastDecreaseDateTime :: Lens' ProvisionedThroughputDescription (Maybe UTCTime) +ptdLastDecreaseDateTime = lens _ptdLastDecreaseDateTime (\ s a -> s{_ptdLastDecreaseDateTime = a}) . mapping _Time; + +-- | The maximum number of writes consumed per second before DynamoDB returns a @ThrottlingException@ . +ptdWriteCapacityUnits :: Lens' ProvisionedThroughputDescription (Maybe Natural) +ptdWriteCapacityUnits = lens _ptdWriteCapacityUnits (\ s a -> s{_ptdWriteCapacityUnits = a}) . mapping _Nat; + +-- | The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see in the /Amazon DynamoDB Developer Guide/ . +ptdNumberOfDecreasesToday :: Lens' ProvisionedThroughputDescription (Maybe Natural) +ptdNumberOfDecreasesToday = lens _ptdNumberOfDecreasesToday (\ s a -> s{_ptdNumberOfDecreasesToday = a}) . mapping _Nat; + +-- | The date and time of the last provisioned throughput increase for this table. +ptdLastIncreaseDateTime :: Lens' ProvisionedThroughputDescription (Maybe UTCTime) +ptdLastIncreaseDateTime = lens _ptdLastIncreaseDateTime (\ s a -> s{_ptdLastIncreaseDateTime = a}) . mapping _Time; + +instance FromJSON ProvisionedThroughputDescription + where + parseJSON + = withObject "ProvisionedThroughputDescription" + (\ x -> + ProvisionedThroughputDescription' <$> + (x .:? "ReadCapacityUnits") <*> + (x .:? "LastDecreaseDateTime") + <*> (x .:? "WriteCapacityUnits") + <*> (x .:? "NumberOfDecreasesToday") + <*> (x .:? "LastIncreaseDateTime")) + +instance Hashable ProvisionedThroughputDescription + where + +instance NFData ProvisionedThroughputDescription + where + +-- | Represents a request to perform a @PutItem@ operation on an item. +-- +-- +-- +-- /See:/ 'putRequest' smart constructor. +newtype PutRequest = PutRequest' + { _prItem :: Map Text AttributeValue + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'PutRequest' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'prItem' - A map of attribute name to attribute values, representing the primary key of an item to be processed by @PutItem@ . All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item which are part of an index key schema for the table, their types must match the index key schema. +putRequest + :: PutRequest +putRequest = PutRequest' {_prItem = mempty} + + +-- | A map of attribute name to attribute values, representing the primary key of an item to be processed by @PutItem@ . All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item which are part of an index key schema for the table, their types must match the index key schema. +prItem :: Lens' PutRequest (HashMap Text AttributeValue) +prItem = lens _prItem (\ s a -> s{_prItem = a}) . _Map; + +instance FromJSON PutRequest where + parseJSON + = withObject "PutRequest" + (\ x -> PutRequest' <$> (x .:? "Item" .!= mempty)) + +instance Hashable PutRequest where + +instance NFData PutRequest where + +instance ToJSON PutRequest where + toJSON PutRequest'{..} + = object (catMaybes [Just ("Item" .= _prItem)]) + +-- | Represents the DynamoDB Streams configuration for a table in DynamoDB. +-- +-- +-- +-- /See:/ 'streamSpecification' smart constructor. +data StreamSpecification = StreamSpecification' + { _ssStreamViewType :: !(Maybe StreamViewType) + , _ssStreamEnabled :: !(Maybe Bool) + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'StreamSpecification' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ssStreamViewType' - When an item in the table is modified, @StreamViewType@ determines what information is written to the stream for this table. Valid values for @StreamViewType@ are: * @KEYS_ONLY@ - Only the key attributes of the modified item are written to the stream. * @NEW_IMAGE@ - The entire item, as it appears after it was modified, is written to the stream. * @OLD_IMAGE@ - The entire item, as it appeared before it was modified, is written to the stream. * @NEW_AND_OLD_IMAGES@ - Both the new and the old item images of the item are written to the stream. +-- +-- * 'ssStreamEnabled' - Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table. +streamSpecification + :: StreamSpecification +streamSpecification = + StreamSpecification' {_ssStreamViewType = Nothing, _ssStreamEnabled = Nothing} + + +-- | When an item in the table is modified, @StreamViewType@ determines what information is written to the stream for this table. Valid values for @StreamViewType@ are: * @KEYS_ONLY@ - Only the key attributes of the modified item are written to the stream. * @NEW_IMAGE@ - The entire item, as it appears after it was modified, is written to the stream. * @OLD_IMAGE@ - The entire item, as it appeared before it was modified, is written to the stream. * @NEW_AND_OLD_IMAGES@ - Both the new and the old item images of the item are written to the stream. +ssStreamViewType :: Lens' StreamSpecification (Maybe StreamViewType) +ssStreamViewType = lens _ssStreamViewType (\ s a -> s{_ssStreamViewType = a}); + +-- | Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table. +ssStreamEnabled :: Lens' StreamSpecification (Maybe Bool) +ssStreamEnabled = lens _ssStreamEnabled (\ s a -> s{_ssStreamEnabled = a}); + +instance FromJSON StreamSpecification where + parseJSON + = withObject "StreamSpecification" + (\ x -> + StreamSpecification' <$> + (x .:? "StreamViewType") <*> (x .:? "StreamEnabled")) + +instance Hashable StreamSpecification where + +instance NFData StreamSpecification where + +instance ToJSON StreamSpecification where + toJSON StreamSpecification'{..} + = object + (catMaybes + [("StreamViewType" .=) <$> _ssStreamViewType, + ("StreamEnabled" .=) <$> _ssStreamEnabled]) + +-- | Represents the properties of a table. +-- +-- +-- +-- /See:/ 'tableDescription' smart constructor. +data TableDescription = TableDescription' + { _tdTableSizeBytes :: !(Maybe Integer) + , _tdAttributeDefinitions :: !(Maybe [AttributeDefinition]) + , _tdLatestStreamARN :: !(Maybe Text) + , _tdProvisionedThroughput :: !(Maybe ProvisionedThroughputDescription) + , _tdTableStatus :: !(Maybe TableStatus) + , _tdTableARN :: !(Maybe Text) + , _tdKeySchema :: !(Maybe (List1 KeySchemaElement)) + , _tdGlobalSecondaryIndexes :: !(Maybe [GlobalSecondaryIndexDescription]) + , _tdLatestStreamLabel :: !(Maybe Text) + , _tdLocalSecondaryIndexes :: !(Maybe [LocalSecondaryIndexDescription]) + , _tdCreationDateTime :: !(Maybe POSIX) + , _tdItemCount :: !(Maybe Integer) + , _tdTableName :: !(Maybe Text) + , _tdStreamSpecification :: !(Maybe StreamSpecification) + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'TableDescription' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'tdTableSizeBytes' - The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. +-- +-- * 'tdAttributeDefinitions' - An array of @AttributeDefinition@ objects. Each of these objects describes one attribute in the table and index key schema. Each @AttributeDefinition@ object in this array is composed of: * @AttributeName@ - The name of the attribute. * @AttributeType@ - The data type for the attribute. +-- +-- * 'tdLatestStreamARN' - The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table. +-- +-- * 'tdProvisionedThroughput' - The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases. +-- +-- * 'tdTableStatus' - The current state of the table: * @CREATING@ - The table is being created. * @UPDATING@ - The table is being updated. * @DELETING@ - The table is being deleted. * @ACTIVE@ - The table is ready for use. +-- +-- * 'tdTableARN' - The Amazon Resource Name (ARN) that uniquely identifies the table. +-- +-- * 'tdKeySchema' - The primary key structure for the table. Each @KeySchemaElement@ consists of: * @AttributeName@ - The name of the attribute. * @KeyType@ - The role of the attribute: * @HASH@ - partition key * @RANGE@ - sort key For more information about primary keys, see in the /Amazon DynamoDB Developer Guide/ . +-- +-- * 'tdGlobalSecondaryIndexes' - The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of: * @Backfilling@ - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table; it is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a @CreateTable@ operation.) * @IndexName@ - The name of the global secondary index. * @IndexSizeBytes@ - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. * @IndexStatus@ - The current status of the global secondary index: * @CREATING@ - The index is being created. * @UPDATING@ - The index is being updated. * @DELETING@ - The index is being deleted. * @ACTIVE@ - The index is ready for use. * @ItemCount@ - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. * @KeySchema@ - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table. * @Projection@ - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: * @ProjectionType@ - One of the following: * @KEYS_ONLY@ - Only the index and primary keys are projected into the index. * @INCLUDE@ - Only the specified table attributes are projected into the index. The list of projected attributes are in @NonKeyAttributes@ . * @ALL@ - All of the table attributes are projected into the index. * @NonKeyAttributes@ - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in @NonKeyAttributes@ , summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. * @ProvisionedThroughput@ - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases. If the table is in the @DELETING@ state, no information about indexes will be returned. +-- +-- * 'tdLatestStreamLabel' - A timestamp, in ISO 8601 format, for this stream. Note that @LatestStreamLabel@ is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique: * the AWS customer ID. * the table name. * the @StreamLabel@ . +-- +-- * 'tdLocalSecondaryIndexes' - Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of: * @IndexName@ - The name of the local secondary index. * @KeySchema@ - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table. * @Projection@ - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: * @ProjectionType@ - One of the following: * @KEYS_ONLY@ - Only the index and primary keys are projected into the index. * @INCLUDE@ - Only the specified table attributes are projected into the index. The list of projected attributes are in @NonKeyAttributes@ . * @ALL@ - All of the table attributes are projected into the index. * @NonKeyAttributes@ - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in @NonKeyAttributes@ , summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. * @IndexSizeBytes@ - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. * @ItemCount@ - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. If the table is in the @DELETING@ state, no information about indexes will be returned. +-- +-- * 'tdCreationDateTime' - The date and time when the table was created, in format. +-- +-- * 'tdItemCount' - The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. +-- +-- * 'tdTableName' - The name of the table. +-- +-- * 'tdStreamSpecification' - The current DynamoDB Streams configuration for the table. +tableDescription + :: TableDescription +tableDescription = + TableDescription' + { _tdTableSizeBytes = Nothing + , _tdAttributeDefinitions = Nothing + , _tdLatestStreamARN = Nothing + , _tdProvisionedThroughput = Nothing + , _tdTableStatus = Nothing + , _tdTableARN = Nothing + , _tdKeySchema = Nothing + , _tdGlobalSecondaryIndexes = Nothing + , _tdLatestStreamLabel = Nothing + , _tdLocalSecondaryIndexes = Nothing + , _tdCreationDateTime = Nothing + , _tdItemCount = Nothing + , _tdTableName = Nothing + , _tdStreamSpecification = Nothing + } + + +-- | The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. +tdTableSizeBytes :: Lens' TableDescription (Maybe Integer) +tdTableSizeBytes = lens _tdTableSizeBytes (\ s a -> s{_tdTableSizeBytes = a}); + +-- | An array of @AttributeDefinition@ objects. Each of these objects describes one attribute in the table and index key schema. Each @AttributeDefinition@ object in this array is composed of: * @AttributeName@ - The name of the attribute. * @AttributeType@ - The data type for the attribute. +tdAttributeDefinitions :: Lens' TableDescription [AttributeDefinition] +tdAttributeDefinitions = lens _tdAttributeDefinitions (\ s a -> s{_tdAttributeDefinitions = a}) . _Default . _Coerce; + +-- | The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table. +tdLatestStreamARN :: Lens' TableDescription (Maybe Text) +tdLatestStreamARN = lens _tdLatestStreamARN (\ s a -> s{_tdLatestStreamARN = a}); + +-- | The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases. +tdProvisionedThroughput :: Lens' TableDescription (Maybe ProvisionedThroughputDescription) +tdProvisionedThroughput = lens _tdProvisionedThroughput (\ s a -> s{_tdProvisionedThroughput = a}); + +-- | The current state of the table: * @CREATING@ - The table is being created. * @UPDATING@ - The table is being updated. * @DELETING@ - The table is being deleted. * @ACTIVE@ - The table is ready for use. +tdTableStatus :: Lens' TableDescription (Maybe TableStatus) +tdTableStatus = lens _tdTableStatus (\ s a -> s{_tdTableStatus = a}); + +-- | The Amazon Resource Name (ARN) that uniquely identifies the table. +tdTableARN :: Lens' TableDescription (Maybe Text) +tdTableARN = lens _tdTableARN (\ s a -> s{_tdTableARN = a}); + +-- | The primary key structure for the table. Each @KeySchemaElement@ consists of: * @AttributeName@ - The name of the attribute. * @KeyType@ - The role of the attribute: * @HASH@ - partition key * @RANGE@ - sort key For more information about primary keys, see in the /Amazon DynamoDB Developer Guide/ . +tdKeySchema :: Lens' TableDescription (Maybe (NonEmpty KeySchemaElement)) +tdKeySchema = lens _tdKeySchema (\ s a -> s{_tdKeySchema = a}) . mapping _List1; + +-- | The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of: * @Backfilling@ - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table; it is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a @CreateTable@ operation.) * @IndexName@ - The name of the global secondary index. * @IndexSizeBytes@ - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. * @IndexStatus@ - The current status of the global secondary index: * @CREATING@ - The index is being created. * @UPDATING@ - The index is being updated. * @DELETING@ - The index is being deleted. * @ACTIVE@ - The index is ready for use. * @ItemCount@ - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. * @KeySchema@ - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table. * @Projection@ - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: * @ProjectionType@ - One of the following: * @KEYS_ONLY@ - Only the index and primary keys are projected into the index. * @INCLUDE@ - Only the specified table attributes are projected into the index. The list of projected attributes are in @NonKeyAttributes@ . * @ALL@ - All of the table attributes are projected into the index. * @NonKeyAttributes@ - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in @NonKeyAttributes@ , summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. * @ProvisionedThroughput@ - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases. If the table is in the @DELETING@ state, no information about indexes will be returned. +tdGlobalSecondaryIndexes :: Lens' TableDescription [GlobalSecondaryIndexDescription] +tdGlobalSecondaryIndexes = lens _tdGlobalSecondaryIndexes (\ s a -> s{_tdGlobalSecondaryIndexes = a}) . _Default . _Coerce; + +-- | A timestamp, in ISO 8601 format, for this stream. Note that @LatestStreamLabel@ is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique: * the AWS customer ID. * the table name. * the @StreamLabel@ . +tdLatestStreamLabel :: Lens' TableDescription (Maybe Text) +tdLatestStreamLabel = lens _tdLatestStreamLabel (\ s a -> s{_tdLatestStreamLabel = a}); + +-- | Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of: * @IndexName@ - The name of the local secondary index. * @KeySchema@ - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table. * @Projection@ - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: * @ProjectionType@ - One of the following: * @KEYS_ONLY@ - Only the index and primary keys are projected into the index. * @INCLUDE@ - Only the specified table attributes are projected into the index. The list of projected attributes are in @NonKeyAttributes@ . * @ALL@ - All of the table attributes are projected into the index. * @NonKeyAttributes@ - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in @NonKeyAttributes@ , summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. * @IndexSizeBytes@ - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. * @ItemCount@ - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. If the table is in the @DELETING@ state, no information about indexes will be returned. +tdLocalSecondaryIndexes :: Lens' TableDescription [LocalSecondaryIndexDescription] +tdLocalSecondaryIndexes = lens _tdLocalSecondaryIndexes (\ s a -> s{_tdLocalSecondaryIndexes = a}) . _Default . _Coerce; + +-- | The date and time when the table was created, in format. +tdCreationDateTime :: Lens' TableDescription (Maybe UTCTime) +tdCreationDateTime = lens _tdCreationDateTime (\ s a -> s{_tdCreationDateTime = a}) . mapping _Time; + +-- | The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. +tdItemCount :: Lens' TableDescription (Maybe Integer) +tdItemCount = lens _tdItemCount (\ s a -> s{_tdItemCount = a}); + +-- | The name of the table. +tdTableName :: Lens' TableDescription (Maybe Text) +tdTableName = lens _tdTableName (\ s a -> s{_tdTableName = a}); + +-- | The current DynamoDB Streams configuration for the table. +tdStreamSpecification :: Lens' TableDescription (Maybe StreamSpecification) +tdStreamSpecification = lens _tdStreamSpecification (\ s a -> s{_tdStreamSpecification = a}); + +instance FromJSON TableDescription where + parseJSON + = withObject "TableDescription" + (\ x -> + TableDescription' <$> + (x .:? "TableSizeBytes") <*> + (x .:? "AttributeDefinitions" .!= mempty) + <*> (x .:? "LatestStreamArn") + <*> (x .:? "ProvisionedThroughput") + <*> (x .:? "TableStatus") + <*> (x .:? "TableArn") + <*> (x .:? "KeySchema") + <*> (x .:? "GlobalSecondaryIndexes" .!= mempty) + <*> (x .:? "LatestStreamLabel") + <*> (x .:? "LocalSecondaryIndexes" .!= mempty) + <*> (x .:? "CreationDateTime") + <*> (x .:? "ItemCount") + <*> (x .:? "TableName") + <*> (x .:? "StreamSpecification")) + +instance Hashable TableDescription where + +instance NFData TableDescription where + +-- | Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single DynamoDB table. +-- +-- +-- AWS-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user: in the Cost Allocation Report. You cannot backdate the application of a tag. +-- +-- For an overview on tagging DynamoDB resources, see in the /Amazon DynamoDB Developer Guide/ . +-- +-- +-- /See:/ 'tag' smart constructor. +data Tag = Tag' + { _tagKey :: !Text + , _tagValue :: !Text + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Tag' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'tagKey' - The key of the tag.Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value. +-- +-- * 'tagValue' - The value of the tag. Tag values are case-sensitive and can be null. +tag + :: Text -- ^ 'tagKey' + -> Text -- ^ 'tagValue' + -> Tag +tag pKey_ pValue_ = Tag' {_tagKey = pKey_, _tagValue = pValue_} + + +-- | The key of the tag.Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value. +tagKey :: Lens' Tag Text +tagKey = lens _tagKey (\ s a -> s{_tagKey = a}); + +-- | The value of the tag. Tag values are case-sensitive and can be null. +tagValue :: Lens' Tag Text +tagValue = lens _tagValue (\ s a -> s{_tagValue = a}); + +instance FromJSON Tag where + parseJSON + = withObject "Tag" + (\ x -> Tag' <$> (x .: "Key") <*> (x .: "Value")) + +instance Hashable Tag where + +instance NFData Tag where + +instance ToJSON Tag where + toJSON Tag'{..} + = object + (catMaybes + [Just ("Key" .= _tagKey), + Just ("Value" .= _tagValue)]) + +-- | The description of the Time to Live (TTL) status on the specified table. +-- +-- +-- +-- /See:/ 'timeToLiveDescription' smart constructor. +data TimeToLiveDescription = TimeToLiveDescription' + { _ttldTimeToLiveStatus :: !(Maybe TimeToLiveStatus) + , _ttldAttributeName :: !(Maybe Text) + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'TimeToLiveDescription' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ttldTimeToLiveStatus' - The Time to Live status for the table. +-- +-- * 'ttldAttributeName' - The name of the Time to Live attribute for items in the table. +timeToLiveDescription + :: TimeToLiveDescription +timeToLiveDescription = + TimeToLiveDescription' + {_ttldTimeToLiveStatus = Nothing, _ttldAttributeName = Nothing} + + +-- | The Time to Live status for the table. +ttldTimeToLiveStatus :: Lens' TimeToLiveDescription (Maybe TimeToLiveStatus) +ttldTimeToLiveStatus = lens _ttldTimeToLiveStatus (\ s a -> s{_ttldTimeToLiveStatus = a}); + +-- | The name of the Time to Live attribute for items in the table. +ttldAttributeName :: Lens' TimeToLiveDescription (Maybe Text) +ttldAttributeName = lens _ttldAttributeName (\ s a -> s{_ttldAttributeName = a}); + +instance FromJSON TimeToLiveDescription where + parseJSON + = withObject "TimeToLiveDescription" + (\ x -> + TimeToLiveDescription' <$> + (x .:? "TimeToLiveStatus") <*> + (x .:? "AttributeName")) + +instance Hashable TimeToLiveDescription where + +instance NFData TimeToLiveDescription where + +-- | Represents the settings used to enable or disable Time to Live for the specified table. +-- +-- +-- +-- /See:/ 'timeToLiveSpecification' smart constructor. +data TimeToLiveSpecification = TimeToLiveSpecification' + { _ttlsEnabled :: !Bool + , _ttlsAttributeName :: !Text + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'TimeToLiveSpecification' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ttlsEnabled' - Indicates whether Time To Live is to be enabled (true) or disabled (false) on the table. +-- +-- * 'ttlsAttributeName' - The name of the Time to Live attribute used to store the expiration time for items in the table. +timeToLiveSpecification + :: Bool -- ^ 'ttlsEnabled' + -> Text -- ^ 'ttlsAttributeName' + -> TimeToLiveSpecification +timeToLiveSpecification pEnabled_ pAttributeName_ = + TimeToLiveSpecification' + {_ttlsEnabled = pEnabled_, _ttlsAttributeName = pAttributeName_} + + +-- | Indicates whether Time To Live is to be enabled (true) or disabled (false) on the table. +ttlsEnabled :: Lens' TimeToLiveSpecification Bool +ttlsEnabled = lens _ttlsEnabled (\ s a -> s{_ttlsEnabled = a}); + +-- | The name of the Time to Live attribute used to store the expiration time for items in the table. +ttlsAttributeName :: Lens' TimeToLiveSpecification Text +ttlsAttributeName = lens _ttlsAttributeName (\ s a -> s{_ttlsAttributeName = a}); + +instance FromJSON TimeToLiveSpecification where + parseJSON + = withObject "TimeToLiveSpecification" + (\ x -> + TimeToLiveSpecification' <$> + (x .: "Enabled") <*> (x .: "AttributeName")) + +instance Hashable TimeToLiveSpecification where + +instance NFData TimeToLiveSpecification where + +instance ToJSON TimeToLiveSpecification where + toJSON TimeToLiveSpecification'{..} + = object + (catMaybes + [Just ("Enabled" .= _ttlsEnabled), + Just ("AttributeName" .= _ttlsAttributeName)]) + +-- | Represents the new provisioned throughput settings to be applied to a global secondary index. +-- +-- +-- +-- /See:/ 'updateGlobalSecondaryIndexAction' smart constructor. +data UpdateGlobalSecondaryIndexAction = UpdateGlobalSecondaryIndexAction' + { _ugsiaIndexName :: !Text + , _ugsiaProvisionedThroughput :: !ProvisionedThroughput + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'UpdateGlobalSecondaryIndexAction' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ugsiaIndexName' - The name of the global secondary index to be updated. +-- +-- * 'ugsiaProvisionedThroughput' - Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see in the /Amazon DynamoDB Developer Guide/ . +updateGlobalSecondaryIndexAction + :: Text -- ^ 'ugsiaIndexName' + -> ProvisionedThroughput -- ^ 'ugsiaProvisionedThroughput' + -> UpdateGlobalSecondaryIndexAction +updateGlobalSecondaryIndexAction pIndexName_ pProvisionedThroughput_ = + UpdateGlobalSecondaryIndexAction' + { _ugsiaIndexName = pIndexName_ + , _ugsiaProvisionedThroughput = pProvisionedThroughput_ + } + + +-- | The name of the global secondary index to be updated. +ugsiaIndexName :: Lens' UpdateGlobalSecondaryIndexAction Text +ugsiaIndexName = lens _ugsiaIndexName (\ s a -> s{_ugsiaIndexName = a}); + +-- | Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see in the /Amazon DynamoDB Developer Guide/ . +ugsiaProvisionedThroughput :: Lens' UpdateGlobalSecondaryIndexAction ProvisionedThroughput +ugsiaProvisionedThroughput = lens _ugsiaProvisionedThroughput (\ s a -> s{_ugsiaProvisionedThroughput = a}); + +instance Hashable UpdateGlobalSecondaryIndexAction + where + +instance NFData UpdateGlobalSecondaryIndexAction + where + +instance ToJSON UpdateGlobalSecondaryIndexAction + where + toJSON UpdateGlobalSecondaryIndexAction'{..} + = object + (catMaybes + [Just ("IndexName" .= _ugsiaIndexName), + Just + ("ProvisionedThroughput" .= + _ugsiaProvisionedThroughput)]) + +-- | Represents an operation to perform - either @DeleteItem@ or @PutItem@ . You can only request one of these operations, not both, in a single @WriteRequest@ . If you do need to perform both of these operations, you will need to provide two separate @WriteRequest@ objects. +-- +-- +-- +-- /See:/ 'writeRequest' smart constructor. +data WriteRequest = WriteRequest' + { _wrDeleteRequest :: !(Maybe DeleteRequest) + , _wrPutRequest :: !(Maybe PutRequest) + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'WriteRequest' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'wrDeleteRequest' - A request to perform a @DeleteItem@ operation. +-- +-- * 'wrPutRequest' - A request to perform a @PutItem@ operation. +writeRequest + :: WriteRequest +writeRequest = + WriteRequest' {_wrDeleteRequest = Nothing, _wrPutRequest = Nothing} + + +-- | A request to perform a @DeleteItem@ operation. +wrDeleteRequest :: Lens' WriteRequest (Maybe DeleteRequest) +wrDeleteRequest = lens _wrDeleteRequest (\ s a -> s{_wrDeleteRequest = a}); + +-- | A request to perform a @PutItem@ operation. +wrPutRequest :: Lens' WriteRequest (Maybe PutRequest) +wrPutRequest = lens _wrPutRequest (\ s a -> s{_wrPutRequest = a}); + +instance FromJSON WriteRequest where + parseJSON + = withObject "WriteRequest" + (\ x -> + WriteRequest' <$> + (x .:? "DeleteRequest") <*> (x .:? "PutRequest")) + +instance Hashable WriteRequest where + +instance NFData WriteRequest where instance ToJSON WriteRequest where toJSON WriteRequest'{..} diff --git a/gen/Network/AWS/DynamoDB/Types/Sum.hs b/gen/Network/AWS/DynamoDB/Types/Sum.hs --- a/gen/Network/AWS/DynamoDB/Types/Sum.hs +++ b/gen/Network/AWS/DynamoDB/Types/Sum.hs @@ -9,22 +9,23 @@ -- | -- Module : Network.AWS.DynamoDB.Types.Sum --- Copyright : (c) 2013-2016 Brendan Hay +-- Copyright : (c) 2013-2017 Brendan Hay -- License : Mozilla Public License, v. 2.0. --- Maintainer : Brendan Hay +-- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- module Network.AWS.DynamoDB.Types.Sum where -import Network.AWS.Prelude +import Network.AWS.Prelude data AttributeAction - = Add - | Delete - | Put - deriving (Eq,Ord,Read,Show,Enum,Bounded,Data,Typeable,Generic) + = Add + | Delete + | Put + deriving (Eq, Ord, Read, Show, Enum, Bounded, Data, Typeable, Generic) + instance FromText AttributeAction where parser = takeLowerText >>= \case "add" -> pure Add @@ -49,21 +50,22 @@ toJSON = toJSONText data ComparisonOperator - = BeginsWith - | Between - | Contains - | EQ' - | GE - | GT' - | IN - | LE - | LT' - | NE - | NotContains - | NotNull - | Null - deriving (Eq,Ord,Read,Show,Enum,Bounded,Data,Typeable,Generic) + = BeginsWith + | Between + | Contains + | EQ' + | GE + | GT' + | IN + | LE + | LT' + | NE + | NotContains + | NotNull + | Null + deriving (Eq, Ord, Read, Show, Enum, Bounded, Data, Typeable, Generic) + instance FromText ComparisonOperator where parser = takeLowerText >>= \case "begins_with" -> pure BeginsWith @@ -108,10 +110,11 @@ toJSON = toJSONText data ConditionalOperator - = And - | OR - deriving (Eq,Ord,Read,Show,Enum,Bounded,Data,Typeable,Generic) + = And + | OR + deriving (Eq, Ord, Read, Show, Enum, Bounded, Data, Typeable, Generic) + instance FromText ConditionalOperator where parser = takeLowerText >>= \case "and" -> pure And @@ -134,12 +137,13 @@ toJSON = toJSONText data IndexStatus - = ISActive - | ISCreating - | ISDeleting - | ISUpdating - deriving (Eq,Ord,Read,Show,Enum,Bounded,Data,Typeable,Generic) + = ISActive + | ISCreating + | ISDeleting + | ISUpdating + deriving (Eq, Ord, Read, Show, Enum, Bounded, Data, Typeable, Generic) + instance FromText IndexStatus where parser = takeLowerText >>= \case "active" -> pure ISActive @@ -166,10 +170,11 @@ parseJSON = parseJSONText "IndexStatus" data KeyType - = Hash - | Range - deriving (Eq,Ord,Read,Show,Enum,Bounded,Data,Typeable,Generic) + = Hash + | Range + deriving (Eq, Ord, Read, Show, Enum, Bounded, Data, Typeable, Generic) + instance FromText KeyType where parser = takeLowerText >>= \case "hash" -> pure Hash @@ -195,11 +200,12 @@ parseJSON = parseJSONText "KeyType" data ProjectionType - = All - | Include - | KeysOnly - deriving (Eq,Ord,Read,Show,Enum,Bounded,Data,Typeable,Generic) + = All + | Include + | KeysOnly + deriving (Eq, Ord, Read, Show, Enum, Bounded, Data, Typeable, Generic) + instance FromText ProjectionType where parser = takeLowerText >>= \case "all" -> pure All @@ -229,22 +235,23 @@ -- | Determines the level of detail about provisioned throughput consumption that is returned in the response: -- -- --- * /INDEXES/ - The response includes the aggregate /ConsumedCapacity/ for the operation, together with /ConsumedCapacity/ for each table and secondary index that was accessed. +-- * @INDEXES@ - The response includes the aggregate @ConsumedCapacity@ for the operation, together with @ConsumedCapacity@ for each table and secondary index that was accessed. -- --- Note that some operations, such as /GetItem/ and /BatchGetItem/ , do not access any indexes at all. In these cases, specifying /INDEXES/ will only return /ConsumedCapacity/ information for table(s). +-- Note that some operations, such as @GetItem@ and @BatchGetItem@ , do not access any indexes at all. In these cases, specifying @INDEXES@ will only return @ConsumedCapacity@ information for table(s). -- --- * /TOTAL/ - The response includes only the aggregate /ConsumedCapacity/ for the operation. +-- * @TOTAL@ - The response includes only the aggregate @ConsumedCapacity@ for the operation. -- --- * /NONE/ - No /ConsumedCapacity/ details are included in the response. +-- * @NONE@ - No @ConsumedCapacity@ details are included in the response. -- -- -- data ReturnConsumedCapacity - = RCCIndexes - | RCCNone - | RCCTotal - deriving (Eq,Ord,Read,Show,Enum,Bounded,Data,Typeable,Generic) + = RCCIndexes + | RCCNone + | RCCTotal + deriving (Eq, Ord, Read, Show, Enum, Bounded, Data, Typeable, Generic) + instance FromText ReturnConsumedCapacity where parser = takeLowerText >>= \case "indexes" -> pure RCCIndexes @@ -269,10 +276,11 @@ toJSON = toJSONText data ReturnItemCollectionMetrics - = RICMNone - | RICMSize - deriving (Eq,Ord,Read,Show,Enum,Bounded,Data,Typeable,Generic) + = RICMNone + | RICMSize + deriving (Eq, Ord, Read, Show, Enum, Bounded, Data, Typeable, Generic) + instance FromText ReturnItemCollectionMetrics where parser = takeLowerText >>= \case "none" -> pure RICMNone @@ -295,13 +303,14 @@ toJSON = toJSONText data ReturnValue - = AllNew - | AllOld - | None - | UpdatedNew - | UpdatedOld - deriving (Eq,Ord,Read,Show,Enum,Bounded,Data,Typeable,Generic) + = AllNew + | AllOld + | None + | UpdatedNew + | UpdatedOld + deriving (Eq, Ord, Read, Show, Enum, Bounded, Data, Typeable, Generic) + instance FromText ReturnValue where parser = takeLowerText >>= \case "all_new" -> pure AllNew @@ -330,11 +339,12 @@ toJSON = toJSONText data ScalarAttributeType - = B - | N - | S - deriving (Eq,Ord,Read,Show,Enum,Bounded,Data,Typeable,Generic) + = B + | N + | S + deriving (Eq, Ord, Read, Show, Enum, Bounded, Data, Typeable, Generic) + instance FromText ScalarAttributeType where parser = takeLowerText >>= \case "b" -> pure B @@ -362,12 +372,13 @@ parseJSON = parseJSONText "ScalarAttributeType" data Select - = AllAttributes - | AllProjectedAttributes - | Count - | SpecificAttributes - deriving (Eq,Ord,Read,Show,Enum,Bounded,Data,Typeable,Generic) + = AllAttributes + | AllProjectedAttributes + | Count + | SpecificAttributes + deriving (Eq, Ord, Read, Show, Enum, Bounded, Data, Typeable, Generic) + instance FromText Select where parser = takeLowerText >>= \case "all_attributes" -> pure AllAttributes @@ -394,12 +405,13 @@ toJSON = toJSONText data StreamViewType - = SVTKeysOnly - | SVTNewAndOldImages - | SVTNewImage - | SVTOldImage - deriving (Eq,Ord,Read,Show,Enum,Bounded,Data,Typeable,Generic) + = SVTKeysOnly + | SVTNewAndOldImages + | SVTNewImage + | SVTOldImage + deriving (Eq, Ord, Read, Show, Enum, Bounded, Data, Typeable, Generic) + instance FromText StreamViewType where parser = takeLowerText >>= \case "keys_only" -> pure SVTKeysOnly @@ -429,12 +441,13 @@ parseJSON = parseJSONText "StreamViewType" data TableStatus - = Active - | Creating - | Deleting - | Updating - deriving (Eq,Ord,Read,Show,Enum,Bounded,Data,Typeable,Generic) + = Active + | Creating + | Deleting + | Updating + deriving (Eq, Ord, Read, Show, Enum, Bounded, Data, Typeable, Generic) + instance FromText TableStatus where parser = takeLowerText >>= \case "active" -> pure Active @@ -459,3 +472,36 @@ instance FromJSON TableStatus where parseJSON = parseJSONText "TableStatus" + +data TimeToLiveStatus + = Disabled + | Disabling + | Enabled + | Enabling + deriving (Eq, Ord, Read, Show, Enum, Bounded, Data, Typeable, Generic) + + +instance FromText TimeToLiveStatus where + parser = takeLowerText >>= \case + "disabled" -> pure Disabled + "disabling" -> pure Disabling + "enabled" -> pure Enabled + "enabling" -> pure Enabling + e -> fromTextError $ "Failure parsing TimeToLiveStatus from value: '" <> e + <> "'. Accepted values: disabled, disabling, enabled, enabling" + +instance ToText TimeToLiveStatus where + toText = \case + Disabled -> "DISABLED" + Disabling -> "DISABLING" + Enabled -> "ENABLED" + Enabling -> "ENABLING" + +instance Hashable TimeToLiveStatus +instance NFData TimeToLiveStatus +instance ToByteString TimeToLiveStatus +instance ToQuery TimeToLiveStatus +instance ToHeader TimeToLiveStatus + +instance FromJSON TimeToLiveStatus where + parseJSON = parseJSONText "TimeToLiveStatus" diff --git a/gen/Network/AWS/DynamoDB/UntagResource.hs b/gen/Network/AWS/DynamoDB/UntagResource.hs new file mode 100644 --- /dev/null +++ b/gen/Network/AWS/DynamoDB/UntagResource.hs @@ -0,0 +1,120 @@ +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} +{-# LANGUAGE TypeFamilies #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} +{-# OPTIONS_GHC -fno-warn-unused-binds #-} +{-# OPTIONS_GHC -fno-warn-unused-matches #-} + +-- Derived from AWS service descriptions, licensed under Apache 2.0. + +-- | +-- Module : Network.AWS.DynamoDB.UntagResource +-- Copyright : (c) 2013-2017 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +-- Removes the association of tags from an Amazon DynamoDB resource. You can call UntagResource up to 5 times per second, per account. +-- +-- +-- For an overview on tagging DynamoDB resources, see in the /Amazon DynamoDB Developer Guide/ . +-- +module Network.AWS.DynamoDB.UntagResource + ( + -- * Creating a Request + untagResource + , UntagResource + -- * Request Lenses + , urResourceARN + , urTagKeys + + -- * Destructuring the Response + , untagResourceResponse + , UntagResourceResponse + ) where + +import Network.AWS.DynamoDB.Types +import Network.AWS.DynamoDB.Types.Product +import Network.AWS.Lens +import Network.AWS.Prelude +import Network.AWS.Request +import Network.AWS.Response + +-- | /See:/ 'untagResource' smart constructor. +data UntagResource = UntagResource' + { _urResourceARN :: !Text + , _urTagKeys :: ![Text] + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'UntagResource' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'urResourceARN' - The Amazon DyanamoDB resource the tags will be removed from. This value is an Amazon Resource Name (ARN). +-- +-- * 'urTagKeys' - A list of tag keys. Existing tags of the resource whose keys are members of this list will be removed from the Amazon DynamoDB resource. +untagResource + :: Text -- ^ 'urResourceARN' + -> UntagResource +untagResource pResourceARN_ = + UntagResource' {_urResourceARN = pResourceARN_, _urTagKeys = mempty} + + +-- | The Amazon DyanamoDB resource the tags will be removed from. This value is an Amazon Resource Name (ARN). +urResourceARN :: Lens' UntagResource Text +urResourceARN = lens _urResourceARN (\ s a -> s{_urResourceARN = a}); + +-- | A list of tag keys. Existing tags of the resource whose keys are members of this list will be removed from the Amazon DynamoDB resource. +urTagKeys :: Lens' UntagResource [Text] +urTagKeys = lens _urTagKeys (\ s a -> s{_urTagKeys = a}) . _Coerce; + +instance AWSRequest UntagResource where + type Rs UntagResource = UntagResourceResponse + request = postJSON dynamoDB + response = receiveNull UntagResourceResponse' + +instance Hashable UntagResource where + +instance NFData UntagResource where + +instance ToHeaders UntagResource where + toHeaders + = const + (mconcat + ["X-Amz-Target" =# + ("DynamoDB_20120810.UntagResource" :: ByteString), + "Content-Type" =# + ("application/x-amz-json-1.0" :: ByteString)]) + +instance ToJSON UntagResource where + toJSON UntagResource'{..} + = object + (catMaybes + [Just ("ResourceArn" .= _urResourceARN), + Just ("TagKeys" .= _urTagKeys)]) + +instance ToPath UntagResource where + toPath = const "/" + +instance ToQuery UntagResource where + toQuery = const mempty + +-- | /See:/ 'untagResourceResponse' smart constructor. +data UntagResourceResponse = + UntagResourceResponse' + deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'UntagResourceResponse' with the minimum fields required to make a request. +-- +untagResourceResponse + :: UntagResourceResponse +untagResourceResponse = UntagResourceResponse' + + +instance NFData UntagResourceResponse where diff --git a/gen/Network/AWS/DynamoDB/UpdateItem.hs b/gen/Network/AWS/DynamoDB/UpdateItem.hs --- a/gen/Network/AWS/DynamoDB/UpdateItem.hs +++ b/gen/Network/AWS/DynamoDB/UpdateItem.hs @@ -12,16 +12,16 @@ -- | -- Module : Network.AWS.DynamoDB.UpdateItem --- Copyright : (c) 2013-2016 Brendan Hay +-- Copyright : (c) 2013-2017 Brendan Hay -- License : Mozilla Public License, v. 2.0. --- Maintainer : Brendan Hay +-- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values). -- -- --- You can also return the item's attribute values in the same /UpdateItem/ operation using the /ReturnValues/ parameter. +-- You can also return the item's attribute values in the same @UpdateItem@ operation using the @ReturnValues@ parameter. -- module Network.AWS.DynamoDB.UpdateItem ( @@ -52,56 +52,57 @@ , uirsResponseStatus ) where -import Network.AWS.DynamoDB.Types -import Network.AWS.DynamoDB.Types.Product -import Network.AWS.Lens -import Network.AWS.Prelude -import Network.AWS.Request -import Network.AWS.Response +import Network.AWS.DynamoDB.Types +import Network.AWS.DynamoDB.Types.Product +import Network.AWS.Lens +import Network.AWS.Prelude +import Network.AWS.Request +import Network.AWS.Response --- | Represents the input of an /UpdateItem/ operation. +-- | Represents the input of an @UpdateItem@ operation. -- -- -- -- /See:/ 'updateItem' smart constructor. data UpdateItem = UpdateItem' - { _uiExpressionAttributeNames :: !(Maybe (Map Text Text)) - , _uiReturnValues :: !(Maybe ReturnValue) - , _uiUpdateExpression :: !(Maybe Text) - , _uiExpressionAttributeValues :: !(Maybe (Map Text AttributeValue)) - , _uiAttributeUpdates :: !(Maybe (Map Text AttributeValueUpdate)) - , _uiReturnConsumedCapacity :: !(Maybe ReturnConsumedCapacity) - , _uiReturnItemCollectionMetrics :: !(Maybe ReturnItemCollectionMetrics) - , _uiConditionExpression :: !(Maybe Text) - , _uiConditionalOperator :: !(Maybe ConditionalOperator) - , _uiExpected :: !(Maybe (Map Text ExpectedAttributeValue)) - , _uiTableName :: !Text - , _uiKey :: !(Map Text AttributeValue) - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _uiExpressionAttributeNames :: !(Maybe (Map Text Text)) + , _uiReturnValues :: !(Maybe ReturnValue) + , _uiUpdateExpression :: !(Maybe Text) + , _uiExpressionAttributeValues :: !(Maybe (Map Text AttributeValue)) + , _uiAttributeUpdates :: !(Maybe (Map Text AttributeValueUpdate)) + , _uiReturnConsumedCapacity :: !(Maybe ReturnConsumedCapacity) + , _uiReturnItemCollectionMetrics :: !(Maybe ReturnItemCollectionMetrics) + , _uiConditionExpression :: !(Maybe Text) + , _uiConditionalOperator :: !(Maybe ConditionalOperator) + , _uiExpected :: !(Maybe (Map Text ExpectedAttributeValue)) + , _uiTableName :: !Text + , _uiKey :: !(Map Text AttributeValue) + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'UpdateItem' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'uiExpressionAttributeNames' - 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for /ExpressionAttributeNames/ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . +-- * 'uiExpressionAttributeNames' - 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for @ExpressionAttributeNames@ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . -- --- * 'uiReturnValues' - Use /ReturnValues/ if you want to get the item attributes as they appeared either before or after they were updated. For /UpdateItem/ , the valid values are: * @NONE@ - If /ReturnValues/ is not specified, or if its value is @NONE@ , then nothing is returned. (This setting is the default for /ReturnValues/ .) * @ALL_OLD@ - If /UpdateItem/ overwrote an attribute name-value pair, then the content of the old item is returned. * @UPDATED_OLD@ - The old versions of only the updated attributes are returned. * @ALL_NEW@ - All of the attributes of the new version of the item are returned. * @UPDATED_NEW@ - The new versions of only the updated attributes are returned. There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed. Values returned are strongly consistent +-- * 'uiReturnValues' - Use @ReturnValues@ if you want to get the item attributes as they appear before or after they are updated. For @UpdateItem@ , the valid values are: * @NONE@ - If @ReturnValues@ is not specified, or if its value is @NONE@ , then nothing is returned. (This setting is the default for @ReturnValues@ .) * @ALL_OLD@ - Returns all of the attributes of the item, as they appeared before the UpdateItem operation. * @UPDATED_OLD@ - Returns only the updated attributes, as they appeared before the UpdateItem operation. * @ALL_NEW@ - Returns all of the attributes of the item, as they appear after the UpdateItem operation. * @UPDATED_NEW@ - Returns only the updated attributes, as they appear after the UpdateItem operation. There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed. The values returned are strongly consistent. -- --- * 'uiUpdateExpression' - An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them. The following action values are available for /UpdateExpression/ . * @SET@ - Adds one or more attributes and values to an item. If any of these attribute already exist, they are replaced by the new values. You can also use @SET@ to add or subtract from an attribute that is of type Number. For example: @SET myNum = myNum + :val@ @SET@ supports the following functions: * @if_not_exists (path, operand)@ - if the item does not contain an attribute at the specified path, then @if_not_exists@ evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item. * @list_append (operand, operand)@ - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands. These function names are case-sensitive. * @REMOVE@ - Removes one or more attributes from an item. * @ADD@ - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of @ADD@ depends on the data type of the attribute: * If the existing attribute is a number, and if /Value/ is also a number, then /Value/ is mathematically added to the existing attribute. If /Value/ is a negative number, then it is subtracted from the existing attribute. * If the existing data type is a set and if /Value/ is also a set, then /Value/ is added to the existing set. For example, if the attribute value is the set @[1,2]@ , and the @ADD@ action specified @[3]@ , then the final attribute value is @[1,2,3]@ . An error occurs if an @ADD@ action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the /Value/ must also be a set of strings. /Important:/ The @ADD@ action only supports Number and set data types. In addition, @ADD@ can only be used on top-level attributes, not nested attributes. * @DELETE@ - Deletes an element from a set. If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set @[a,b,c]@ and the @DELETE@ action specifies @[a,c]@ , then the final attribute value is @[b]@ . Specifying an empty set is an error. /Important:/ The @DELETE@ action only supports set data types. In addition, @DELETE@ can only be used on top-level attributes, not nested attributes. You can have many actions in a single expression, such as the following: @SET a=:value1, b=:value2 DELETE :value3, :value4, :value5@ For more information on update expressions, see in the /Amazon DynamoDB Developer Guide/ . +-- * 'uiUpdateExpression' - An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them. The following action values are available for @UpdateExpression@ . * @SET@ - Adds one or more attributes and values to an item. If any of these attribute already exist, they are replaced by the new values. You can also use @SET@ to add or subtract from an attribute that is of type Number. For example: @SET myNum = myNum + :val@ @SET@ supports the following functions: * @if_not_exists (path, operand)@ - if the item does not contain an attribute at the specified path, then @if_not_exists@ evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item. * @list_append (operand, operand)@ - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands. These function names are case-sensitive. * @REMOVE@ - Removes one or more attributes from an item. * @ADD@ - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of @ADD@ depends on the data type of the attribute: * If the existing attribute is a number, and if @Value@ is also a number, then @Value@ is mathematically added to the existing attribute. If @Value@ is a negative number, then it is subtracted from the existing attribute. * If the existing data type is a set and if @Value@ is also a set, then @Value@ is added to the existing set. For example, if the attribute value is the set @[1,2]@ , and the @ADD@ action specified @[3]@ , then the final attribute value is @[1,2,3]@ . An error occurs if an @ADD@ action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the @Value@ must also be a set of strings. /Important:/ The @ADD@ action only supports Number and set data types. In addition, @ADD@ can only be used on top-level attributes, not nested attributes. * @DELETE@ - Deletes an element from a set. If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set @[a,b,c]@ and the @DELETE@ action specifies @[a,c]@ , then the final attribute value is @[b]@ . Specifying an empty set is an error. /Important:/ The @DELETE@ action only supports set data types. In addition, @DELETE@ can only be used on top-level attributes, not nested attributes. You can have many actions in a single expression, such as the following: @SET a=:value1, b=:value2 DELETE :value3, :value4, :value5@ For more information on update expressions, see in the /Amazon DynamoDB Developer Guide/ . -- --- * 'uiExpressionAttributeValues' - 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 in the /Amazon DynamoDB Developer Guide/ . +-- * 'uiExpressionAttributeValues' - 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 in the /Amazon DynamoDB Developer Guide/ . -- --- * 'uiAttributeUpdates' - /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /UpdateExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements. The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the /AttributesDefinition/ of the table description. You can use /UpdateItem/ to update any non-key attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a /ValidationException/ exception. Each /AttributeUpdates/ element consists of an attribute name to modify, along with the following: * /Value/ - The new value, if applicable, for this attribute. * /Action/ - A value that specifies how to perform the update. This action is only valid for an existing attribute whose data type is Number or is a set; do not use @ADD@ for other data types. If an item with the specified primary key is found in the table, the following values perform the following actions: * @PUT@ - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. * @DELETE@ - Removes the attribute and its value, if no value is specified for @DELETE@ . The data type of the specified value must match the existing value's data type. If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set @[a,b,c]@ and the @DELETE@ action specifies @[a,c]@ , then the final attribute value is @[b]@ . Specifying an empty set is an error. * @ADD@ - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of @ADD@ depends on the data type of the attribute: * If the existing attribute is a number, and if /Value/ is also a number, then /Value/ is mathematically added to the existing attribute. If /Value/ is a negative number, then it is subtracted from the existing attribute. * If the existing data type is a set, and if /Value/ is also a set, then /Value/ is appended to the existing set. For example, if the attribute value is the set @[1,2]@ , and the @ADD@ action specified @[3]@ , then the final attribute value is @[1,2,3]@ . An error occurs if an @ADD@ action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, /Value/ must also be a set of strings. If no item with the specified key is found in the table, the following values perform the following actions: * @PUT@ - Causes DynamoDB to create a new item with the specified primary key, and then adds the attribute. * @DELETE@ - Nothing happens, because attributes cannot be deleted from a nonexistent item. The operation succeeds, but DynamoDB does not create a new item. * @ADD@ - Causes DynamoDB to create an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are Number and Number Set. If you provide any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. +-- * 'uiAttributeUpdates' - This is a legacy parameter. Use @UpdateExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . -- -- * 'uiReturnConsumedCapacity' - Undocumented member. -- -- * 'uiReturnItemCollectionMetrics' - Determines whether item collection metrics are returned. If set to @SIZE@ , the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to @NONE@ (the default), no statistics are returned. -- --- * 'uiConditionExpression' - A condition that must be satisfied in order for a conditional update to succeed. An expression can contain any of the following: * Functions: @attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size@ These function names are case-sensitive. * Comparison operators: @= | <> | < | > | <= | >= | BETWEEN | IN@ * Logical operators: @AND | OR | NOT@ For more information on condition expressions, see in the /Amazon DynamoDB Developer Guide/ . +-- * 'uiConditionExpression' - A condition that must be satisfied in order for a conditional update to succeed. An expression can contain any of the following: * Functions: @attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size@ These function names are case-sensitive. * Comparison operators: @= | <> | < | > | <= | >= | BETWEEN | IN @ * Logical operators: @AND | OR | NOT@ For more information on condition expressions, see in the /Amazon DynamoDB Developer Guide/ . -- --- * 'uiConditionalOperator' - /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /ConditionExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. A logical operator to apply to the conditions in the /Expected/ map: * @AND@ - If all of the conditions evaluate to true, then the entire map evaluates to true. * @OR@ - If at least one of the conditions evaluate to true, then the entire map evaluates to true. If you omit /ConditionalOperator/ , then @AND@ is the default. The operation will succeed only if the entire map evaluates to true. +-- * 'uiConditionalOperator' - This is a legacy parameter. Use @ConditionExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . -- --- * 'uiExpected' - /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /ConditionExpression / instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. A map of attribute/condition pairs. /Expected/ provides a conditional block for the /UpdateItem/ operation. Each element of /Expected/ consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each /Expected/ element, the result of the evaluation is either true or false. If you specify more than one element in the /Expected/ map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the /ConditionalOperator/ parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.) If the /Expected/ map evaluates to true, then the conditional operation succeeds; otherwise, it fails. /Expected/ contains the following: * /AttributeValueList/ - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the /ComparisonOperator/ being used. For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, @a@ is greater than @A@ , and @a@ is greater than @B@ . For a list of code values, see . For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. * /ComparisonOperator/ - A comparator for evaluating attributes in the /AttributeValueList/ . When performing the comparison, DynamoDB uses strongly consistent reads. The following comparison operators are available: @EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN@ The following are descriptions of each comparison operator. * @EQ@ : Equal. @EQ@ is supported for all datatypes, including lists and maps. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @NE@ : Not equal. @NE@ is supported for all datatypes, including lists and maps. /AttributeValueList/ can contain only one /AttributeValue/ of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an /AttributeValue/ of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @LE@ : Less than or equal. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @LT@ : Less than. /AttributeValueList/ can contain only one /AttributeValue/ of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GE@ : Greater than or equal. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GT@ : Greater than. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @NOT_NULL@ : The attribute exists. @NOT_NULL@ is supported for all datatypes, including lists and maps. * @NULL@ : The attribute does not exist. @NULL@ is supported for all datatypes, including lists and maps. * @CONTAINS@ : Checks for a subsequence, or value in a set. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it finds an exact match with any member of the set. CONTAINS is supported for lists: When evaluating "@a CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @NOT_CONTAINS@ : Checks for absence of a subsequence, or absence of a value in a set. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it /does not/ find an exact match with any member of the set. NOT_CONTAINS is supported for lists: When evaluating "@a NOT CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @BEGINS_WITH@ : Checks for a prefix. /AttributeValueList/ can contain only one /AttributeValue/ of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). * @IN@ : Checks for matching elements within two sets. /AttributeValueList/ can contain one or more /AttributeValue/ elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true. * @BETWEEN@ : Greater than or equal to the first value, and less than or equal to the second value. /AttributeValueList/ must contain two /AttributeValue/ elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not compare to @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ For usage examples of /AttributeValueList/ and /ComparisonOperator/ , see in the /Amazon DynamoDB Developer Guide/ . For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of /AttributeValueList/ and /ComparisonOperator/ : * /Value/ - A value for DynamoDB to compare with an attribute. * /Exists/ - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation: * If /Exists/ is @true@ , DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false. * If /Exists/ is @false@ , DynamoDB assumes that the attribute value does /not/ exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false. Note that the default value for /Exists/ is @true@ . The /Value/ and /Exists/ parameters are incompatible with /AttributeValueList/ and /ComparisonOperator/ . Note that if you use both sets of parameters at once, DynamoDB will return a /ValidationException/ exception. +-- * 'uiExpected' - This is a legacy parameter. Use @ConditionExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . -- -- * 'uiTableName' - The name of the table containing the item to update. -- @@ -110,38 +111,39 @@ :: Text -- ^ 'uiTableName' -> UpdateItem updateItem pTableName_ = - UpdateItem' - { _uiExpressionAttributeNames = Nothing - , _uiReturnValues = Nothing - , _uiUpdateExpression = Nothing - , _uiExpressionAttributeValues = Nothing - , _uiAttributeUpdates = Nothing - , _uiReturnConsumedCapacity = Nothing - , _uiReturnItemCollectionMetrics = Nothing - , _uiConditionExpression = Nothing - , _uiConditionalOperator = Nothing - , _uiExpected = Nothing - , _uiTableName = pTableName_ - , _uiKey = mempty - } + UpdateItem' + { _uiExpressionAttributeNames = Nothing + , _uiReturnValues = Nothing + , _uiUpdateExpression = Nothing + , _uiExpressionAttributeValues = Nothing + , _uiAttributeUpdates = Nothing + , _uiReturnConsumedCapacity = Nothing + , _uiReturnItemCollectionMetrics = Nothing + , _uiConditionExpression = Nothing + , _uiConditionalOperator = Nothing + , _uiExpected = Nothing + , _uiTableName = pTableName_ + , _uiKey = mempty + } --- | 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for /ExpressionAttributeNames/ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . + +-- | 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 in the /Amazon DynamoDB Developer Guide/ ). To work around this, you could specify the following for @ExpressionAttributeNames@ : * @{"#P":"Percentile"}@ You could then use this substitution in an expression, as in this example: * @#P = :val@ For more information on expression attribute names, see in the /Amazon DynamoDB Developer Guide/ . uiExpressionAttributeNames :: Lens' UpdateItem (HashMap Text Text) uiExpressionAttributeNames = lens _uiExpressionAttributeNames (\ s a -> s{_uiExpressionAttributeNames = a}) . _Default . _Map; --- | Use /ReturnValues/ if you want to get the item attributes as they appeared either before or after they were updated. For /UpdateItem/ , the valid values are: * @NONE@ - If /ReturnValues/ is not specified, or if its value is @NONE@ , then nothing is returned. (This setting is the default for /ReturnValues/ .) * @ALL_OLD@ - If /UpdateItem/ overwrote an attribute name-value pair, then the content of the old item is returned. * @UPDATED_OLD@ - The old versions of only the updated attributes are returned. * @ALL_NEW@ - All of the attributes of the new version of the item are returned. * @UPDATED_NEW@ - The new versions of only the updated attributes are returned. There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed. Values returned are strongly consistent +-- | Use @ReturnValues@ if you want to get the item attributes as they appear before or after they are updated. For @UpdateItem@ , the valid values are: * @NONE@ - If @ReturnValues@ is not specified, or if its value is @NONE@ , then nothing is returned. (This setting is the default for @ReturnValues@ .) * @ALL_OLD@ - Returns all of the attributes of the item, as they appeared before the UpdateItem operation. * @UPDATED_OLD@ - Returns only the updated attributes, as they appeared before the UpdateItem operation. * @ALL_NEW@ - Returns all of the attributes of the item, as they appear after the UpdateItem operation. * @UPDATED_NEW@ - Returns only the updated attributes, as they appear after the UpdateItem operation. There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed. The values returned are strongly consistent. uiReturnValues :: Lens' UpdateItem (Maybe ReturnValue) uiReturnValues = lens _uiReturnValues (\ s a -> s{_uiReturnValues = a}); --- | An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them. The following action values are available for /UpdateExpression/ . * @SET@ - Adds one or more attributes and values to an item. If any of these attribute already exist, they are replaced by the new values. You can also use @SET@ to add or subtract from an attribute that is of type Number. For example: @SET myNum = myNum + :val@ @SET@ supports the following functions: * @if_not_exists (path, operand)@ - if the item does not contain an attribute at the specified path, then @if_not_exists@ evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item. * @list_append (operand, operand)@ - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands. These function names are case-sensitive. * @REMOVE@ - Removes one or more attributes from an item. * @ADD@ - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of @ADD@ depends on the data type of the attribute: * If the existing attribute is a number, and if /Value/ is also a number, then /Value/ is mathematically added to the existing attribute. If /Value/ is a negative number, then it is subtracted from the existing attribute. * If the existing data type is a set and if /Value/ is also a set, then /Value/ is added to the existing set. For example, if the attribute value is the set @[1,2]@ , and the @ADD@ action specified @[3]@ , then the final attribute value is @[1,2,3]@ . An error occurs if an @ADD@ action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the /Value/ must also be a set of strings. /Important:/ The @ADD@ action only supports Number and set data types. In addition, @ADD@ can only be used on top-level attributes, not nested attributes. * @DELETE@ - Deletes an element from a set. If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set @[a,b,c]@ and the @DELETE@ action specifies @[a,c]@ , then the final attribute value is @[b]@ . Specifying an empty set is an error. /Important:/ The @DELETE@ action only supports set data types. In addition, @DELETE@ can only be used on top-level attributes, not nested attributes. You can have many actions in a single expression, such as the following: @SET a=:value1, b=:value2 DELETE :value3, :value4, :value5@ For more information on update expressions, see in the /Amazon DynamoDB Developer Guide/ . +-- | An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them. The following action values are available for @UpdateExpression@ . * @SET@ - Adds one or more attributes and values to an item. If any of these attribute already exist, they are replaced by the new values. You can also use @SET@ to add or subtract from an attribute that is of type Number. For example: @SET myNum = myNum + :val@ @SET@ supports the following functions: * @if_not_exists (path, operand)@ - if the item does not contain an attribute at the specified path, then @if_not_exists@ evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item. * @list_append (operand, operand)@ - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands. These function names are case-sensitive. * @REMOVE@ - Removes one or more attributes from an item. * @ADD@ - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of @ADD@ depends on the data type of the attribute: * If the existing attribute is a number, and if @Value@ is also a number, then @Value@ is mathematically added to the existing attribute. If @Value@ is a negative number, then it is subtracted from the existing attribute. * If the existing data type is a set and if @Value@ is also a set, then @Value@ is added to the existing set. For example, if the attribute value is the set @[1,2]@ , and the @ADD@ action specified @[3]@ , then the final attribute value is @[1,2,3]@ . An error occurs if an @ADD@ action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the @Value@ must also be a set of strings. /Important:/ The @ADD@ action only supports Number and set data types. In addition, @ADD@ can only be used on top-level attributes, not nested attributes. * @DELETE@ - Deletes an element from a set. If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set @[a,b,c]@ and the @DELETE@ action specifies @[a,c]@ , then the final attribute value is @[b]@ . Specifying an empty set is an error. /Important:/ The @DELETE@ action only supports set data types. In addition, @DELETE@ can only be used on top-level attributes, not nested attributes. You can have many actions in a single expression, such as the following: @SET a=:value1, b=:value2 DELETE :value3, :value4, :value5@ For more information on update expressions, see in the /Amazon DynamoDB Developer Guide/ . uiUpdateExpression :: Lens' UpdateItem (Maybe Text) uiUpdateExpression = lens _uiUpdateExpression (\ s a -> s{_uiUpdateExpression = a}); --- | 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 in the /Amazon DynamoDB Developer Guide/ . +-- | 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 in the /Amazon DynamoDB Developer Guide/ . uiExpressionAttributeValues :: Lens' UpdateItem (HashMap Text AttributeValue) uiExpressionAttributeValues = lens _uiExpressionAttributeValues (\ s a -> s{_uiExpressionAttributeValues = a}) . _Default . _Map; --- | /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /UpdateExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements. The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the /AttributesDefinition/ of the table description. You can use /UpdateItem/ to update any non-key attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a /ValidationException/ exception. Each /AttributeUpdates/ element consists of an attribute name to modify, along with the following: * /Value/ - The new value, if applicable, for this attribute. * /Action/ - A value that specifies how to perform the update. This action is only valid for an existing attribute whose data type is Number or is a set; do not use @ADD@ for other data types. If an item with the specified primary key is found in the table, the following values perform the following actions: * @PUT@ - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. * @DELETE@ - Removes the attribute and its value, if no value is specified for @DELETE@ . The data type of the specified value must match the existing value's data type. If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set @[a,b,c]@ and the @DELETE@ action specifies @[a,c]@ , then the final attribute value is @[b]@ . Specifying an empty set is an error. * @ADD@ - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of @ADD@ depends on the data type of the attribute: * If the existing attribute is a number, and if /Value/ is also a number, then /Value/ is mathematically added to the existing attribute. If /Value/ is a negative number, then it is subtracted from the existing attribute. * If the existing data type is a set, and if /Value/ is also a set, then /Value/ is appended to the existing set. For example, if the attribute value is the set @[1,2]@ , and the @ADD@ action specified @[3]@ , then the final attribute value is @[1,2,3]@ . An error occurs if an @ADD@ action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, /Value/ must also be a set of strings. If no item with the specified key is found in the table, the following values perform the following actions: * @PUT@ - Causes DynamoDB to create a new item with the specified primary key, and then adds the attribute. * @DELETE@ - Nothing happens, because attributes cannot be deleted from a nonexistent item. The operation succeeds, but DynamoDB does not create a new item. * @ADD@ - Causes DynamoDB to create an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are Number and Number Set. If you provide any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. +-- | This is a legacy parameter. Use @UpdateExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . uiAttributeUpdates :: Lens' UpdateItem (HashMap Text AttributeValueUpdate) uiAttributeUpdates = lens _uiAttributeUpdates (\ s a -> s{_uiAttributeUpdates = a}) . _Default . _Map; @@ -153,15 +155,15 @@ uiReturnItemCollectionMetrics :: Lens' UpdateItem (Maybe ReturnItemCollectionMetrics) uiReturnItemCollectionMetrics = lens _uiReturnItemCollectionMetrics (\ s a -> s{_uiReturnItemCollectionMetrics = a}); --- | A condition that must be satisfied in order for a conditional update to succeed. An expression can contain any of the following: * Functions: @attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size@ These function names are case-sensitive. * Comparison operators: @= | <> | < | > | <= | >= | BETWEEN | IN@ * Logical operators: @AND | OR | NOT@ For more information on condition expressions, see in the /Amazon DynamoDB Developer Guide/ . +-- | A condition that must be satisfied in order for a conditional update to succeed. An expression can contain any of the following: * Functions: @attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size@ These function names are case-sensitive. * Comparison operators: @= | <> | < | > | <= | >= | BETWEEN | IN @ * Logical operators: @AND | OR | NOT@ For more information on condition expressions, see in the /Amazon DynamoDB Developer Guide/ . uiConditionExpression :: Lens' UpdateItem (Maybe Text) uiConditionExpression = lens _uiConditionExpression (\ s a -> s{_uiConditionExpression = a}); --- | /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /ConditionExpression/ instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. A logical operator to apply to the conditions in the /Expected/ map: * @AND@ - If all of the conditions evaluate to true, then the entire map evaluates to true. * @OR@ - If at least one of the conditions evaluate to true, then the entire map evaluates to true. If you omit /ConditionalOperator/ , then @AND@ is the default. The operation will succeed only if the entire map evaluates to true. +-- | This is a legacy parameter. Use @ConditionExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . uiConditionalOperator :: Lens' UpdateItem (Maybe ConditionalOperator) uiConditionalOperator = lens _uiConditionalOperator (\ s a -> s{_uiConditionalOperator = a}); --- | /Important:/ This is a legacy parameter, for backward compatibility. New applications should use /ConditionExpression / instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a /ValidationException/ exception. A map of attribute/condition pairs. /Expected/ provides a conditional block for the /UpdateItem/ operation. Each element of /Expected/ consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each /Expected/ element, the result of the evaluation is either true or false. If you specify more than one element in the /Expected/ map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the /ConditionalOperator/ parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.) If the /Expected/ map evaluates to true, then the conditional operation succeeds; otherwise, it fails. /Expected/ contains the following: * /AttributeValueList/ - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the /ComparisonOperator/ being used. For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, @a@ is greater than @A@ , and @a@ is greater than @B@ . For a list of code values, see . For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. * /ComparisonOperator/ - A comparator for evaluating attributes in the /AttributeValueList/ . When performing the comparison, DynamoDB uses strongly consistent reads. The following comparison operators are available: @EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN@ The following are descriptions of each comparison operator. * @EQ@ : Equal. @EQ@ is supported for all datatypes, including lists and maps. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @NE@ : Not equal. @NE@ is supported for all datatypes, including lists and maps. /AttributeValueList/ can contain only one /AttributeValue/ of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an /AttributeValue/ of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not equal @{"NS":["6", "2", "1"]}@ . * @LE@ : Less than or equal. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @LT@ : Less than. /AttributeValueList/ can contain only one /AttributeValue/ of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GE@ : Greater than or equal. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @GT@ : Greater than. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not equal @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ . * @NOT_NULL@ : The attribute exists. @NOT_NULL@ is supported for all datatypes, including lists and maps. * @NULL@ : The attribute does not exist. @NULL@ is supported for all datatypes, including lists and maps. * @CONTAINS@ : Checks for a subsequence, or value in a set. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it finds an exact match with any member of the set. CONTAINS is supported for lists: When evaluating "@a CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @NOT_CONTAINS@ : Checks for absence of a subsequence, or absence of a value in a set. /AttributeValueList/ can contain only one /AttributeValue/ element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("@SS@ ", "@NS@ ", or "@BS@ "), then the operator evaluates to true if it /does not/ find an exact match with any member of the set. NOT_CONTAINS is supported for lists: When evaluating "@a NOT CONTAINS b@ ", "@a@ " can be a list; however, "@b@ " cannot be a set, a map, or a list. * @BEGINS_WITH@ : Checks for a prefix. /AttributeValueList/ can contain only one /AttributeValue/ of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). * @IN@ : Checks for matching elements within two sets. /AttributeValueList/ can contain one or more /AttributeValue/ elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true. * @BETWEEN@ : Greater than or equal to the first value, and less than or equal to the second value. /AttributeValueList/ must contain two /AttributeValue/ elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an /AttributeValue/ element of a different type than the one provided in the request, the value does not match. For example, @{"S":"6"}@ does not compare to @{"N":"6"}@ . Also, @{"N":"6"}@ does not compare to @{"NS":["6", "2", "1"]}@ For usage examples of /AttributeValueList/ and /ComparisonOperator/ , see in the /Amazon DynamoDB Developer Guide/ . For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of /AttributeValueList/ and /ComparisonOperator/ : * /Value/ - A value for DynamoDB to compare with an attribute. * /Exists/ - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation: * If /Exists/ is @true@ , DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false. * If /Exists/ is @false@ , DynamoDB assumes that the attribute value does /not/ exist in the table. If in fact the value does not exist, then the assumption is valid and the condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false. Note that the default value for /Exists/ is @true@ . The /Value/ and /Exists/ parameters are incompatible with /AttributeValueList/ and /ComparisonOperator/ . Note that if you use both sets of parameters at once, DynamoDB will return a /ValidationException/ exception. +-- | This is a legacy parameter. Use @ConditionExpression@ instead. For more information, see in the /Amazon DynamoDB Developer Guide/ . uiExpected :: Lens' UpdateItem (HashMap Text ExpectedAttributeValue) uiExpected = lens _uiExpected (\ s a -> s{_uiExpected = a}) . _Default . _Map; @@ -185,9 +187,9 @@ <*> (x .?> "Attributes" .!@ mempty) <*> (pure (fromEnum s))) -instance Hashable UpdateItem +instance Hashable UpdateItem where -instance NFData UpdateItem +instance NFData UpdateItem where instance ToHeaders UpdateItem where toHeaders @@ -227,49 +229,51 @@ instance ToQuery UpdateItem where toQuery = const mempty --- | Represents the output of an /UpdateItem/ operation. +-- | Represents the output of an @UpdateItem@ operation. -- -- -- -- /See:/ 'updateItemResponse' smart constructor. data UpdateItemResponse = UpdateItemResponse' - { _uirsItemCollectionMetrics :: !(Maybe ItemCollectionMetrics) - , _uirsConsumedCapacity :: !(Maybe ConsumedCapacity) - , _uirsAttributes :: !(Maybe (Map Text AttributeValue)) - , _uirsResponseStatus :: !Int - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _uirsItemCollectionMetrics :: !(Maybe ItemCollectionMetrics) + , _uirsConsumedCapacity :: !(Maybe ConsumedCapacity) + , _uirsAttributes :: !(Maybe (Map Text AttributeValue)) + , _uirsResponseStatus :: !Int + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'UpdateItemResponse' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'uirsItemCollectionMetrics' - Undocumented member. +-- * 'uirsItemCollectionMetrics' - Information about item collections, if any, that were affected by the @UpdateItem@ operation. @ItemCollectionMetrics@ is only returned if the @ReturnItemCollectionMetrics@ parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response. Each @ItemCollectionMetrics@ element consists of: * @ItemCollectionKey@ - The partition key value of the item collection. This is the same as the partition key value of the item itself. * @SizeEstimateRange@ - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. -- --- * 'uirsConsumedCapacity' - Undocumented member. +-- * 'uirsConsumedCapacity' - The capacity units consumed by the @UpdateItem@ 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 in the /Amazon DynamoDB Developer Guide/ . -- --- * 'uirsAttributes' - A map of attribute values as they appeared before the /UpdateItem/ operation. This map only appears if /ReturnValues/ was specified as something other than @NONE@ in the request. Each element represents one attribute. +-- * 'uirsAttributes' - A map of attribute values as they appear before or after the @UpdateItem@ operation, as determined by the @ReturnValues@ parameter. The @Attributes@ map is only present if @ReturnValues@ was specified as something other than @NONE@ in the request. Each element represents one attribute. -- -- * 'uirsResponseStatus' - -- | The response status code. updateItemResponse :: Int -- ^ 'uirsResponseStatus' -> UpdateItemResponse updateItemResponse pResponseStatus_ = - UpdateItemResponse' - { _uirsItemCollectionMetrics = Nothing - , _uirsConsumedCapacity = Nothing - , _uirsAttributes = Nothing - , _uirsResponseStatus = pResponseStatus_ - } + UpdateItemResponse' + { _uirsItemCollectionMetrics = Nothing + , _uirsConsumedCapacity = Nothing + , _uirsAttributes = Nothing + , _uirsResponseStatus = pResponseStatus_ + } --- | Undocumented member. + +-- | Information about item collections, if any, that were affected by the @UpdateItem@ operation. @ItemCollectionMetrics@ is only returned if the @ReturnItemCollectionMetrics@ parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response. Each @ItemCollectionMetrics@ element consists of: * @ItemCollectionKey@ - The partition key value of the item collection. This is the same as the partition key value of the item itself. * @SizeEstimateRange@ - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. uirsItemCollectionMetrics :: Lens' UpdateItemResponse (Maybe ItemCollectionMetrics) uirsItemCollectionMetrics = lens _uirsItemCollectionMetrics (\ s a -> s{_uirsItemCollectionMetrics = a}); --- | Undocumented member. +-- | The capacity units consumed by the @UpdateItem@ 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 in the /Amazon DynamoDB Developer Guide/ . uirsConsumedCapacity :: Lens' UpdateItemResponse (Maybe ConsumedCapacity) uirsConsumedCapacity = lens _uirsConsumedCapacity (\ s a -> s{_uirsConsumedCapacity = a}); --- | A map of attribute values as they appeared before the /UpdateItem/ operation. This map only appears if /ReturnValues/ was specified as something other than @NONE@ in the request. Each element represents one attribute. +-- | A map of attribute values as they appear before or after the @UpdateItem@ operation, as determined by the @ReturnValues@ parameter. The @Attributes@ map is only present if @ReturnValues@ was specified as something other than @NONE@ in the request. Each element represents one attribute. uirsAttributes :: Lens' UpdateItemResponse (HashMap Text AttributeValue) uirsAttributes = lens _uirsAttributes (\ s a -> s{_uirsAttributes = a}) . _Default . _Map; @@ -277,4 +281,4 @@ uirsResponseStatus :: Lens' UpdateItemResponse Int uirsResponseStatus = lens _uirsResponseStatus (\ s a -> s{_uirsResponseStatus = a}); -instance NFData UpdateItemResponse +instance NFData UpdateItemResponse where diff --git a/gen/Network/AWS/DynamoDB/UpdateTable.hs b/gen/Network/AWS/DynamoDB/UpdateTable.hs --- a/gen/Network/AWS/DynamoDB/UpdateTable.hs +++ b/gen/Network/AWS/DynamoDB/UpdateTable.hs @@ -12,9 +12,9 @@ -- | -- Module : Network.AWS.DynamoDB.UpdateTable --- Copyright : (c) 2013-2016 Brendan Hay +-- Copyright : (c) 2013-2017 Brendan Hay -- License : Mozilla Public License, v. 2.0. --- Maintainer : Brendan Hay +-- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- @@ -29,11 +29,11 @@ -- -- * Remove a global secondary index from the table. -- --- * Create a new global secondary index on the table. Once the index begins backfilling, you can use /UpdateTable/ to perform other operations. +-- * Create a new global secondary index on the table. Once the index begins backfilling, you can use @UpdateTable@ to perform other operations. -- -- -- --- /UpdateTable/ is an asynchronous operation; while it is executing, the table status changes from @ACTIVE@ to @UPDATING@ . While it is @UPDATING@ , you cannot issue another /UpdateTable/ request. When the table returns to the @ACTIVE@ state, the /UpdateTable/ operation is complete. +-- @UpdateTable@ is an asynchronous operation; while it is executing, the table status changes from @ACTIVE@ to @UPDATING@ . While it is @UPDATING@ , you cannot issue another @UpdateTable@ request. When the table returns to the @ACTIVE@ state, the @UpdateTable@ operation is complete. -- module Network.AWS.DynamoDB.UpdateTable ( @@ -55,35 +55,36 @@ , utrsResponseStatus ) where -import Network.AWS.DynamoDB.Types -import Network.AWS.DynamoDB.Types.Product -import Network.AWS.Lens -import Network.AWS.Prelude -import Network.AWS.Request -import Network.AWS.Response +import Network.AWS.DynamoDB.Types +import Network.AWS.DynamoDB.Types.Product +import Network.AWS.Lens +import Network.AWS.Prelude +import Network.AWS.Request +import Network.AWS.Response --- | Represents the input of an /UpdateTable/ operation. +-- | Represents the input of an @UpdateTable@ operation. -- -- -- -- /See:/ 'updateTable' smart constructor. data UpdateTable = UpdateTable' - { _utAttributeDefinitions :: !(Maybe [AttributeDefinition]) - , _utProvisionedThroughput :: !(Maybe ProvisionedThroughput) - , _utGlobalSecondaryIndexUpdates :: !(Maybe [GlobalSecondaryIndexUpdate]) - , _utStreamSpecification :: !(Maybe StreamSpecification) - , _utTableName :: !Text - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _utAttributeDefinitions :: !(Maybe [AttributeDefinition]) + , _utProvisionedThroughput :: !(Maybe ProvisionedThroughput) + , _utGlobalSecondaryIndexUpdates :: !(Maybe [GlobalSecondaryIndexUpdate]) + , _utStreamSpecification :: !(Maybe StreamSpecification) + , _utTableName :: !Text + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'UpdateTable' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'utAttributeDefinitions' - An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, /AttributeDefinitions/ must include the key element(s) of the new index. +-- * 'utAttributeDefinitions' - An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, @AttributeDefinitions@ must include the key element(s) of the new index. -- --- * 'utProvisionedThroughput' - Undocumented member. +-- * 'utProvisionedThroughput' - The new provisioned throughput settings for the specified table or index. -- --- * 'utGlobalSecondaryIndexUpdates' - An array of one or more global secondary indexes for the table. For each index in the array, you can request one action: * /Create/ - add a new global secondary index to the table. * /Update/ - modify the provisioned throughput settings of an existing global secondary index. * /Delete/ - remove a global secondary index from the table. For more information, see in the /Amazon DynamoDB Developer Guide/ . +-- * 'utGlobalSecondaryIndexUpdates' - An array of one or more global secondary indexes for the table. For each index in the array, you can request one action: * @Create@ - add a new global secondary index to the table. * @Update@ - modify the provisioned throughput settings of an existing global secondary index. * @Delete@ - remove a global secondary index from the table. For more information, see in the /Amazon DynamoDB Developer Guide/ . -- -- * 'utStreamSpecification' - Represents the DynamoDB Streams configuration for the table. -- @@ -92,23 +93,24 @@ :: Text -- ^ 'utTableName' -> UpdateTable updateTable pTableName_ = - UpdateTable' - { _utAttributeDefinitions = Nothing - , _utProvisionedThroughput = Nothing - , _utGlobalSecondaryIndexUpdates = Nothing - , _utStreamSpecification = Nothing - , _utTableName = pTableName_ - } + UpdateTable' + { _utAttributeDefinitions = Nothing + , _utProvisionedThroughput = Nothing + , _utGlobalSecondaryIndexUpdates = Nothing + , _utStreamSpecification = Nothing + , _utTableName = pTableName_ + } --- | An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, /AttributeDefinitions/ must include the key element(s) of the new index. + +-- | An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, @AttributeDefinitions@ must include the key element(s) of the new index. utAttributeDefinitions :: Lens' UpdateTable [AttributeDefinition] utAttributeDefinitions = lens _utAttributeDefinitions (\ s a -> s{_utAttributeDefinitions = a}) . _Default . _Coerce; --- | Undocumented member. +-- | The new provisioned throughput settings for the specified table or index. utProvisionedThroughput :: Lens' UpdateTable (Maybe ProvisionedThroughput) utProvisionedThroughput = lens _utProvisionedThroughput (\ s a -> s{_utProvisionedThroughput = a}); --- | An array of one or more global secondary indexes for the table. For each index in the array, you can request one action: * /Create/ - add a new global secondary index to the table. * /Update/ - modify the provisioned throughput settings of an existing global secondary index. * /Delete/ - remove a global secondary index from the table. For more information, see in the /Amazon DynamoDB Developer Guide/ . +-- | An array of one or more global secondary indexes for the table. For each index in the array, you can request one action: * @Create@ - add a new global secondary index to the table. * @Update@ - modify the provisioned throughput settings of an existing global secondary index. * @Delete@ - remove a global secondary index from the table. For more information, see in the /Amazon DynamoDB Developer Guide/ . utGlobalSecondaryIndexUpdates :: Lens' UpdateTable [GlobalSecondaryIndexUpdate] utGlobalSecondaryIndexUpdates = lens _utGlobalSecondaryIndexUpdates (\ s a -> s{_utGlobalSecondaryIndexUpdates = a}) . _Default . _Coerce; @@ -129,9 +131,9 @@ UpdateTableResponse' <$> (x .?> "TableDescription") <*> (pure (fromEnum s))) -instance Hashable UpdateTable +instance Hashable UpdateTable where -instance NFData UpdateTable +instance NFData UpdateTable where instance ToHeaders UpdateTable where toHeaders @@ -162,33 +164,33 @@ instance ToQuery UpdateTable where toQuery = const mempty --- | Represents the output of an /UpdateTable/ operation. +-- | Represents the output of an @UpdateTable@ operation. -- -- -- -- /See:/ 'updateTableResponse' smart constructor. data UpdateTableResponse = UpdateTableResponse' - { _utrsTableDescription :: !(Maybe TableDescription) - , _utrsResponseStatus :: !Int - } deriving (Eq,Read,Show,Data,Typeable,Generic) + { _utrsTableDescription :: !(Maybe TableDescription) + , _utrsResponseStatus :: !Int + } deriving (Eq, Read, Show, Data, Typeable, Generic) + -- | Creates a value of 'UpdateTableResponse' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'utrsTableDescription' - Undocumented member. +-- * 'utrsTableDescription' - Represents the properties of the table. -- -- * 'utrsResponseStatus' - -- | The response status code. updateTableResponse :: Int -- ^ 'utrsResponseStatus' -> UpdateTableResponse updateTableResponse pResponseStatus_ = - UpdateTableResponse' - { _utrsTableDescription = Nothing - , _utrsResponseStatus = pResponseStatus_ - } + UpdateTableResponse' + {_utrsTableDescription = Nothing, _utrsResponseStatus = pResponseStatus_} --- | Undocumented member. + +-- | Represents the properties of the table. utrsTableDescription :: Lens' UpdateTableResponse (Maybe TableDescription) utrsTableDescription = lens _utrsTableDescription (\ s a -> s{_utrsTableDescription = a}); @@ -196,4 +198,4 @@ utrsResponseStatus :: Lens' UpdateTableResponse Int utrsResponseStatus = lens _utrsResponseStatus (\ s a -> s{_utrsResponseStatus = a}); -instance NFData UpdateTableResponse +instance NFData UpdateTableResponse where diff --git a/gen/Network/AWS/DynamoDB/UpdateTimeToLive.hs b/gen/Network/AWS/DynamoDB/UpdateTimeToLive.hs new file mode 100644 --- /dev/null +++ b/gen/Network/AWS/DynamoDB/UpdateTimeToLive.hs @@ -0,0 +1,165 @@ +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} +{-# LANGUAGE TypeFamilies #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} +{-# OPTIONS_GHC -fno-warn-unused-binds #-} +{-# OPTIONS_GHC -fno-warn-unused-matches #-} + +-- Derived from AWS service descriptions, licensed under Apache 2.0. + +-- | +-- Module : Network.AWS.DynamoDB.UpdateTimeToLive +-- Copyright : (c) 2013-2017 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +-- The UpdateTimeToLive method will enable or disable TTL for the specified table. A successful @UpdateTimeToLive@ call returns the current @TimeToLiveSpecification@ ; it may take up to one hour for the change to fully process. Any additional @UpdateTimeToLive@ calls for the same table during this one hour duration result in a @ValidationException@ . +-- +-- +-- TTL compares the current time in epoch time format to the time stored in the TTL attribute of an item. If the epoch time value stored in the attribute is less than the current time, the item is marked as expired and subsequently deleted. +-- +-- DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations. +-- +-- /Important:/ DynamoDB typically deletes expired items within two days of expiration. The exact duration within which an item gets deleted after expiration is specific to the nature of the workload. Items that have expired and not been deleted will still show up in reads, queries, and scans. +-- +-- As items are deleted, they are removed from any Local Secondary Index and Global Secondary Index immediately in the same eventually consistent way as a standard delete operation. +-- +-- For more information, see in the Amazon DynamoDB Developer Guide. +-- +module Network.AWS.DynamoDB.UpdateTimeToLive + ( + -- * Creating a Request + updateTimeToLive + , UpdateTimeToLive + -- * Request Lenses + , uttlTableName + , uttlTimeToLiveSpecification + + -- * Destructuring the Response + , updateTimeToLiveResponse + , UpdateTimeToLiveResponse + -- * Response Lenses + , uttlrsTimeToLiveSpecification + , uttlrsResponseStatus + ) where + +import Network.AWS.DynamoDB.Types +import Network.AWS.DynamoDB.Types.Product +import Network.AWS.Lens +import Network.AWS.Prelude +import Network.AWS.Request +import Network.AWS.Response + +-- | Represents the input of an @UpdateTimeToLive@ operation. +-- +-- +-- +-- /See:/ 'updateTimeToLive' smart constructor. +data UpdateTimeToLive = UpdateTimeToLive' + { _uttlTableName :: !Text + , _uttlTimeToLiveSpecification :: !TimeToLiveSpecification + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'UpdateTimeToLive' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'uttlTableName' - The name of the table to be configured. +-- +-- * 'uttlTimeToLiveSpecification' - Represents the settings used to enable or disable Time to Live for the specified table. +updateTimeToLive + :: Text -- ^ 'uttlTableName' + -> TimeToLiveSpecification -- ^ 'uttlTimeToLiveSpecification' + -> UpdateTimeToLive +updateTimeToLive pTableName_ pTimeToLiveSpecification_ = + UpdateTimeToLive' + { _uttlTableName = pTableName_ + , _uttlTimeToLiveSpecification = pTimeToLiveSpecification_ + } + + +-- | The name of the table to be configured. +uttlTableName :: Lens' UpdateTimeToLive Text +uttlTableName = lens _uttlTableName (\ s a -> s{_uttlTableName = a}); + +-- | Represents the settings used to enable or disable Time to Live for the specified table. +uttlTimeToLiveSpecification :: Lens' UpdateTimeToLive TimeToLiveSpecification +uttlTimeToLiveSpecification = lens _uttlTimeToLiveSpecification (\ s a -> s{_uttlTimeToLiveSpecification = a}); + +instance AWSRequest UpdateTimeToLive where + type Rs UpdateTimeToLive = UpdateTimeToLiveResponse + request = postJSON dynamoDB + response + = receiveJSON + (\ s h x -> + UpdateTimeToLiveResponse' <$> + (x .?> "TimeToLiveSpecification") <*> + (pure (fromEnum s))) + +instance Hashable UpdateTimeToLive where + +instance NFData UpdateTimeToLive where + +instance ToHeaders UpdateTimeToLive where + toHeaders + = const + (mconcat + ["X-Amz-Target" =# + ("DynamoDB_20120810.UpdateTimeToLive" :: ByteString), + "Content-Type" =# + ("application/x-amz-json-1.0" :: ByteString)]) + +instance ToJSON UpdateTimeToLive where + toJSON UpdateTimeToLive'{..} + = object + (catMaybes + [Just ("TableName" .= _uttlTableName), + Just + ("TimeToLiveSpecification" .= + _uttlTimeToLiveSpecification)]) + +instance ToPath UpdateTimeToLive where + toPath = const "/" + +instance ToQuery UpdateTimeToLive where + toQuery = const mempty + +-- | /See:/ 'updateTimeToLiveResponse' smart constructor. +data UpdateTimeToLiveResponse = UpdateTimeToLiveResponse' + { _uttlrsTimeToLiveSpecification :: !(Maybe TimeToLiveSpecification) + , _uttlrsResponseStatus :: !Int + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'UpdateTimeToLiveResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'uttlrsTimeToLiveSpecification' - Represents the output of an @UpdateTimeToLive@ operation. +-- +-- * 'uttlrsResponseStatus' - -- | The response status code. +updateTimeToLiveResponse + :: Int -- ^ 'uttlrsResponseStatus' + -> UpdateTimeToLiveResponse +updateTimeToLiveResponse pResponseStatus_ = + UpdateTimeToLiveResponse' + { _uttlrsTimeToLiveSpecification = Nothing + , _uttlrsResponseStatus = pResponseStatus_ + } + + +-- | Represents the output of an @UpdateTimeToLive@ operation. +uttlrsTimeToLiveSpecification :: Lens' UpdateTimeToLiveResponse (Maybe TimeToLiveSpecification) +uttlrsTimeToLiveSpecification = lens _uttlrsTimeToLiveSpecification (\ s a -> s{_uttlrsTimeToLiveSpecification = a}); + +-- | -- | The response status code. +uttlrsResponseStatus :: Lens' UpdateTimeToLiveResponse Int +uttlrsResponseStatus = lens _uttlrsResponseStatus (\ s a -> s{_uttlrsResponseStatus = a}); + +instance NFData UpdateTimeToLiveResponse where diff --git a/gen/Network/AWS/DynamoDB/Waiters.hs b/gen/Network/AWS/DynamoDB/Waiters.hs --- a/gen/Network/AWS/DynamoDB/Waiters.hs +++ b/gen/Network/AWS/DynamoDB/Waiters.hs @@ -7,42 +7,45 @@ -- | -- Module : Network.AWS.DynamoDB.Waiters --- Copyright : (c) 2013-2016 Brendan Hay +-- Copyright : (c) 2013-2017 Brendan Hay -- License : Mozilla Public License, v. 2.0. --- Maintainer : Brendan Hay +-- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- module Network.AWS.DynamoDB.Waiters where -import Network.AWS.DynamoDB.DescribeTable -import Network.AWS.DynamoDB.DescribeTable -import Network.AWS.DynamoDB.Types -import Network.AWS.Lens -import Network.AWS.Prelude -import Network.AWS.Waiter +import Network.AWS.DynamoDB.DescribeTable +import Network.AWS.DynamoDB.DescribeTable +import Network.AWS.DynamoDB.Types +import Network.AWS.Lens +import Network.AWS.Prelude +import Network.AWS.Waiter -- | Polls 'Network.AWS.DynamoDB.DescribeTable' every 20 seconds until a successful state is reached. An error is returned after 25 failed checks. tableNotExists :: Wait DescribeTable tableNotExists = - Wait - { _waitName = "TableNotExists" - , _waitAttempts = 25 - , _waitDelay = 20 - , _waitAcceptors = [matchError "ResourceNotFoundException" AcceptSuccess] - } + Wait + { _waitName = "TableNotExists" + , _waitAttempts = 25 + , _waitDelay = 20 + , _waitAcceptors = [matchError "ResourceNotFoundException" AcceptSuccess] + } + -- | Polls 'Network.AWS.DynamoDB.DescribeTable' every 20 seconds until a successful state is reached. An error is returned after 25 failed checks. tableExists :: Wait DescribeTable tableExists = - Wait - { _waitName = "TableExists" - , _waitAttempts = 25 - , _waitDelay = 20 - , _waitAcceptors = [ matchAll - "ACTIVE" - AcceptSuccess - (drsTable . - _Just . tdTableStatus . _Just . to toTextCI) - , matchError "ResourceNotFoundException" AcceptRetry] - } + Wait + { _waitName = "TableExists" + , _waitAttempts = 25 + , _waitDelay = 20 + , _waitAcceptors = + [ matchAll + "ACTIVE" + AcceptSuccess + (drsTable . _Just . tdTableStatus . _Just . to toTextCI) + , matchError "ResourceNotFoundException" AcceptRetry + ] + } + diff --git a/test/Main.hs b/test/Main.hs --- a/test/Main.hs +++ b/test/Main.hs @@ -2,9 +2,9 @@ -- | -- Module : Main --- Copyright : (c) 2013-2016 Brendan Hay +-- Copyright : (c) 2013-2017 Brendan Hay -- License : Mozilla Public License, v. 2.0. --- Maintainer : Brendan Hay +-- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- diff --git a/test/Test/AWS/Gen/DynamoDB.hs b/test/Test/AWS/Gen/DynamoDB.hs --- a/test/Test/AWS/Gen/DynamoDB.hs +++ b/test/Test/AWS/Gen/DynamoDB.hs @@ -5,20 +5,20 @@ -- | -- Module : Test.AWS.Gen.DynamoDB --- Copyright : (c) 2013-2016 Brendan Hay +-- Copyright : (c) 2013-2017 Brendan Hay -- License : Mozilla Public License, v. 2.0. --- Maintainer : Brendan Hay +-- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- module Test.AWS.Gen.DynamoDB where import Data.Proxy +import Network.AWS.DynamoDB +import Test.AWS.DynamoDB.Internal import Test.AWS.Fixture import Test.AWS.Prelude import Test.Tasty -import Network.AWS.DynamoDB -import Test.AWS.DynamoDB.Internal -- Auto-generated: the actual test selection needs to be manually placed into -- the top-level so that real test data can be incrementally added. @@ -46,6 +46,9 @@ -- , requestBatchGetItem $ -- batchGetItem -- +-- , requestListTagsOfResource $ +-- listTagsOfResource +-- -- , requestDescribeTable $ -- describeTable -- @@ -70,6 +73,18 @@ -- , requestCreateTable $ -- createTable -- +-- , requestDescribeTimeToLive $ +-- describeTimeToLive +-- +-- , requestTagResource $ +-- tagResource +-- +-- , requestUntagResource $ +-- untagResource +-- +-- , requestUpdateTimeToLive $ +-- updateTimeToLive +-- -- ] -- , testGroup "response" @@ -91,6 +106,9 @@ -- , responseBatchGetItem $ -- batchGetItemResponse -- +-- , responseListTagsOfResource $ +-- listTagsOfResourceResponse +-- -- , responseDescribeTable $ -- describeTableResponse -- @@ -115,6 +133,18 @@ -- , responseCreateTable $ -- createTableResponse -- +-- , responseDescribeTimeToLive $ +-- describeTimeToLiveResponse +-- +-- , responseTagResource $ +-- tagResourceResponse +-- +-- , responseUntagResource $ +-- untagResourceResponse +-- +-- , responseUpdateTimeToLive $ +-- updateTimeToLiveResponse +-- -- ] -- ] @@ -150,6 +180,11 @@ "BatchGetItem" "fixture/BatchGetItem.yaml" +requestListTagsOfResource :: ListTagsOfResource -> TestTree +requestListTagsOfResource = req + "ListTagsOfResource" + "fixture/ListTagsOfResource.yaml" + requestDescribeTable :: DescribeTable -> TestTree requestDescribeTable = req "DescribeTable" @@ -190,6 +225,26 @@ "CreateTable" "fixture/CreateTable.yaml" +requestDescribeTimeToLive :: DescribeTimeToLive -> TestTree +requestDescribeTimeToLive = req + "DescribeTimeToLive" + "fixture/DescribeTimeToLive.yaml" + +requestTagResource :: TagResource -> TestTree +requestTagResource = req + "TagResource" + "fixture/TagResource.yaml" + +requestUntagResource :: UntagResource -> TestTree +requestUntagResource = req + "UntagResource" + "fixture/UntagResource.yaml" + +requestUpdateTimeToLive :: UpdateTimeToLive -> TestTree +requestUpdateTimeToLive = req + "UpdateTimeToLive" + "fixture/UpdateTimeToLive.yaml" + -- Responses responsePutItem :: PutItemResponse -> TestTree @@ -234,6 +289,13 @@ dynamoDB (Proxy :: Proxy BatchGetItem) +responseListTagsOfResource :: ListTagsOfResourceResponse -> TestTree +responseListTagsOfResource = res + "ListTagsOfResourceResponse" + "fixture/ListTagsOfResourceResponse.proto" + dynamoDB + (Proxy :: Proxy ListTagsOfResource) + responseDescribeTable :: DescribeTableResponse -> TestTree responseDescribeTable = res "DescribeTableResponse" @@ -289,3 +351,31 @@ "fixture/CreateTableResponse.proto" dynamoDB (Proxy :: Proxy CreateTable) + +responseDescribeTimeToLive :: DescribeTimeToLiveResponse -> TestTree +responseDescribeTimeToLive = res + "DescribeTimeToLiveResponse" + "fixture/DescribeTimeToLiveResponse.proto" + dynamoDB + (Proxy :: Proxy DescribeTimeToLive) + +responseTagResource :: TagResourceResponse -> TestTree +responseTagResource = res + "TagResourceResponse" + "fixture/TagResourceResponse.proto" + dynamoDB + (Proxy :: Proxy TagResource) + +responseUntagResource :: UntagResourceResponse -> TestTree +responseUntagResource = res + "UntagResourceResponse" + "fixture/UntagResourceResponse.proto" + dynamoDB + (Proxy :: Proxy UntagResource) + +responseUpdateTimeToLive :: UpdateTimeToLiveResponse -> TestTree +responseUpdateTimeToLive = res + "UpdateTimeToLiveResponse" + "fixture/UpdateTimeToLiveResponse.proto" + dynamoDB + (Proxy :: Proxy UpdateTimeToLive)