amazonka-dynamodb-2.0: Amazon DynamoDB SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.DynamoDB.DeleteTable

Description

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.

DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete.

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 action to check the status of the table.

Synopsis

Creating a Request

data DeleteTable Source #

Represents the input of a DeleteTable operation.

See: newDeleteTable smart constructor.

Constructors

DeleteTable' 

Fields

Instances

Instances details
ToJSON DeleteTable Source # 
Instance details

Defined in Amazonka.DynamoDB.DeleteTable

ToHeaders DeleteTable Source # 
Instance details

Defined in Amazonka.DynamoDB.DeleteTable

Methods

toHeaders :: DeleteTable -> [Header] #

ToPath DeleteTable Source # 
Instance details

Defined in Amazonka.DynamoDB.DeleteTable

ToQuery DeleteTable Source # 
Instance details

Defined in Amazonka.DynamoDB.DeleteTable

AWSRequest DeleteTable Source # 
Instance details

Defined in Amazonka.DynamoDB.DeleteTable

Associated Types

type AWSResponse DeleteTable #

Generic DeleteTable Source # 
Instance details

Defined in Amazonka.DynamoDB.DeleteTable

Associated Types

type Rep DeleteTable :: Type -> Type #

Read DeleteTable Source # 
Instance details

Defined in Amazonka.DynamoDB.DeleteTable

Show DeleteTable Source # 
Instance details

Defined in Amazonka.DynamoDB.DeleteTable

NFData DeleteTable Source # 
Instance details

Defined in Amazonka.DynamoDB.DeleteTable

Methods

rnf :: DeleteTable -> () #

Eq DeleteTable Source # 
Instance details

Defined in Amazonka.DynamoDB.DeleteTable

Hashable DeleteTable Source # 
Instance details

Defined in Amazonka.DynamoDB.DeleteTable

type AWSResponse DeleteTable Source # 
Instance details

Defined in Amazonka.DynamoDB.DeleteTable

type Rep DeleteTable Source # 
Instance details

Defined in Amazonka.DynamoDB.DeleteTable

type Rep DeleteTable = D1 ('MetaData "DeleteTable" "Amazonka.DynamoDB.DeleteTable" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "DeleteTable'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteTable Source #

Create a value of DeleteTable 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:

DeleteTable, deleteTable_tableName - The name of the table to delete.

Request Lenses

deleteTable_tableName :: Lens' DeleteTable Text Source #

The name of the table to delete.

Destructuring the Response

data DeleteTableResponse Source #

Represents the output of a DeleteTable operation.

See: newDeleteTableResponse smart constructor.

Constructors

DeleteTableResponse' 

Fields

Instances

Instances details
Generic DeleteTableResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.DeleteTable

Associated Types

type Rep DeleteTableResponse :: Type -> Type #

Read DeleteTableResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.DeleteTable

Show DeleteTableResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.DeleteTable

NFData DeleteTableResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.DeleteTable

Methods

rnf :: DeleteTableResponse -> () #

Eq DeleteTableResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.DeleteTable

type Rep DeleteTableResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.DeleteTable

type Rep DeleteTableResponse = D1 ('MetaData "DeleteTableResponse" "Amazonka.DynamoDB.DeleteTable" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "DeleteTableResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tableDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TableDescription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteTableResponse Source #

Create a value of DeleteTableResponse 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:DeleteTableResponse', deleteTableResponse_tableDescription - Represents the properties of a table.

$sel:httpStatus:DeleteTableResponse', deleteTableResponse_httpStatus - The response's http status code.

Response Lenses