Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DynamoDB.UpdateTable

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 DynamoDB Streams on the table.
Remove a global secondary index from the table.
Create a new global secondary index on the table. After 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

data UpdateTable = UpdateTable' {
}
newUpdateTable :: Text -> UpdateTable
updateTable_attributeDefinitions :: Lens' UpdateTable (Maybe [AttributeDefinition])
updateTable_provisionedThroughput :: Lens' UpdateTable (Maybe ProvisionedThroughput)
updateTable_sSESpecification :: Lens' UpdateTable (Maybe SSESpecification)
updateTable_replicaUpdates :: Lens' UpdateTable (Maybe (NonEmpty ReplicationGroupUpdate))
updateTable_globalSecondaryIndexUpdates :: Lens' UpdateTable (Maybe [GlobalSecondaryIndexUpdate])
updateTable_billingMode :: Lens' UpdateTable (Maybe BillingMode)
updateTable_streamSpecification :: Lens' UpdateTable (Maybe StreamSpecification)
updateTable_tableName :: Lens' UpdateTable Text
data UpdateTableResponse = UpdateTableResponse' {
- tableDescription :: Maybe TableDescription
- httpStatus :: Int
}
newUpdateTableResponse :: Int -> UpdateTableResponse
updateTableResponse_tableDescription :: Lens' UpdateTableResponse (Maybe TableDescription)
updateTableResponse_httpStatus :: Lens' UpdateTableResponse Int

Creating a Request

data UpdateTable Source #

Represents the input of an UpdateTable operation.

See: newUpdateTable smart constructor.

Constructors

UpdateTable'

Fields

attributeDefinitions :: Maybe [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.
provisionedThroughput :: Maybe ProvisionedThroughput
The new provisioned throughput settings for the specified table or index.
sSESpecification :: Maybe SSESpecification
The new server-side encryption settings for the specified table.
replicaUpdates :: Maybe (NonEmpty ReplicationGroupUpdate)
A list of replica update actions (create, delete, or update) for the table.
This property only applies to Version 2019.11.21 of global tables.
globalSecondaryIndexUpdates :: Maybe [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.
You can create or delete only one global secondary index per UpdateTable operation.
For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
billingMode :: Maybe BillingMode
Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.
- PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.
- PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.
streamSpecification :: Maybe StreamSpecification
Represents the DynamoDB Streams configuration for the table.
You receive a ResourceInUseException if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn't have a stream.
tableName :: Text
The name of the table to be updated.

Instances

Instances details

Eq UpdateTable Source #
Instance details Defined in Amazonka.DynamoDB.UpdateTable Methods (==) :: UpdateTable -> UpdateTable -> Bool # (/=) :: UpdateTable -> UpdateTable -> Bool #
Read UpdateTable Source #
Instance details Defined in Amazonka.DynamoDB.UpdateTable Methods readsPrec :: Int -> ReadS UpdateTable # readList :: ReadS [UpdateTable] # readPrec :: ReadPrec UpdateTable # readListPrec :: ReadPrec [UpdateTable] #
Show UpdateTable Source #
Instance details Defined in Amazonka.DynamoDB.UpdateTable Methods showsPrec :: Int -> UpdateTable -> ShowS # show :: UpdateTable -> String # showList :: [UpdateTable] -> ShowS #
Generic UpdateTable Source #
Instance details Defined in Amazonka.DynamoDB.UpdateTable Associated Types type Rep UpdateTable :: Type -> Type # Methods from :: UpdateTable -> Rep UpdateTable x # to :: Rep UpdateTable x -> UpdateTable #
NFData UpdateTable Source #
Instance details Defined in Amazonka.DynamoDB.UpdateTable Methods rnf :: UpdateTable -> () #
Hashable UpdateTable Source #
Instance details Defined in Amazonka.DynamoDB.UpdateTable Methods hashWithSalt :: Int -> UpdateTable -> Int # hash :: UpdateTable -> Int #
ToJSON UpdateTable Source #
Instance details Defined in Amazonka.DynamoDB.UpdateTable Methods toJSON :: UpdateTable -> Value # toEncoding :: UpdateTable -> Encoding # toJSONList :: [UpdateTable] -> Value # toEncodingList :: [UpdateTable] -> Encoding #
AWSRequest UpdateTable Source #
Instance details Defined in Amazonka.DynamoDB.UpdateTable Associated Types type AWSResponse UpdateTable # Methods request :: UpdateTable -> Request UpdateTable # response :: MonadResource m => Logger -> Service -> Proxy UpdateTable -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateTable))) #
ToHeaders UpdateTable Source #
Instance details Defined in Amazonka.DynamoDB.UpdateTable Methods toHeaders :: UpdateTable -> [Header] #
ToPath UpdateTable Source #
Instance details Defined in Amazonka.DynamoDB.UpdateTable Methods toPath :: UpdateTable -> ByteString #
ToQuery UpdateTable Source #
Instance details Defined in Amazonka.DynamoDB.UpdateTable Methods toQuery :: UpdateTable -> QueryString #
type Rep UpdateTable Source #
Instance details Defined in Amazonka.DynamoDB.UpdateTable type Rep UpdateTable = D1 ('MetaData "UpdateTable" "Amazonka.DynamoDB.UpdateTable" "libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb" 'False) (C1 ('MetaCons "UpdateTable'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "attributeDefinitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AttributeDefinition])) :: S1 ('MetaSel ('Just "provisionedThroughput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProvisionedThroughput))) :: (S1 ('MetaSel ('Just "sSESpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SSESpecification)) :: S1 ('MetaSel ('Just "replicaUpdates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ReplicationGroupUpdate))))) :: ((S1 ('MetaSel ('Just "globalSecondaryIndexUpdates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GlobalSecondaryIndexUpdate])) :: S1 ('MetaSel ('Just "billingMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BillingMode))) :: (S1 ('MetaSel ('Just "streamSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamSpecification)) :*: S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse UpdateTable Source #
Instance details Defined in Amazonka.DynamoDB.UpdateTable type AWSResponse UpdateTable = UpdateTableResponse

newUpdateTable Source #

Arguments

:: Text	`$sel:tableName:UpdateTable'`
-> UpdateTable

Create a value of UpdateTable with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attributeDefinitions:UpdateTable', updateTable_attributeDefinitions - 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.

$sel:provisionedThroughput:UpdateTable', updateTable_provisionedThroughput - The new provisioned throughput settings for the specified table or index.

$sel:sSESpecification:UpdateTable', updateTable_sSESpecification - The new server-side encryption settings for the specified table.

$sel:replicaUpdates:UpdateTable', updateTable_replicaUpdates - A list of replica update actions (create, delete, or update) for the table.

This property only applies to Version 2019.11.21 of global tables.

$sel:globalSecondaryIndexUpdates:UpdateTable', updateTable_globalSecondaryIndexUpdates - 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.

You can create or delete only one global secondary index per UpdateTable operation.

For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.

$sel:billingMode:UpdateTable', updateTable_billingMode - Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.

PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.
PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.

$sel:streamSpecification:UpdateTable', updateTable_streamSpecification - Represents the DynamoDB Streams configuration for the table.

You receive a ResourceInUseException if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn't have a stream.

$sel:tableName:UpdateTable', updateTable_tableName - The name of the table to be updated.

Request Lenses

updateTable_attributeDefinitions :: Lens' UpdateTable (Maybe [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.

updateTable_provisionedThroughput :: Lens' UpdateTable (Maybe ProvisionedThroughput) Source #

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

updateTable_sSESpecification :: Lens' UpdateTable (Maybe SSESpecification) Source #

The new server-side encryption settings for the specified table.

updateTable_replicaUpdates :: Lens' UpdateTable (Maybe (NonEmpty ReplicationGroupUpdate)) Source #

A list of replica update actions (create, delete, or update) for the table.

This property only applies to Version 2019.11.21 of global tables.

updateTable_globalSecondaryIndexUpdates :: Lens' UpdateTable (Maybe [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.

You can create or delete only one global secondary index per UpdateTable operation.

For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.

updateTable_billingMode :: Lens' UpdateTable (Maybe BillingMode) Source #

Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.

PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.
PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.

updateTable_streamSpecification :: Lens' UpdateTable (Maybe StreamSpecification) Source #

Represents the DynamoDB Streams configuration for the table.

You receive a ResourceInUseException if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn't have a stream.

updateTable_tableName :: Lens' UpdateTable Text Source #

The name of the table to be updated.

Destructuring the Response

data UpdateTableResponse Source #

Represents the output of an UpdateTable operation.

See: newUpdateTableResponse smart constructor.

Constructors

UpdateTableResponse'
Fields tableDescription :: Maybe TableDescription Represents the properties of the table. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq UpdateTableResponse Source #
Instance details Defined in Amazonka.DynamoDB.UpdateTable Methods (==) :: UpdateTableResponse -> UpdateTableResponse -> Bool # (/=) :: UpdateTableResponse -> UpdateTableResponse -> Bool #
Read UpdateTableResponse Source #
Instance details Defined in Amazonka.DynamoDB.UpdateTable Methods readsPrec :: Int -> ReadS UpdateTableResponse # readList :: ReadS [UpdateTableResponse] # readPrec :: ReadPrec UpdateTableResponse # readListPrec :: ReadPrec [UpdateTableResponse] #
Show UpdateTableResponse Source #
Instance details Defined in Amazonka.DynamoDB.UpdateTable Methods showsPrec :: Int -> UpdateTableResponse -> ShowS # show :: UpdateTableResponse -> String # showList :: [UpdateTableResponse] -> ShowS #
Generic UpdateTableResponse Source #
Instance details Defined in Amazonka.DynamoDB.UpdateTable Associated Types type Rep UpdateTableResponse :: Type -> Type # Methods from :: UpdateTableResponse -> Rep UpdateTableResponse x # to :: Rep UpdateTableResponse x -> UpdateTableResponse #
NFData UpdateTableResponse Source #
Instance details Defined in Amazonka.DynamoDB.UpdateTable Methods rnf :: UpdateTableResponse -> () #
type Rep UpdateTableResponse Source #
Instance details Defined in Amazonka.DynamoDB.UpdateTable type Rep UpdateTableResponse = D1 ('MetaData "UpdateTableResponse" "Amazonka.DynamoDB.UpdateTable" "libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb" 'False) (C1 ('MetaCons "UpdateTableResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tableDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TableDescription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateTableResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateTableResponse'`
-> UpdateTableResponse

Create a value of UpdateTableResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:tableDescription:UpdateTableResponse', updateTableResponse_tableDescription - Represents the properties of the table.

$sel:httpStatus:UpdateTableResponse', updateTableResponse_httpStatus - The response's http status code.

Response Lenses

updateTableResponse_tableDescription :: Lens' UpdateTableResponse (Maybe TableDescription) Source #

Represents the properties of the table.

updateTableResponse_httpStatus :: Lens' UpdateTableResponse Int Source #

The response's http status code.