Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.DynamoDB.DescribeTable

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Synopsis

Creating a Request

describeTable #

Arguments

:: Text	`dTableName`
-> DescribeTable

Creates a value of DescribeTable with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dTableName - The name of the table to describe.

data DescribeTable #

Represents the input of a DescribeTable operation.

See: describeTable smart constructor.

Instances

Eq DescribeTable #
Instance details Defined in Network.AWS.DynamoDB.DescribeTable Methods (==) :: DescribeTable -> DescribeTable -> Bool # (/=) :: DescribeTable -> DescribeTable -> Bool #
Data DescribeTable #
Instance details Defined in Network.AWS.DynamoDB.DescribeTable Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeTable -> c DescribeTable # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeTable # toConstr :: DescribeTable -> Constr # dataTypeOf :: DescribeTable -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeTable) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeTable) # gmapT :: (forall b. Data b => b -> b) -> DescribeTable -> DescribeTable # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeTable -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeTable -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeTable -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeTable -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeTable -> m DescribeTable # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeTable -> m DescribeTable # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeTable -> m DescribeTable #
Read DescribeTable #
Instance details Defined in Network.AWS.DynamoDB.DescribeTable Methods readsPrec :: Int -> ReadS DescribeTable # readList :: ReadS [DescribeTable] # readPrec :: ReadPrec DescribeTable # readListPrec :: ReadPrec [DescribeTable] #
Show DescribeTable #
Instance details Defined in Network.AWS.DynamoDB.DescribeTable Methods showsPrec :: Int -> DescribeTable -> ShowS # show :: DescribeTable -> String # showList :: [DescribeTable] -> ShowS #
Generic DescribeTable #
Instance details Defined in Network.AWS.DynamoDB.DescribeTable Associated Types type Rep DescribeTable :: * -> * # Methods from :: DescribeTable -> Rep DescribeTable x # to :: Rep DescribeTable x -> DescribeTable #
Hashable DescribeTable #
Instance details Defined in Network.AWS.DynamoDB.DescribeTable Methods hashWithSalt :: Int -> DescribeTable -> Int # hash :: DescribeTable -> Int #
ToJSON DescribeTable #
Instance details Defined in Network.AWS.DynamoDB.DescribeTable Methods toJSON :: DescribeTable -> Value # toEncoding :: DescribeTable -> Encoding # toJSONList :: [DescribeTable] -> Value # toEncodingList :: [DescribeTable] -> Encoding #
AWSRequest DescribeTable #
Instance details Defined in Network.AWS.DynamoDB.DescribeTable Associated Types type Rs DescribeTable :: * # Methods request :: DescribeTable -> Request DescribeTable # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribeTable -> ClientResponse -> m (Response DescribeTable) #
ToHeaders DescribeTable #
Instance details Defined in Network.AWS.DynamoDB.DescribeTable Methods toHeaders :: DescribeTable -> [Header] #
ToPath DescribeTable #
Instance details Defined in Network.AWS.DynamoDB.DescribeTable Methods toPath :: DescribeTable -> ByteString #
ToQuery DescribeTable #
Instance details Defined in Network.AWS.DynamoDB.DescribeTable Methods toQuery :: DescribeTable -> QueryString #
NFData DescribeTable #
Instance details Defined in Network.AWS.DynamoDB.DescribeTable Methods rnf :: DescribeTable -> () #
type Rep DescribeTable #
Instance details Defined in Network.AWS.DynamoDB.DescribeTable type Rep DescribeTable = D1 (MetaData "DescribeTable" "Network.AWS.DynamoDB.DescribeTable" "amazonka-dynamodb-1.6.0-COMX9FqvIeW1LBbyPqhpUT" True) (C1 (MetaCons "DescribeTable'" PrefixI True) (S1 (MetaSel (Just "_dTableName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type Rs DescribeTable #
Instance details Defined in Network.AWS.DynamoDB.DescribeTable type Rs DescribeTable = DescribeTableResponse

Request Lenses

dTableName :: Lens' DescribeTable Text #

The name of the table to describe.

Destructuring the Response

describeTableResponse #

Arguments

:: Int	`drsResponseStatus`
-> DescribeTableResponse

Creates a value of DescribeTableResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

drsTable - The properties of the table.
drsResponseStatus - -- | The response status code.

data DescribeTableResponse #

Represents the output of a DescribeTable operation.

See: describeTableResponse smart constructor.

Instances

Eq DescribeTableResponse #
Instance details Defined in Network.AWS.DynamoDB.DescribeTable Methods (==) :: DescribeTableResponse -> DescribeTableResponse -> Bool # (/=) :: DescribeTableResponse -> DescribeTableResponse -> Bool #
Data DescribeTableResponse #
Instance details Defined in Network.AWS.DynamoDB.DescribeTable Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeTableResponse -> c DescribeTableResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeTableResponse # toConstr :: DescribeTableResponse -> Constr # dataTypeOf :: DescribeTableResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeTableResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeTableResponse) # gmapT :: (forall b. Data b => b -> b) -> DescribeTableResponse -> DescribeTableResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeTableResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeTableResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeTableResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeTableResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeTableResponse -> m DescribeTableResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeTableResponse -> m DescribeTableResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeTableResponse -> m DescribeTableResponse #
Read DescribeTableResponse #
Instance details Defined in Network.AWS.DynamoDB.DescribeTable Methods readsPrec :: Int -> ReadS DescribeTableResponse # readList :: ReadS [DescribeTableResponse] # readPrec :: ReadPrec DescribeTableResponse # readListPrec :: ReadPrec [DescribeTableResponse] #
Show DescribeTableResponse #
Instance details Defined in Network.AWS.DynamoDB.DescribeTable Methods showsPrec :: Int -> DescribeTableResponse -> ShowS # show :: DescribeTableResponse -> String # showList :: [DescribeTableResponse] -> ShowS #
Generic DescribeTableResponse #
Instance details Defined in Network.AWS.DynamoDB.DescribeTable Associated Types type Rep DescribeTableResponse :: * -> * # Methods from :: DescribeTableResponse -> Rep DescribeTableResponse x # to :: Rep DescribeTableResponse x -> DescribeTableResponse #
NFData DescribeTableResponse #
Instance details Defined in Network.AWS.DynamoDB.DescribeTable Methods rnf :: DescribeTableResponse -> () #
type Rep DescribeTableResponse #
Instance details Defined in Network.AWS.DynamoDB.DescribeTable type Rep DescribeTableResponse = D1 (MetaData "DescribeTableResponse" "Network.AWS.DynamoDB.DescribeTable" "amazonka-dynamodb-1.6.0-COMX9FqvIeW1LBbyPqhpUT" False) (C1 (MetaCons "DescribeTableResponse'" PrefixI True) (S1 (MetaSel (Just "_drsTable") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe TableDescription)) :*: S1 (MetaSel (Just "_drsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

drsTable :: Lens' DescribeTableResponse (Maybe TableDescription) #

The properties of the table.

drsResponseStatus :: Lens' DescribeTableResponse Int #

- | The response status code.