Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.
You can only perform one of the following operations at once:
- Modify the provisioned throughput settings of the table.
- Enable or disable Streams on the table.
- 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.
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.
See: AWS API Reference for UpdateTable.
- updateTable :: Text -> UpdateTable
- data UpdateTable
- utProvisionedThroughput :: Lens' UpdateTable (Maybe ProvisionedThroughput)
- utAttributeDefinitions :: Lens' UpdateTable [AttributeDefinition]
- utGlobalSecondaryIndexUpdates :: Lens' UpdateTable [GlobalSecondaryIndexUpdate]
- utStreamSpecification :: Lens' UpdateTable (Maybe StreamSpecification)
- utTableName :: Lens' UpdateTable Text
- updateTableResponse :: Int -> UpdateTableResponse
- data UpdateTableResponse
- utrsTableDescription :: Lens' UpdateTableResponse (Maybe TableDescription)
- utrsStatus :: Lens' UpdateTableResponse Int
Creating a Request
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:
data UpdateTable Source
Represents the input of an UpdateTable operation.
See: updateTable
smart constructor.
Request Lenses
utProvisionedThroughput :: Lens' UpdateTable (Maybe ProvisionedThroughput) Source
Undocumented member.
utAttributeDefinitions :: Lens' UpdateTable [AttributeDefinition] Source
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.
utGlobalSecondaryIndexUpdates :: Lens' UpdateTable [GlobalSecondaryIndexUpdate] Source
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 Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
utStreamSpecification :: Lens' UpdateTable (Maybe StreamSpecification) Source
Represents the DynamoDB Streams configuration for the table.
You will receive a ResourceInUseException if you attempt to enable a stream on a table that already has a stream, or if you attempt to disable a stream on a table which does not have a stream.
utTableName :: Lens' UpdateTable Text Source
The name of the table to be updated.
Destructuring the Response
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:
data UpdateTableResponse Source
Represents the output of an UpdateTable operation.
See: updateTableResponse
smart constructor.
Response Lenses
utrsTableDescription :: Lens' UpdateTableResponse (Maybe TableDescription) Source
Undocumented member.
utrsStatus :: Lens' UpdateTableResponse Int Source
The response status code.