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.TimeStreamWrite.CreateTable

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

The CreateTable operation adds a new table to an existing database in your account. In an Amazon Web Services account, table names must be at least unique within each Region if they are in the same database. You may have identical table names in the same Region if the tables are in separate databases. While creating the table, you must specify the table name, database name, and the retention properties. Service quotas apply. See code sample for details.

Synopsis

data CreateTable = CreateTable' {
- magneticStoreWriteProperties :: Maybe MagneticStoreWriteProperties
- retentionProperties :: Maybe RetentionProperties
- tags :: Maybe [Tag]
- databaseName :: Text
- tableName :: Text
}
newCreateTable :: Text -> Text -> CreateTable
createTable_magneticStoreWriteProperties :: Lens' CreateTable (Maybe MagneticStoreWriteProperties)
createTable_retentionProperties :: Lens' CreateTable (Maybe RetentionProperties)
createTable_tags :: Lens' CreateTable (Maybe [Tag])
createTable_databaseName :: Lens' CreateTable Text
createTable_tableName :: Lens' CreateTable Text
data CreateTableResponse = CreateTableResponse' {
- table :: Maybe Table
- httpStatus :: Int
}
newCreateTableResponse :: Int -> CreateTableResponse
createTableResponse_table :: Lens' CreateTableResponse (Maybe Table)
createTableResponse_httpStatus :: Lens' CreateTableResponse Int

Creating a Request

data CreateTable Source #

See: newCreateTable smart constructor.

Constructors

CreateTable'

Fields

magneticStoreWriteProperties :: Maybe MagneticStoreWriteProperties
Contains properties to set on the table when enabling magnetic store writes.
retentionProperties :: Maybe RetentionProperties
The duration for which your time series data must be stored in the memory store and the magnetic store.
tags :: Maybe [Tag]
A list of key-value pairs to label the table.
databaseName :: Text
The name of the Timestream database.
tableName :: Text
The name of the Timestream table.

Instances

Instances details

ToJSON CreateTable Source #
Instance details Defined in Amazonka.TimeStreamWrite.CreateTable Methods toJSON :: CreateTable -> Value # toEncoding :: CreateTable -> Encoding # toJSONList :: [CreateTable] -> Value # toEncodingList :: [CreateTable] -> Encoding #
ToHeaders CreateTable Source #
Instance details Defined in Amazonka.TimeStreamWrite.CreateTable Methods toHeaders :: CreateTable -> [Header] #
ToPath CreateTable Source #
Instance details Defined in Amazonka.TimeStreamWrite.CreateTable Methods toPath :: CreateTable -> ByteString #
ToQuery CreateTable Source #
Instance details Defined in Amazonka.TimeStreamWrite.CreateTable Methods toQuery :: CreateTable -> QueryString #
AWSRequest CreateTable Source #
Instance details Defined in Amazonka.TimeStreamWrite.CreateTable Associated Types type AWSResponse CreateTable # Methods request :: (Service -> Service) -> CreateTable -> Request CreateTable # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateTable -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateTable))) #
Generic CreateTable Source #
Instance details Defined in Amazonka.TimeStreamWrite.CreateTable Associated Types type Rep CreateTable :: Type -> Type # Methods from :: CreateTable -> Rep CreateTable x # to :: Rep CreateTable x -> CreateTable #
Read CreateTable Source #
Instance details Defined in Amazonka.TimeStreamWrite.CreateTable Methods readsPrec :: Int -> ReadS CreateTable # readList :: ReadS [CreateTable] # readPrec :: ReadPrec CreateTable # readListPrec :: ReadPrec [CreateTable] #
Show CreateTable Source #
Instance details Defined in Amazonka.TimeStreamWrite.CreateTable Methods showsPrec :: Int -> CreateTable -> ShowS # show :: CreateTable -> String # showList :: [CreateTable] -> ShowS #
NFData CreateTable Source #
Instance details Defined in Amazonka.TimeStreamWrite.CreateTable Methods rnf :: CreateTable -> () #
Eq CreateTable Source #
Instance details Defined in Amazonka.TimeStreamWrite.CreateTable Methods (==) :: CreateTable -> CreateTable -> Bool # (/=) :: CreateTable -> CreateTable -> Bool #
Hashable CreateTable Source #
Instance details Defined in Amazonka.TimeStreamWrite.CreateTable Methods hashWithSalt :: Int -> CreateTable -> Int # hash :: CreateTable -> Int #
type AWSResponse CreateTable Source #
Instance details Defined in Amazonka.TimeStreamWrite.CreateTable type AWSResponse CreateTable = CreateTableResponse
type Rep CreateTable Source #
Instance details Defined in Amazonka.TimeStreamWrite.CreateTable type Rep CreateTable = D1 ('MetaData "CreateTable" "Amazonka.TimeStreamWrite.CreateTable" "amazonka-timestream-write-2.0-LXdAXNx5NaTIjNxYPQvSVq" 'False) (C1 ('MetaCons "CreateTable'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "magneticStoreWriteProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MagneticStoreWriteProperties)) :: S1 ('MetaSel ('Just "retentionProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetentionProperties))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: (S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateTable Source #

Arguments

:: Text	`CreateTable`
-> Text	`CreateTable`
-> CreateTable

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

CreateTable, createTable_magneticStoreWriteProperties - Contains properties to set on the table when enabling magnetic store writes.

CreateTable, createTable_retentionProperties - The duration for which your time series data must be stored in the memory store and the magnetic store.

$sel:tags:CreateTable', createTable_tags - A list of key-value pairs to label the table.

CreateTable, createTable_databaseName - The name of the Timestream database.

CreateTable, createTable_tableName - The name of the Timestream table.

Request Lenses

createTable_magneticStoreWriteProperties :: Lens' CreateTable (Maybe MagneticStoreWriteProperties) Source #

Contains properties to set on the table when enabling magnetic store writes.

createTable_retentionProperties :: Lens' CreateTable (Maybe RetentionProperties) Source #

The duration for which your time series data must be stored in the memory store and the magnetic store.

createTable_tags :: Lens' CreateTable (Maybe [Tag]) Source #

A list of key-value pairs to label the table.

createTable_databaseName :: Lens' CreateTable Text Source #

The name of the Timestream database.

createTable_tableName :: Lens' CreateTable Text Source #

The name of the Timestream table.

Destructuring the Response

data CreateTableResponse Source #

See: newCreateTableResponse smart constructor.

Constructors

CreateTableResponse'
Fields table :: Maybe Table The newly created Timestream table. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateTableResponse Source #
Instance details Defined in Amazonka.TimeStreamWrite.CreateTable Associated Types type Rep CreateTableResponse :: Type -> Type # Methods from :: CreateTableResponse -> Rep CreateTableResponse x # to :: Rep CreateTableResponse x -> CreateTableResponse #
Read CreateTableResponse Source #
Instance details Defined in Amazonka.TimeStreamWrite.CreateTable Methods readsPrec :: Int -> ReadS CreateTableResponse # readList :: ReadS [CreateTableResponse] # readPrec :: ReadPrec CreateTableResponse # readListPrec :: ReadPrec [CreateTableResponse] #
Show CreateTableResponse Source #
Instance details Defined in Amazonka.TimeStreamWrite.CreateTable Methods showsPrec :: Int -> CreateTableResponse -> ShowS # show :: CreateTableResponse -> String # showList :: [CreateTableResponse] -> ShowS #
NFData CreateTableResponse Source #
Instance details Defined in Amazonka.TimeStreamWrite.CreateTable Methods rnf :: CreateTableResponse -> () #
Eq CreateTableResponse Source #
Instance details Defined in Amazonka.TimeStreamWrite.CreateTable Methods (==) :: CreateTableResponse -> CreateTableResponse -> Bool # (/=) :: CreateTableResponse -> CreateTableResponse -> Bool #
type Rep CreateTableResponse Source #
Instance details Defined in Amazonka.TimeStreamWrite.CreateTable type Rep CreateTableResponse = D1 ('MetaData "CreateTableResponse" "Amazonka.TimeStreamWrite.CreateTable" "amazonka-timestream-write-2.0-LXdAXNx5NaTIjNxYPQvSVq" 'False) (C1 ('MetaCons "CreateTableResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "table") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Table)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateTableResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateTableResponse'`
-> CreateTableResponse

Create a value of CreateTableResponse 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:table:CreateTableResponse', createTableResponse_table - The newly created Timestream table.

$sel:httpStatus:CreateTableResponse', createTableResponse_httpStatus - The response's http status code.

Response Lenses

createTableResponse_table :: Lens' CreateTableResponse (Maybe Table) Source #

The newly created Timestream table.

createTableResponse_httpStatus :: Lens' CreateTableResponse Int Source #

The response's http status code.