Network.AWS.DynamoDB.UpdateTable

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.

Creating a Request

updateTable

Arguments

:: Text

utTableName

-> UpdateTable

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.
• 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 Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide .
• utStreamSpecification - Represents the DynamoDB Streams configuration for the table.
• utTableName - The name of the table to be updated.

data UpdateTable

Represents the input of an UpdateTable operation.

See: updateTable smart constructor.

Instances

Eq UpdateTable

Methods

(==) :: UpdateTable -> UpdateTable -> Bool

(/=) :: UpdateTable -> UpdateTable -> Bool

Data UpdateTable

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

Methods

readsPrec :: Int -> ReadS UpdateTable

readList :: ReadS [UpdateTable]

readPrec :: ReadPrec UpdateTable

readListPrec :: ReadPrec [UpdateTable]

Show UpdateTable

Methods

showsPrec :: Int -> UpdateTable -> ShowS

show :: UpdateTable -> String

showList :: [UpdateTable] -> ShowS

Generic UpdateTable

Associated Types

type Rep UpdateTable :: * -> *

Methods

from :: UpdateTable -> Rep UpdateTable x

to :: Rep UpdateTable x -> UpdateTable

Hashable UpdateTable

Methods

hashWithSalt :: Int -> UpdateTable -> Int

hash :: UpdateTable -> Int

ToJSON UpdateTable

Methods

toJSON :: UpdateTable -> Value

toEncoding :: UpdateTable -> Encoding

toJSONList :: [UpdateTable] -> Value

toEncodingList :: [UpdateTable] -> Encoding

NFData UpdateTable

Methods

rnf :: UpdateTable -> ()

AWSRequest UpdateTable

Associated Types

type Rs UpdateTable :: *

Methods

request :: UpdateTable -> Request UpdateTable

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * UpdateTable -> ClientResponse -> m (Response UpdateTable)

ToHeaders UpdateTable

Methods

toHeaders :: UpdateTable -> [Header]

ToPath UpdateTable

Methods

toPath :: UpdateTable -> ByteString

ToQuery UpdateTable

Methods

toQuery :: UpdateTable -> QueryString

type Rep UpdateTable

type Rep UpdateTable = D1 * (MetaData "UpdateTable" "Network.AWS.DynamoDB.UpdateTable" "amazonka-dynamodb-1.6.0-Be8FXVQVyEHEMZza56FG0o" 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

type Rs UpdateTable = UpdateTableResponse

Request Lenses

utAttributeDefinitions :: Lens' UpdateTable [AttributeDefinition]

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 :: Lens' UpdateTable (Maybe ProvisionedThroughput)

The new provisioned throughput settings for the specified table or index.

utGlobalSecondaryIndexUpdates :: Lens' UpdateTable [GlobalSecondaryIndexUpdate]

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)

Represents the DynamoDB Streams configuration for the table.

utTableName :: Lens' UpdateTable Text

The name of the table to be updated.

Destructuring the Response

updateTableResponse

Arguments

:: Int

utrsResponseStatus

-> UpdateTableResponse

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 - Represents the properties of the table.
• utrsResponseStatus - -- | The response status code.

data UpdateTableResponse

Represents the output of an UpdateTable operation.

See: updateTableResponse smart constructor.

Instances

Eq UpdateTableResponse

Methods

(==) :: UpdateTableResponse -> UpdateTableResponse -> Bool

(/=) :: UpdateTableResponse -> UpdateTableResponse -> Bool

Data UpdateTableResponse

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

Methods

readsPrec :: Int -> ReadS UpdateTableResponse

readList :: ReadS [UpdateTableResponse]

readPrec :: ReadPrec UpdateTableResponse

readListPrec :: ReadPrec [UpdateTableResponse]

Show UpdateTableResponse

Methods

showsPrec :: Int -> UpdateTableResponse -> ShowS

show :: UpdateTableResponse -> String

showList :: [UpdateTableResponse] -> ShowS

Generic UpdateTableResponse

Associated Types

type Rep UpdateTableResponse :: * -> *

Methods

from :: UpdateTableResponse -> Rep UpdateTableResponse x

to :: Rep UpdateTableResponse x -> UpdateTableResponse

NFData UpdateTableResponse

Methods

rnf :: UpdateTableResponse -> ()

type Rep UpdateTableResponse

type Rep UpdateTableResponse = D1 * (MetaData "UpdateTableResponse" "Network.AWS.DynamoDB.UpdateTable" "amazonka-dynamodb-1.6.0-Be8FXVQVyEHEMZza56FG0o" 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

utrsTableDescription :: Lens' UpdateTableResponse (Maybe TableDescription)

Represents the properties of the table.

utrsResponseStatus :: Lens' UpdateTableResponse Int

• - | The response status code.