| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.DynamoDB.DescribeTable
Description
Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.
If you issue a DescribeTable request immediately after a CreateTable
request, DynamoDB might return a ResourceNotFoundException. This is
because DescribeTable uses an eventually consistent query, and the
metadata for your table might not be available at that moment. Wait for
a few seconds, and then try the DescribeTable request again.
Synopsis
- data DescribeTable = DescribeTable' {}
- newDescribeTable :: Text -> DescribeTable
- describeTable_tableName :: Lens' DescribeTable Text
- data DescribeTableResponse = DescribeTableResponse' {}
- newDescribeTableResponse :: Int -> DescribeTableResponse
- describeTableResponse_table :: Lens' DescribeTableResponse (Maybe TableDescription)
- describeTableResponse_httpStatus :: Lens' DescribeTableResponse Int
Creating a Request
data DescribeTable Source #
Represents the input of a DescribeTable operation.
See: newDescribeTable smart constructor.
Constructors
| DescribeTable' | |
Instances
Arguments
| :: Text | |
| -> DescribeTable |
Create a value of DescribeTable 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:
DescribeTable, describeTable_tableName - The name of the table to describe.
Request Lenses
describeTable_tableName :: Lens' DescribeTable Text Source #
The name of the table to describe.
Destructuring the Response
data DescribeTableResponse Source #
Represents the output of a DescribeTable operation.
See: newDescribeTableResponse smart constructor.
Constructors
| DescribeTableResponse' | |
Fields
| |
Instances
newDescribeTableResponse Source #
Create a value of DescribeTableResponse 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:
DescribeTableResponse, describeTableResponse_table - The properties of the table.
$sel:httpStatus:DescribeTableResponse', describeTableResponse_httpStatus - The response's http status code.
Response Lenses
describeTableResponse_table :: Lens' DescribeTableResponse (Maybe TableDescription) Source #
The properties of the table.
describeTableResponse_httpStatus :: Lens' DescribeTableResponse Int Source #
The response's http status code.