| 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.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
- data DeleteTable = DeleteTable' {}
- newDeleteTable :: Text -> DeleteTable
- deleteTable_tableName :: Lens' DeleteTable Text
- data DeleteTableResponse = DeleteTableResponse' {}
- newDeleteTableResponse :: Int -> DeleteTableResponse
- deleteTableResponse_tableDescription :: Lens' DeleteTableResponse (Maybe TableDescription)
- deleteTableResponse_httpStatus :: Lens' DeleteTableResponse Int
Creating a Request
data DeleteTable Source #
Represents the input of a DeleteTable operation.
See: newDeleteTable smart constructor.
Constructors
| DeleteTable' | |
Instances
Arguments
| :: Text | |
| -> DeleteTable |
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:
$sel:tableName: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
newDeleteTableResponse Source #
Arguments
| :: Int | |
| -> DeleteTableResponse |
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
deleteTableResponse_tableDescription :: Lens' DeleteTableResponse (Maybe TableDescription) Source #
Represents the properties of a table.
deleteTableResponse_httpStatus :: Lens' DeleteTableResponse Int Source #
The response's http status code.