amazonka-dynamodb-1.4.3: Amazon DynamoDB SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.DynamoDB.UpdateTable

Contents

Description

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.

Synopsis

Creating a Request

updateTable Source #

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.

Instances

Eq UpdateTable Source # 
Data UpdateTable Source # 

Methods

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

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

toConstr :: UpdateTable -> Constr #

dataTypeOf :: UpdateTable -> DataType #

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

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

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

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

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

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

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

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

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

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

Read UpdateTable Source # 
Show UpdateTable Source # 
Generic UpdateTable Source # 

Associated Types

type Rep UpdateTable :: * -> * #

ToJSON UpdateTable Source # 
Hashable UpdateTable Source # 
NFData UpdateTable Source # 

Methods

rnf :: UpdateTable -> () #

AWSRequest UpdateTable Source # 
ToPath UpdateTable Source # 
ToHeaders UpdateTable Source # 

Methods

toHeaders :: UpdateTable -> [Header] #

ToQuery UpdateTable Source # 
type Rep UpdateTable Source # 
type Rep UpdateTable = D1 (MetaData "UpdateTable" "Network.AWS.DynamoDB.UpdateTable" "amazonka-dynamodb-1.4.3-3fdtTGsiGrrGY8Sp4GOKeL" False) (C1 (MetaCons "UpdateTable'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_utAttributeDefinitions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [AttributeDefinition]))) (S1 (MetaSel (Just Symbol "_utProvisionedThroughput") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ProvisionedThroughput)))) ((:*:) (S1 (MetaSel (Just Symbol "_utGlobalSecondaryIndexUpdates") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [GlobalSecondaryIndexUpdate]))) ((:*:) (S1 (MetaSel (Just Symbol "_utStreamSpecification") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe StreamSpecification))) (S1 (MetaSel (Just Symbol "_utTableName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))
type Rs UpdateTable Source # 

Request Lenses

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

updateTableResponse Source #

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.

Instances

Eq UpdateTableResponse Source # 
Data UpdateTableResponse Source # 

Methods

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

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

toConstr :: UpdateTableResponse -> Constr #

dataTypeOf :: UpdateTableResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read UpdateTableResponse Source # 
Show UpdateTableResponse Source # 
Generic UpdateTableResponse Source # 
NFData UpdateTableResponse Source # 

Methods

rnf :: UpdateTableResponse -> () #

type Rep UpdateTableResponse Source # 
type Rep UpdateTableResponse = D1 (MetaData "UpdateTableResponse" "Network.AWS.DynamoDB.UpdateTable" "amazonka-dynamodb-1.4.3-3fdtTGsiGrrGY8Sp4GOKeL" False) (C1 (MetaCons "UpdateTableResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_utrsTableDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe TableDescription))) (S1 (MetaSel (Just Symbol "_utrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses