Amazonka.KeySpaces.GetTable

Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata.

To read table metadata using GetTable, Select action permissions for the table and system tables are required to complete the operation.

Creating a Request

data GetTable

See: newGetTable smart constructor.

Constructors

GetTable'

Fields

• keyspaceName :: Text

  The name of the keyspace that the table is stored in.

• tableName :: Text

  The name of the table.

Instances

ToJSON GetTable

Defined in Amazonka.KeySpaces.GetTable

Methods

toJSON :: GetTable -> Value

toEncoding :: GetTable -> Encoding

toJSONList :: [GetTable] -> Value

toEncodingList :: [GetTable] -> Encoding

ToHeaders GetTable

Defined in Amazonka.KeySpaces.GetTable

Methods

toHeaders :: GetTable -> [Header]

ToPath GetTable

Defined in Amazonka.KeySpaces.GetTable

Methods

toPath :: GetTable -> ByteString

ToQuery GetTable

Defined in Amazonka.KeySpaces.GetTable

Methods

toQuery :: GetTable -> QueryString

AWSRequest GetTable

Defined in Amazonka.KeySpaces.GetTable

Associated Types

type AWSResponse GetTable

Methods

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

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

Generic GetTable

Defined in Amazonka.KeySpaces.GetTable

Associated Types

type Rep GetTable :: Type -> Type

Methods

from :: GetTable -> Rep GetTable x

to :: Rep GetTable x -> GetTable

Read GetTable

Defined in Amazonka.KeySpaces.GetTable

Methods

readsPrec :: Int -> ReadS GetTable

readList :: ReadS [GetTable]

readPrec :: ReadPrec GetTable

readListPrec :: ReadPrec [GetTable]

Show GetTable

Defined in Amazonka.KeySpaces.GetTable

Methods

showsPrec :: Int -> GetTable -> ShowS

show :: GetTable -> String

showList :: [GetTable] -> ShowS

NFData GetTable

Defined in Amazonka.KeySpaces.GetTable

Methods

rnf :: GetTable -> ()

Eq GetTable

Defined in Amazonka.KeySpaces.GetTable

Methods

(==) :: GetTable -> GetTable -> Bool

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

Hashable GetTable

Defined in Amazonka.KeySpaces.GetTable

Methods

hashWithSalt :: Int -> GetTable -> Int

hash :: GetTable -> Int

type AWSResponse GetTable

Defined in Amazonka.KeySpaces.GetTable

type AWSResponse GetTable = GetTableResponse

type Rep GetTable

Defined in Amazonka.KeySpaces.GetTable

type Rep GetTable = D1 ('MetaData "GetTable" "Amazonka.KeySpaces.GetTable" "amazonka-keyspaces-2.0-IgmNF4xdaFLH03VHAkrBWw" 'False) (C1 ('MetaCons "GetTable'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyspaceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetTable

Arguments

:: Text

GetTable

-> Text

GetTable

-> GetTable

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

GetTable, getTable_keyspaceName - The name of the keyspace that the table is stored in.

GetTable, getTable_tableName - The name of the table.

Request Lenses

getTable_keyspaceName :: Lens' GetTable Text

The name of the keyspace that the table is stored in.

getTable_tableName :: Lens' GetTable Text

The name of the table.

Destructuring the Response

data GetTableResponse

See: newGetTableResponse smart constructor.

Constructors

GetTableResponse'

Fields

• capacitySpecification :: Maybe CapacitySpecificationSummary

  The read/write throughput capacity mode for a table. The options are:

  • throughputMode:PAY_PER_REQUEST

  • throughputMode:PROVISIONED

• comment :: Maybe Comment

  The the description of the specified table.

• creationTimestamp :: Maybe POSIX

  The creation timestamp of the specified table.

• defaultTimeToLive :: Maybe Natural

  The default Time to Live settings of the specified table.

• encryptionSpecification :: Maybe EncryptionSpecification

  The encryption settings of the specified table.

• pointInTimeRecovery :: Maybe PointInTimeRecoverySummary

  The point-in-time recovery status of the specified table.

• schemaDefinition :: Maybe SchemaDefinition

  The schema definition of the specified table.

• status :: Maybe TableStatus

  The current status of the specified table.

• ttl :: Maybe TimeToLive

  The custom Time to Live settings of the specified table.

• httpStatus :: Int

  The response's http status code.

• keyspaceName :: Text

  The name of the keyspace that the specified table is stored in.

• tableName :: Text

  The name of the specified table.

• resourceArn :: Text

  The Amazon Resource Name (ARN) of the specified table.

Instances

Generic GetTableResponse

Defined in Amazonka.KeySpaces.GetTable

Associated Types

type Rep GetTableResponse :: Type -> Type

Methods

from :: GetTableResponse -> Rep GetTableResponse x

to :: Rep GetTableResponse x -> GetTableResponse

Read GetTableResponse

Defined in Amazonka.KeySpaces.GetTable

Methods

readsPrec :: Int -> ReadS GetTableResponse

readList :: ReadS [GetTableResponse]

readPrec :: ReadPrec GetTableResponse

readListPrec :: ReadPrec [GetTableResponse]

Show GetTableResponse

Defined in Amazonka.KeySpaces.GetTable

Methods

showsPrec :: Int -> GetTableResponse -> ShowS

show :: GetTableResponse -> String

showList :: [GetTableResponse] -> ShowS

NFData GetTableResponse

Defined in Amazonka.KeySpaces.GetTable

Methods

rnf :: GetTableResponse -> ()

Eq GetTableResponse

Defined in Amazonka.KeySpaces.GetTable

Methods

(==) :: GetTableResponse -> GetTableResponse -> Bool

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

type Rep GetTableResponse

Defined in Amazonka.KeySpaces.GetTable

type Rep GetTableResponse = D1 ('MetaData "GetTableResponse" "Amazonka.KeySpaces.GetTable" "amazonka-keyspaces-2.0-IgmNF4xdaFLH03VHAkrBWw" 'False) (C1 ('MetaCons "GetTableResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "capacitySpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CapacitySpecificationSummary)) :*: (S1 ('MetaSel ('Just "comment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Comment)) :*: S1 ('MetaSel ('Just "creationTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: (S1 ('MetaSel ('Just "defaultTimeToLive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "encryptionSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionSpecification)) :*: S1 ('MetaSel ('Just "pointInTimeRecovery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PointInTimeRecoverySummary))))) :*: ((S1 ('MetaSel ('Just "schemaDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SchemaDefinition)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TableStatus)) :*: S1 ('MetaSel ('Just "ttl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeToLive)))) :*: ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "keyspaceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newGetTableResponse

Arguments

:: Int

$sel:httpStatus:GetTableResponse'

-> Text

GetTable

-> Text

GetTable

-> Text

GetTableResponse

-> GetTableResponse

Create a value of GetTableResponse 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:capacitySpecification:GetTableResponse', getTableResponse_capacitySpecification - The read/write throughput capacity mode for a table. The options are:

• throughputMode:PAY_PER_REQUEST

• throughputMode:PROVISIONED

$sel:comment:GetTableResponse', getTableResponse_comment - The the description of the specified table.

$sel:creationTimestamp:GetTableResponse', getTableResponse_creationTimestamp - The creation timestamp of the specified table.

$sel:defaultTimeToLive:GetTableResponse', getTableResponse_defaultTimeToLive - The default Time to Live settings of the specified table.

$sel:encryptionSpecification:GetTableResponse', getTableResponse_encryptionSpecification - The encryption settings of the specified table.

$sel:pointInTimeRecovery:GetTableResponse', getTableResponse_pointInTimeRecovery - The point-in-time recovery status of the specified table.

$sel:schemaDefinition:GetTableResponse', getTableResponse_schemaDefinition - The schema definition of the specified table.

GetTableResponse, getTableResponse_status - The current status of the specified table.

$sel:ttl:GetTableResponse', getTableResponse_ttl - The custom Time to Live settings of the specified table.

$sel:httpStatus:GetTableResponse', getTableResponse_httpStatus - The response's http status code.

GetTable, getTableResponse_keyspaceName - The name of the keyspace that the specified table is stored in.

GetTable, getTableResponse_tableName - The name of the specified table.

GetTableResponse, getTableResponse_resourceArn - The Amazon Resource Name (ARN) of the specified table.

Response Lenses

getTableResponse_capacitySpecification :: Lens' GetTableResponse (Maybe CapacitySpecificationSummary)

The read/write throughput capacity mode for a table. The options are:

• throughputMode:PAY_PER_REQUEST

• throughputMode:PROVISIONED

getTableResponse_comment :: Lens' GetTableResponse (Maybe Comment)

The the description of the specified table.

getTableResponse_creationTimestamp :: Lens' GetTableResponse (Maybe UTCTime)

The creation timestamp of the specified table.

getTableResponse_defaultTimeToLive :: Lens' GetTableResponse (Maybe Natural)

The default Time to Live settings of the specified table.

getTableResponse_encryptionSpecification :: Lens' GetTableResponse (Maybe EncryptionSpecification)

The encryption settings of the specified table.

getTableResponse_pointInTimeRecovery :: Lens' GetTableResponse (Maybe PointInTimeRecoverySummary)

The point-in-time recovery status of the specified table.

getTableResponse_schemaDefinition :: Lens' GetTableResponse (Maybe SchemaDefinition)

The schema definition of the specified table.

getTableResponse_status :: Lens' GetTableResponse (Maybe TableStatus)

The current status of the specified table.

getTableResponse_ttl :: Lens' GetTableResponse (Maybe TimeToLive)

The custom Time to Live settings of the specified table.

getTableResponse_httpStatus :: Lens' GetTableResponse Int

The response's http status code.

getTableResponse_keyspaceName :: Lens' GetTableResponse Text

The name of the keyspace that the specified table is stored in.

getTableResponse_tableName :: Lens' GetTableResponse Text

The name of the specified table.

getTableResponse_resourceArn :: Lens' GetTableResponse Text

The Amazon Resource Name (ARN) of the specified table.