Amazonka.DynamoDB.DeleteTable

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.

Creating a Request

data DeleteTable

Represents the input of a DeleteTable operation.

See: newDeleteTable smart constructor.

Constructors

DeleteTable'

Fields

• tableName :: Text

  The name of the table to delete.

Instances

ToJSON DeleteTable

Defined in Amazonka.DynamoDB.DeleteTable

Methods

toJSON :: DeleteTable -> Value

toEncoding :: DeleteTable -> Encoding

toJSONList :: [DeleteTable] -> Value

toEncodingList :: [DeleteTable] -> Encoding

ToHeaders DeleteTable

Defined in Amazonka.DynamoDB.DeleteTable

Methods

toHeaders :: DeleteTable -> [Header]

ToPath DeleteTable

Defined in Amazonka.DynamoDB.DeleteTable

Methods

toPath :: DeleteTable -> ByteString

ToQuery DeleteTable

Defined in Amazonka.DynamoDB.DeleteTable

Methods

toQuery :: DeleteTable -> QueryString

AWSRequest DeleteTable

Defined in Amazonka.DynamoDB.DeleteTable

Associated Types

type AWSResponse DeleteTable

Methods

request :: (Service -> Service) -> DeleteTable -> Request DeleteTable

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteTable -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteTable)))

Generic DeleteTable

Defined in Amazonka.DynamoDB.DeleteTable

Associated Types

type Rep DeleteTable :: Type -> Type

Methods

from :: DeleteTable -> Rep DeleteTable x

to :: Rep DeleteTable x -> DeleteTable

Read DeleteTable

Defined in Amazonka.DynamoDB.DeleteTable

Methods

readsPrec :: Int -> ReadS DeleteTable

readList :: ReadS [DeleteTable]

readPrec :: ReadPrec DeleteTable

readListPrec :: ReadPrec [DeleteTable]

Show DeleteTable

Defined in Amazonka.DynamoDB.DeleteTable

Methods

showsPrec :: Int -> DeleteTable -> ShowS

show :: DeleteTable -> String

showList :: [DeleteTable] -> ShowS

NFData DeleteTable

Defined in Amazonka.DynamoDB.DeleteTable

Methods

rnf :: DeleteTable -> ()

Eq DeleteTable

Defined in Amazonka.DynamoDB.DeleteTable

Methods

(==) :: DeleteTable -> DeleteTable -> Bool

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

Hashable DeleteTable

Defined in Amazonka.DynamoDB.DeleteTable

Methods

hashWithSalt :: Int -> DeleteTable -> Int

hash :: DeleteTable -> Int

type AWSResponse DeleteTable

Defined in Amazonka.DynamoDB.DeleteTable

type AWSResponse DeleteTable = DeleteTableResponse

type Rep DeleteTable

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

Arguments

:: Text

DeleteTable

-> 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:

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

Request Lenses

deleteTable_tableName :: Lens' DeleteTable Text

The name of the table to delete.

Destructuring the Response

data DeleteTableResponse

Represents the output of a DeleteTable operation.

See: newDeleteTableResponse smart constructor.

Constructors

DeleteTableResponse'

Fields

• tableDescription :: Maybe TableDescription

  Represents the properties of a table.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DeleteTableResponse

Defined in Amazonka.DynamoDB.DeleteTable

Associated Types

type Rep DeleteTableResponse :: Type -> Type

Methods

from :: DeleteTableResponse -> Rep DeleteTableResponse x

to :: Rep DeleteTableResponse x -> DeleteTableResponse

Read DeleteTableResponse

Defined in Amazonka.DynamoDB.DeleteTable

Methods

readsPrec :: Int -> ReadS DeleteTableResponse

readList :: ReadS [DeleteTableResponse]

readPrec :: ReadPrec DeleteTableResponse

readListPrec :: ReadPrec [DeleteTableResponse]

Show DeleteTableResponse

Defined in Amazonka.DynamoDB.DeleteTable

Methods

showsPrec :: Int -> DeleteTableResponse -> ShowS

show :: DeleteTableResponse -> String

showList :: [DeleteTableResponse] -> ShowS

NFData DeleteTableResponse

Defined in Amazonka.DynamoDB.DeleteTable

Methods

rnf :: DeleteTableResponse -> ()

Eq DeleteTableResponse

Defined in Amazonka.DynamoDB.DeleteTable

Methods

(==) :: DeleteTableResponse -> DeleteTableResponse -> Bool

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

type Rep DeleteTableResponse

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

Arguments

:: Int

$sel:httpStatus:DeleteTableResponse'

-> 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)

Represents the properties of a table.

deleteTableResponse_httpStatus :: Lens' DeleteTableResponse Int

The response's http status code.