-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/
-- | Amazon Keyspaces SDK.
--
-- Derived from API version 2022-02-10 of the AWS service
-- descriptions, licensed under Apache 2.0.
--
-- The types from this library are intended to be used with
-- amazonka, which provides mechanisms for specifying AuthN/AuthZ
-- information, sending requests, and receiving responses.
--
-- It is recommended to use generic lenses or optics from packages such
-- as generic-lens or optics to modify optional fields and
-- deconstruct responses.
--
-- Generated lenses can be found in Amazonka.KeySpaces.Lens and
-- are suitable for use with a lens package such as lens or
-- lens-family-core.
--
-- See Amazonka.KeySpaces and the AWS documentation to get
-- started.
@package amazonka-keyspaces
@version 2.0
module Amazonka.KeySpaces.Types.ColumnDefinition
-- | The names and data types of regular columns.
--
-- See: newColumnDefinition smart constructor.
data ColumnDefinition
ColumnDefinition' :: Text -> Text -> ColumnDefinition
-- | The name of the column.
[$sel:name:ColumnDefinition'] :: ColumnDefinition -> Text
-- | The data type of the column. For a list of available data types, see
-- Data types in the Amazon Keyspaces Developer Guide.
[$sel:type':ColumnDefinition'] :: ColumnDefinition -> Text
-- | Create a value of ColumnDefinition 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:name:ColumnDefinition', columnDefinition_name - The
-- name of the column.
--
-- $sel:type':ColumnDefinition', columnDefinition_type -
-- The data type of the column. For a list of available data types, see
-- Data types in the Amazon Keyspaces Developer Guide.
newColumnDefinition :: Text -> Text -> ColumnDefinition
-- | The name of the column.
columnDefinition_name :: Lens' ColumnDefinition Text
-- | The data type of the column. For a list of available data types, see
-- Data types in the Amazon Keyspaces Developer Guide.
columnDefinition_type :: Lens' ColumnDefinition Text
instance GHC.Generics.Generic Amazonka.KeySpaces.Types.ColumnDefinition.ColumnDefinition
instance GHC.Show.Show Amazonka.KeySpaces.Types.ColumnDefinition.ColumnDefinition
instance GHC.Read.Read Amazonka.KeySpaces.Types.ColumnDefinition.ColumnDefinition
instance GHC.Classes.Eq Amazonka.KeySpaces.Types.ColumnDefinition.ColumnDefinition
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.KeySpaces.Types.ColumnDefinition.ColumnDefinition
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.Types.ColumnDefinition.ColumnDefinition
instance Control.DeepSeq.NFData Amazonka.KeySpaces.Types.ColumnDefinition.ColumnDefinition
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.Types.ColumnDefinition.ColumnDefinition
module Amazonka.KeySpaces.Types.Comment
-- | An optional comment that describes the table.
--
-- See: newComment smart constructor.
data Comment
Comment' :: Text -> Comment
-- | An optional description of the table.
[$sel:message:Comment'] :: Comment -> Text
-- | Create a value of Comment 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:message:Comment', comment_message - An optional
-- description of the table.
newComment :: Text -> Comment
-- | An optional description of the table.
comment_message :: Lens' Comment Text
instance GHC.Generics.Generic Amazonka.KeySpaces.Types.Comment.Comment
instance GHC.Show.Show Amazonka.KeySpaces.Types.Comment.Comment
instance GHC.Read.Read Amazonka.KeySpaces.Types.Comment.Comment
instance GHC.Classes.Eq Amazonka.KeySpaces.Types.Comment.Comment
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.KeySpaces.Types.Comment.Comment
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.Types.Comment.Comment
instance Control.DeepSeq.NFData Amazonka.KeySpaces.Types.Comment.Comment
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.Types.Comment.Comment
module Amazonka.KeySpaces.Types.EncryptionType
newtype EncryptionType
EncryptionType' :: Text -> EncryptionType
[fromEncryptionType] :: EncryptionType -> Text
pattern EncryptionType_AWS_OWNED_KMS_KEY :: EncryptionType
pattern EncryptionType_CUSTOMER_MANAGED_KMS_KEY :: EncryptionType
instance Amazonka.Data.XML.ToXML Amazonka.KeySpaces.Types.EncryptionType.EncryptionType
instance Amazonka.Data.XML.FromXML Amazonka.KeySpaces.Types.EncryptionType.EncryptionType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.KeySpaces.Types.EncryptionType.EncryptionType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.Types.EncryptionType.EncryptionType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.KeySpaces.Types.EncryptionType.EncryptionType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.KeySpaces.Types.EncryptionType.EncryptionType
instance Amazonka.Data.Query.ToQuery Amazonka.KeySpaces.Types.EncryptionType.EncryptionType
instance Amazonka.Data.Headers.ToHeader Amazonka.KeySpaces.Types.EncryptionType.EncryptionType
instance Amazonka.Data.Log.ToLog Amazonka.KeySpaces.Types.EncryptionType.EncryptionType
instance Amazonka.Data.ByteString.ToByteString Amazonka.KeySpaces.Types.EncryptionType.EncryptionType
instance Amazonka.Data.Text.ToText Amazonka.KeySpaces.Types.EncryptionType.EncryptionType
instance Amazonka.Data.Text.FromText Amazonka.KeySpaces.Types.EncryptionType.EncryptionType
instance Control.DeepSeq.NFData Amazonka.KeySpaces.Types.EncryptionType.EncryptionType
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.Types.EncryptionType.EncryptionType
instance GHC.Generics.Generic Amazonka.KeySpaces.Types.EncryptionType.EncryptionType
instance GHC.Classes.Ord Amazonka.KeySpaces.Types.EncryptionType.EncryptionType
instance GHC.Classes.Eq Amazonka.KeySpaces.Types.EncryptionType.EncryptionType
instance GHC.Read.Read Amazonka.KeySpaces.Types.EncryptionType.EncryptionType
instance GHC.Show.Show Amazonka.KeySpaces.Types.EncryptionType.EncryptionType
module Amazonka.KeySpaces.Types.EncryptionSpecification
-- | Amazon Keyspaces encrypts and decrypts the table data at rest
-- transparently and integrates with Key Management Service for storing
-- and managing the encryption key. You can choose one of the following
-- KMS keys (KMS keys):
--
-- • Amazon Web Services owned key - This is the default encryption type.
-- The key is owned by Amazon Keyspaces (no additional charge).
--
-- • Customer managed key - This key is stored in your account and is
-- created, owned, and managed by you. You have full control over the
-- customer managed key (KMS charges apply).
--
-- For more information about encryption at rest in Amazon Keyspaces, see
-- Encryption at rest in the Amazon Keyspaces Developer
-- Guide.
--
-- For more information about KMS, see KMS management service
-- concepts in the Key Management Service Developer Guide.
--
-- See: newEncryptionSpecification smart constructor.
data EncryptionSpecification
EncryptionSpecification' :: Maybe Text -> EncryptionType -> EncryptionSpecification
-- | The Amazon Resource Name (ARN) of the customer managed KMS key, for
-- example kms_key_identifier:ARN.
[$sel:kmsKeyIdentifier:EncryptionSpecification'] :: EncryptionSpecification -> Maybe Text
-- | The encryption option specified for the table. You can choose one of
-- the following KMS keys (KMS keys):
--
-- • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon
-- Keyspaces.
--
-- • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your
-- account and is created, owned, and managed by you. This option
-- requires the kms_key_identifier of the KMS key in Amazon
-- Resource Name (ARN) format as input.
--
-- The default is type:AWS_OWNED_KMS_KEY.
--
-- For more information, see Encryption at rest in the Amazon
-- Keyspaces Developer Guide.
[$sel:type':EncryptionSpecification'] :: EncryptionSpecification -> EncryptionType
-- | Create a value of EncryptionSpecification 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:kmsKeyIdentifier:EncryptionSpecification',
-- encryptionSpecification_kmsKeyIdentifier - The Amazon Resource
-- Name (ARN) of the customer managed KMS key, for example
-- kms_key_identifier:ARN.
--
-- $sel:type':EncryptionSpecification',
-- encryptionSpecification_type - The encryption option specified
-- for the table. You can choose one of the following KMS keys (KMS
-- keys):
--
-- • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon
-- Keyspaces.
--
-- • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your
-- account and is created, owned, and managed by you. This option
-- requires the kms_key_identifier of the KMS key in Amazon
-- Resource Name (ARN) format as input.
--
-- The default is type:AWS_OWNED_KMS_KEY.
--
-- For more information, see Encryption at rest in the Amazon
-- Keyspaces Developer Guide.
newEncryptionSpecification :: EncryptionType -> EncryptionSpecification
-- | The Amazon Resource Name (ARN) of the customer managed KMS key, for
-- example kms_key_identifier:ARN.
encryptionSpecification_kmsKeyIdentifier :: Lens' EncryptionSpecification (Maybe Text)
-- | The encryption option specified for the table. You can choose one of
-- the following KMS keys (KMS keys):
--
-- • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon
-- Keyspaces.
--
-- • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your
-- account and is created, owned, and managed by you. This option
-- requires the kms_key_identifier of the KMS key in Amazon
-- Resource Name (ARN) format as input.
--
-- The default is type:AWS_OWNED_KMS_KEY.
--
-- For more information, see Encryption at rest in the Amazon
-- Keyspaces Developer Guide.
encryptionSpecification_type :: Lens' EncryptionSpecification EncryptionType
instance GHC.Generics.Generic Amazonka.KeySpaces.Types.EncryptionSpecification.EncryptionSpecification
instance GHC.Show.Show Amazonka.KeySpaces.Types.EncryptionSpecification.EncryptionSpecification
instance GHC.Read.Read Amazonka.KeySpaces.Types.EncryptionSpecification.EncryptionSpecification
instance GHC.Classes.Eq Amazonka.KeySpaces.Types.EncryptionSpecification.EncryptionSpecification
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.KeySpaces.Types.EncryptionSpecification.EncryptionSpecification
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.Types.EncryptionSpecification.EncryptionSpecification
instance Control.DeepSeq.NFData Amazonka.KeySpaces.Types.EncryptionSpecification.EncryptionSpecification
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.Types.EncryptionSpecification.EncryptionSpecification
module Amazonka.KeySpaces.Types.KeyspaceSummary
-- | Represents the properties of a keyspace.
--
-- See: newKeyspaceSummary smart constructor.
data KeyspaceSummary
KeyspaceSummary' :: Text -> Text -> KeyspaceSummary
-- | The name of the keyspace.
[$sel:keyspaceName:KeyspaceSummary'] :: KeyspaceSummary -> Text
-- | The unique identifier of the keyspace in the format of an Amazon
-- Resource Name (ARN).
[$sel:resourceArn:KeyspaceSummary'] :: KeyspaceSummary -> Text
-- | Create a value of KeyspaceSummary 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:keyspaceName:KeyspaceSummary',
-- keyspaceSummary_keyspaceName - The name of the keyspace.
--
-- $sel:resourceArn:KeyspaceSummary',
-- keyspaceSummary_resourceArn - The unique identifier of the
-- keyspace in the format of an Amazon Resource Name (ARN).
newKeyspaceSummary :: Text -> Text -> KeyspaceSummary
-- | The name of the keyspace.
keyspaceSummary_keyspaceName :: Lens' KeyspaceSummary Text
-- | The unique identifier of the keyspace in the format of an Amazon
-- Resource Name (ARN).
keyspaceSummary_resourceArn :: Lens' KeyspaceSummary Text
instance GHC.Generics.Generic Amazonka.KeySpaces.Types.KeyspaceSummary.KeyspaceSummary
instance GHC.Show.Show Amazonka.KeySpaces.Types.KeyspaceSummary.KeyspaceSummary
instance GHC.Read.Read Amazonka.KeySpaces.Types.KeyspaceSummary.KeyspaceSummary
instance GHC.Classes.Eq Amazonka.KeySpaces.Types.KeyspaceSummary.KeyspaceSummary
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.KeySpaces.Types.KeyspaceSummary.KeyspaceSummary
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.Types.KeyspaceSummary.KeyspaceSummary
instance Control.DeepSeq.NFData Amazonka.KeySpaces.Types.KeyspaceSummary.KeyspaceSummary
module Amazonka.KeySpaces.Types.PartitionKey
-- | The partition key portion of the primary key is required and
-- determines how Amazon Keyspaces stores the data. The partition key can
-- be a single column, or it can be a compound value composed of two or
-- more columns.
--
-- See: newPartitionKey smart constructor.
data PartitionKey
PartitionKey' :: Text -> PartitionKey
-- | The name(s) of the partition key column(s).
[$sel:name:PartitionKey'] :: PartitionKey -> Text
-- | Create a value of PartitionKey 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:name:PartitionKey', partitionKey_name - The name(s)
-- of the partition key column(s).
newPartitionKey :: Text -> PartitionKey
-- | The name(s) of the partition key column(s).
partitionKey_name :: Lens' PartitionKey Text
instance GHC.Generics.Generic Amazonka.KeySpaces.Types.PartitionKey.PartitionKey
instance GHC.Show.Show Amazonka.KeySpaces.Types.PartitionKey.PartitionKey
instance GHC.Read.Read Amazonka.KeySpaces.Types.PartitionKey.PartitionKey
instance GHC.Classes.Eq Amazonka.KeySpaces.Types.PartitionKey.PartitionKey
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.KeySpaces.Types.PartitionKey.PartitionKey
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.Types.PartitionKey.PartitionKey
instance Control.DeepSeq.NFData Amazonka.KeySpaces.Types.PartitionKey.PartitionKey
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.Types.PartitionKey.PartitionKey
module Amazonka.KeySpaces.Types.PointInTimeRecoveryStatus
newtype PointInTimeRecoveryStatus
PointInTimeRecoveryStatus' :: Text -> PointInTimeRecoveryStatus
[fromPointInTimeRecoveryStatus] :: PointInTimeRecoveryStatus -> Text
pattern PointInTimeRecoveryStatus_DISABLED :: PointInTimeRecoveryStatus
pattern PointInTimeRecoveryStatus_ENABLED :: PointInTimeRecoveryStatus
instance Amazonka.Data.XML.ToXML Amazonka.KeySpaces.Types.PointInTimeRecoveryStatus.PointInTimeRecoveryStatus
instance Amazonka.Data.XML.FromXML Amazonka.KeySpaces.Types.PointInTimeRecoveryStatus.PointInTimeRecoveryStatus
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.KeySpaces.Types.PointInTimeRecoveryStatus.PointInTimeRecoveryStatus
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.Types.PointInTimeRecoveryStatus.PointInTimeRecoveryStatus
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.KeySpaces.Types.PointInTimeRecoveryStatus.PointInTimeRecoveryStatus
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.KeySpaces.Types.PointInTimeRecoveryStatus.PointInTimeRecoveryStatus
instance Amazonka.Data.Query.ToQuery Amazonka.KeySpaces.Types.PointInTimeRecoveryStatus.PointInTimeRecoveryStatus
instance Amazonka.Data.Headers.ToHeader Amazonka.KeySpaces.Types.PointInTimeRecoveryStatus.PointInTimeRecoveryStatus
instance Amazonka.Data.Log.ToLog Amazonka.KeySpaces.Types.PointInTimeRecoveryStatus.PointInTimeRecoveryStatus
instance Amazonka.Data.ByteString.ToByteString Amazonka.KeySpaces.Types.PointInTimeRecoveryStatus.PointInTimeRecoveryStatus
instance Amazonka.Data.Text.ToText Amazonka.KeySpaces.Types.PointInTimeRecoveryStatus.PointInTimeRecoveryStatus
instance Amazonka.Data.Text.FromText Amazonka.KeySpaces.Types.PointInTimeRecoveryStatus.PointInTimeRecoveryStatus
instance Control.DeepSeq.NFData Amazonka.KeySpaces.Types.PointInTimeRecoveryStatus.PointInTimeRecoveryStatus
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.Types.PointInTimeRecoveryStatus.PointInTimeRecoveryStatus
instance GHC.Generics.Generic Amazonka.KeySpaces.Types.PointInTimeRecoveryStatus.PointInTimeRecoveryStatus
instance GHC.Classes.Ord Amazonka.KeySpaces.Types.PointInTimeRecoveryStatus.PointInTimeRecoveryStatus
instance GHC.Classes.Eq Amazonka.KeySpaces.Types.PointInTimeRecoveryStatus.PointInTimeRecoveryStatus
instance GHC.Read.Read Amazonka.KeySpaces.Types.PointInTimeRecoveryStatus.PointInTimeRecoveryStatus
instance GHC.Show.Show Amazonka.KeySpaces.Types.PointInTimeRecoveryStatus.PointInTimeRecoveryStatus
module Amazonka.KeySpaces.Types.PointInTimeRecovery
-- | Point-in-time recovery (PITR) helps protect your Amazon Keyspaces
-- tables from accidental write or delete operations by providing you
-- continuous backups of your table data.
--
-- For more information, see Point-in-time recovery in the
-- Amazon Keyspaces Developer Guide.
--
-- See: newPointInTimeRecovery smart constructor.
data PointInTimeRecovery
PointInTimeRecovery' :: PointInTimeRecoveryStatus -> PointInTimeRecovery
-- | The options are:
--
-- • ENABLED
--
-- • DISABLED
[$sel:status:PointInTimeRecovery'] :: PointInTimeRecovery -> PointInTimeRecoveryStatus
-- | Create a value of PointInTimeRecovery 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:status:PointInTimeRecovery',
-- pointInTimeRecovery_status - The options are:
--
-- • ENABLED
--
-- • DISABLED
newPointInTimeRecovery :: PointInTimeRecoveryStatus -> PointInTimeRecovery
-- | The options are:
--
-- • ENABLED
--
-- • DISABLED
pointInTimeRecovery_status :: Lens' PointInTimeRecovery PointInTimeRecoveryStatus
instance GHC.Generics.Generic Amazonka.KeySpaces.Types.PointInTimeRecovery.PointInTimeRecovery
instance GHC.Show.Show Amazonka.KeySpaces.Types.PointInTimeRecovery.PointInTimeRecovery
instance GHC.Read.Read Amazonka.KeySpaces.Types.PointInTimeRecovery.PointInTimeRecovery
instance GHC.Classes.Eq Amazonka.KeySpaces.Types.PointInTimeRecovery.PointInTimeRecovery
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.Types.PointInTimeRecovery.PointInTimeRecovery
instance Control.DeepSeq.NFData Amazonka.KeySpaces.Types.PointInTimeRecovery.PointInTimeRecovery
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.Types.PointInTimeRecovery.PointInTimeRecovery
module Amazonka.KeySpaces.Types.PointInTimeRecoverySummary
-- | The point-in-time recovery status of the specified table.
--
-- See: newPointInTimeRecoverySummary smart constructor.
data PointInTimeRecoverySummary
PointInTimeRecoverySummary' :: Maybe POSIX -> PointInTimeRecoveryStatus -> PointInTimeRecoverySummary
-- | Specifies the earliest possible restore point of the table in ISO 8601
-- format.
[$sel:earliestRestorableTimestamp:PointInTimeRecoverySummary'] :: PointInTimeRecoverySummary -> Maybe POSIX
-- | Shows if point-in-time recovery is enabled or disabled for the
-- specified table.
[$sel:status:PointInTimeRecoverySummary'] :: PointInTimeRecoverySummary -> PointInTimeRecoveryStatus
-- | Create a value of PointInTimeRecoverySummary 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:earliestRestorableTimestamp:PointInTimeRecoverySummary',
-- pointInTimeRecoverySummary_earliestRestorableTimestamp -
-- Specifies the earliest possible restore point of the table in ISO 8601
-- format.
--
-- $sel:status:PointInTimeRecoverySummary',
-- pointInTimeRecoverySummary_status - Shows if point-in-time
-- recovery is enabled or disabled for the specified table.
newPointInTimeRecoverySummary :: PointInTimeRecoveryStatus -> PointInTimeRecoverySummary
-- | Specifies the earliest possible restore point of the table in ISO 8601
-- format.
pointInTimeRecoverySummary_earliestRestorableTimestamp :: Lens' PointInTimeRecoverySummary (Maybe UTCTime)
-- | Shows if point-in-time recovery is enabled or disabled for the
-- specified table.
pointInTimeRecoverySummary_status :: Lens' PointInTimeRecoverySummary PointInTimeRecoveryStatus
instance GHC.Generics.Generic Amazonka.KeySpaces.Types.PointInTimeRecoverySummary.PointInTimeRecoverySummary
instance GHC.Show.Show Amazonka.KeySpaces.Types.PointInTimeRecoverySummary.PointInTimeRecoverySummary
instance GHC.Read.Read Amazonka.KeySpaces.Types.PointInTimeRecoverySummary.PointInTimeRecoverySummary
instance GHC.Classes.Eq Amazonka.KeySpaces.Types.PointInTimeRecoverySummary.PointInTimeRecoverySummary
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.KeySpaces.Types.PointInTimeRecoverySummary.PointInTimeRecoverySummary
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.Types.PointInTimeRecoverySummary.PointInTimeRecoverySummary
instance Control.DeepSeq.NFData Amazonka.KeySpaces.Types.PointInTimeRecoverySummary.PointInTimeRecoverySummary
module Amazonka.KeySpaces.Types.SortOrder
newtype SortOrder
SortOrder' :: Text -> SortOrder
[fromSortOrder] :: SortOrder -> Text
pattern SortOrder_ASC :: SortOrder
pattern SortOrder_DESC :: SortOrder
instance Amazonka.Data.XML.ToXML Amazonka.KeySpaces.Types.SortOrder.SortOrder
instance Amazonka.Data.XML.FromXML Amazonka.KeySpaces.Types.SortOrder.SortOrder
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.KeySpaces.Types.SortOrder.SortOrder
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.Types.SortOrder.SortOrder
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.KeySpaces.Types.SortOrder.SortOrder
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.KeySpaces.Types.SortOrder.SortOrder
instance Amazonka.Data.Query.ToQuery Amazonka.KeySpaces.Types.SortOrder.SortOrder
instance Amazonka.Data.Headers.ToHeader Amazonka.KeySpaces.Types.SortOrder.SortOrder
instance Amazonka.Data.Log.ToLog Amazonka.KeySpaces.Types.SortOrder.SortOrder
instance Amazonka.Data.ByteString.ToByteString Amazonka.KeySpaces.Types.SortOrder.SortOrder
instance Amazonka.Data.Text.ToText Amazonka.KeySpaces.Types.SortOrder.SortOrder
instance Amazonka.Data.Text.FromText Amazonka.KeySpaces.Types.SortOrder.SortOrder
instance Control.DeepSeq.NFData Amazonka.KeySpaces.Types.SortOrder.SortOrder
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.Types.SortOrder.SortOrder
instance GHC.Generics.Generic Amazonka.KeySpaces.Types.SortOrder.SortOrder
instance GHC.Classes.Ord Amazonka.KeySpaces.Types.SortOrder.SortOrder
instance GHC.Classes.Eq Amazonka.KeySpaces.Types.SortOrder.SortOrder
instance GHC.Read.Read Amazonka.KeySpaces.Types.SortOrder.SortOrder
instance GHC.Show.Show Amazonka.KeySpaces.Types.SortOrder.SortOrder
module Amazonka.KeySpaces.Types.ClusteringKey
-- | The optional clustering column portion of your primary key determines
-- how the data is clustered and sorted within each partition.
--
-- See: newClusteringKey smart constructor.
data ClusteringKey
ClusteringKey' :: Text -> SortOrder -> ClusteringKey
-- | The name(s) of the clustering column(s).
[$sel:name:ClusteringKey'] :: ClusteringKey -> Text
-- | Sets the ascendant (ASC) or descendant (DESC) order
-- modifier.
[$sel:orderBy:ClusteringKey'] :: ClusteringKey -> SortOrder
-- | Create a value of ClusteringKey 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:name:ClusteringKey', clusteringKey_name - The
-- name(s) of the clustering column(s).
--
-- $sel:orderBy:ClusteringKey', clusteringKey_orderBy -
-- Sets the ascendant (ASC) or descendant (DESC) order
-- modifier.
newClusteringKey :: Text -> SortOrder -> ClusteringKey
-- | The name(s) of the clustering column(s).
clusteringKey_name :: Lens' ClusteringKey Text
-- | Sets the ascendant (ASC) or descendant (DESC) order
-- modifier.
clusteringKey_orderBy :: Lens' ClusteringKey SortOrder
instance GHC.Generics.Generic Amazonka.KeySpaces.Types.ClusteringKey.ClusteringKey
instance GHC.Show.Show Amazonka.KeySpaces.Types.ClusteringKey.ClusteringKey
instance GHC.Read.Read Amazonka.KeySpaces.Types.ClusteringKey.ClusteringKey
instance GHC.Classes.Eq Amazonka.KeySpaces.Types.ClusteringKey.ClusteringKey
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.KeySpaces.Types.ClusteringKey.ClusteringKey
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.Types.ClusteringKey.ClusteringKey
instance Control.DeepSeq.NFData Amazonka.KeySpaces.Types.ClusteringKey.ClusteringKey
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.Types.ClusteringKey.ClusteringKey
module Amazonka.KeySpaces.Types.StaticColumn
-- | The static columns of the table. Static columns store values that are
-- shared by all rows in the same partition.
--
-- See: newStaticColumn smart constructor.
data StaticColumn
StaticColumn' :: Text -> StaticColumn
-- | The name of the static column.
[$sel:name:StaticColumn'] :: StaticColumn -> Text
-- | Create a value of StaticColumn 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:name:StaticColumn', staticColumn_name - The name of
-- the static column.
newStaticColumn :: Text -> StaticColumn
-- | The name of the static column.
staticColumn_name :: Lens' StaticColumn Text
instance GHC.Generics.Generic Amazonka.KeySpaces.Types.StaticColumn.StaticColumn
instance GHC.Show.Show Amazonka.KeySpaces.Types.StaticColumn.StaticColumn
instance GHC.Read.Read Amazonka.KeySpaces.Types.StaticColumn.StaticColumn
instance GHC.Classes.Eq Amazonka.KeySpaces.Types.StaticColumn.StaticColumn
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.KeySpaces.Types.StaticColumn.StaticColumn
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.Types.StaticColumn.StaticColumn
instance Control.DeepSeq.NFData Amazonka.KeySpaces.Types.StaticColumn.StaticColumn
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.Types.StaticColumn.StaticColumn
module Amazonka.KeySpaces.Types.SchemaDefinition
-- | Describes the schema of the table.
--
-- See: newSchemaDefinition smart constructor.
data SchemaDefinition
SchemaDefinition' :: Maybe [ClusteringKey] -> Maybe [StaticColumn] -> NonEmpty ColumnDefinition -> NonEmpty PartitionKey -> SchemaDefinition
-- | The columns that are part of the clustering key of the table.
[$sel:clusteringKeys:SchemaDefinition'] :: SchemaDefinition -> Maybe [ClusteringKey]
-- | The columns that have been defined as STATIC. Static columns
-- store values that are shared by all rows in the same partition.
[$sel:staticColumns:SchemaDefinition'] :: SchemaDefinition -> Maybe [StaticColumn]
-- | The regular columns of the table.
[$sel:allColumns:SchemaDefinition'] :: SchemaDefinition -> NonEmpty ColumnDefinition
-- | The columns that are part of the partition key of the table .
[$sel:partitionKeys:SchemaDefinition'] :: SchemaDefinition -> NonEmpty PartitionKey
-- | Create a value of SchemaDefinition 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:clusteringKeys:SchemaDefinition',
-- schemaDefinition_clusteringKeys - The columns that are part of
-- the clustering key of the table.
--
-- $sel:staticColumns:SchemaDefinition',
-- schemaDefinition_staticColumns - The columns that have been
-- defined as STATIC. Static columns store values that are
-- shared by all rows in the same partition.
--
-- $sel:allColumns:SchemaDefinition',
-- schemaDefinition_allColumns - The regular columns of the table.
--
-- $sel:partitionKeys:SchemaDefinition',
-- schemaDefinition_partitionKeys - The columns that are part of
-- the partition key of the table .
newSchemaDefinition :: NonEmpty ColumnDefinition -> NonEmpty PartitionKey -> SchemaDefinition
-- | The columns that are part of the clustering key of the table.
schemaDefinition_clusteringKeys :: Lens' SchemaDefinition (Maybe [ClusteringKey])
-- | The columns that have been defined as STATIC. Static columns
-- store values that are shared by all rows in the same partition.
schemaDefinition_staticColumns :: Lens' SchemaDefinition (Maybe [StaticColumn])
-- | The regular columns of the table.
schemaDefinition_allColumns :: Lens' SchemaDefinition (NonEmpty ColumnDefinition)
-- | The columns that are part of the partition key of the table .
schemaDefinition_partitionKeys :: Lens' SchemaDefinition (NonEmpty PartitionKey)
instance GHC.Generics.Generic Amazonka.KeySpaces.Types.SchemaDefinition.SchemaDefinition
instance GHC.Show.Show Amazonka.KeySpaces.Types.SchemaDefinition.SchemaDefinition
instance GHC.Read.Read Amazonka.KeySpaces.Types.SchemaDefinition.SchemaDefinition
instance GHC.Classes.Eq Amazonka.KeySpaces.Types.SchemaDefinition.SchemaDefinition
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.KeySpaces.Types.SchemaDefinition.SchemaDefinition
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.Types.SchemaDefinition.SchemaDefinition
instance Control.DeepSeq.NFData Amazonka.KeySpaces.Types.SchemaDefinition.SchemaDefinition
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.Types.SchemaDefinition.SchemaDefinition
module Amazonka.KeySpaces.Types.TableStatus
newtype TableStatus
TableStatus' :: Text -> TableStatus
[fromTableStatus] :: TableStatus -> Text
pattern TableStatus_ACTIVE :: TableStatus
pattern TableStatus_CREATING :: TableStatus
pattern TableStatus_DELETED :: TableStatus
pattern TableStatus_DELETING :: TableStatus
pattern TableStatus_INACCESSIBLE_ENCRYPTION_CREDENTIALS :: TableStatus
pattern TableStatus_RESTORING :: TableStatus
pattern TableStatus_UPDATING :: TableStatus
instance Amazonka.Data.XML.ToXML Amazonka.KeySpaces.Types.TableStatus.TableStatus
instance Amazonka.Data.XML.FromXML Amazonka.KeySpaces.Types.TableStatus.TableStatus
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.KeySpaces.Types.TableStatus.TableStatus
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.Types.TableStatus.TableStatus
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.KeySpaces.Types.TableStatus.TableStatus
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.KeySpaces.Types.TableStatus.TableStatus
instance Amazonka.Data.Query.ToQuery Amazonka.KeySpaces.Types.TableStatus.TableStatus
instance Amazonka.Data.Headers.ToHeader Amazonka.KeySpaces.Types.TableStatus.TableStatus
instance Amazonka.Data.Log.ToLog Amazonka.KeySpaces.Types.TableStatus.TableStatus
instance Amazonka.Data.ByteString.ToByteString Amazonka.KeySpaces.Types.TableStatus.TableStatus
instance Amazonka.Data.Text.ToText Amazonka.KeySpaces.Types.TableStatus.TableStatus
instance Amazonka.Data.Text.FromText Amazonka.KeySpaces.Types.TableStatus.TableStatus
instance Control.DeepSeq.NFData Amazonka.KeySpaces.Types.TableStatus.TableStatus
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.Types.TableStatus.TableStatus
instance GHC.Generics.Generic Amazonka.KeySpaces.Types.TableStatus.TableStatus
instance GHC.Classes.Ord Amazonka.KeySpaces.Types.TableStatus.TableStatus
instance GHC.Classes.Eq Amazonka.KeySpaces.Types.TableStatus.TableStatus
instance GHC.Read.Read Amazonka.KeySpaces.Types.TableStatus.TableStatus
instance GHC.Show.Show Amazonka.KeySpaces.Types.TableStatus.TableStatus
module Amazonka.KeySpaces.Types.TableSummary
-- | Returns the name of the specified table, the keyspace it is stored in,
-- and the unique identifier in the format of an Amazon Resource Name
-- (ARN).
--
-- See: newTableSummary smart constructor.
data TableSummary
TableSummary' :: Text -> Text -> Text -> TableSummary
-- | The name of the keyspace that the table is stored in.
[$sel:keyspaceName:TableSummary'] :: TableSummary -> Text
-- | The name of the table.
[$sel:tableName:TableSummary'] :: TableSummary -> Text
-- | The unique identifier of the table in the format of an Amazon Resource
-- Name (ARN).
[$sel:resourceArn:TableSummary'] :: TableSummary -> Text
-- | Create a value of TableSummary 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:keyspaceName:TableSummary',
-- tableSummary_keyspaceName - The name of the keyspace that the
-- table is stored in.
--
-- $sel:tableName:TableSummary', tableSummary_tableName -
-- The name of the table.
--
-- $sel:resourceArn:TableSummary', tableSummary_resourceArn
-- - The unique identifier of the table in the format of an Amazon
-- Resource Name (ARN).
newTableSummary :: Text -> Text -> Text -> TableSummary
-- | The name of the keyspace that the table is stored in.
tableSummary_keyspaceName :: Lens' TableSummary Text
-- | The name of the table.
tableSummary_tableName :: Lens' TableSummary Text
-- | The unique identifier of the table in the format of an Amazon Resource
-- Name (ARN).
tableSummary_resourceArn :: Lens' TableSummary Text
instance GHC.Generics.Generic Amazonka.KeySpaces.Types.TableSummary.TableSummary
instance GHC.Show.Show Amazonka.KeySpaces.Types.TableSummary.TableSummary
instance GHC.Read.Read Amazonka.KeySpaces.Types.TableSummary.TableSummary
instance GHC.Classes.Eq Amazonka.KeySpaces.Types.TableSummary.TableSummary
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.KeySpaces.Types.TableSummary.TableSummary
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.Types.TableSummary.TableSummary
instance Control.DeepSeq.NFData Amazonka.KeySpaces.Types.TableSummary.TableSummary
module Amazonka.KeySpaces.Types.Tag
-- | Describes a tag. A tag is a key-value pair. You can add up to 50 tags
-- to a single Amazon Keyspaces resource.
--
-- Amazon Web Services-assigned tag names and values are automatically
-- assigned the aws: prefix, which the user cannot assign.
-- Amazon Web Services-assigned tag names do not count towards the tag
-- limit of 50. User-assigned tag names have the prefix user: in
-- the Cost Allocation Report. You cannot backdate the application of a
-- tag.
--
-- For more information, see Adding tags and labels to Amazon
-- Keyspaces resources in the Amazon Keyspaces Developer
-- Guide.
--
-- See: newTag smart constructor.
data Tag
Tag' :: Text -> Text -> Tag
-- | The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces
-- resource can only have up to one tag with the same key. If you try to
-- add an existing tag (same key), the existing tag value will be updated
-- to the new value.
[$sel:key:Tag'] :: Tag -> Text
-- | The value of the tag. Tag values are case-sensitive and can be null.
[$sel:value:Tag'] :: Tag -> Text
-- | Create a value of Tag 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:key:Tag', tag_key - The key of the tag. Tag keys
-- are case sensitive. Each Amazon Keyspaces resource can only have up to
-- one tag with the same key. If you try to add an existing tag (same
-- key), the existing tag value will be updated to the new value.
--
-- $sel:value:Tag', tag_value - The value of the tag. Tag
-- values are case-sensitive and can be null.
newTag :: Text -> Text -> Tag
-- | The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces
-- resource can only have up to one tag with the same key. If you try to
-- add an existing tag (same key), the existing tag value will be updated
-- to the new value.
tag_key :: Lens' Tag Text
-- | The value of the tag. Tag values are case-sensitive and can be null.
tag_value :: Lens' Tag Text
instance GHC.Generics.Generic Amazonka.KeySpaces.Types.Tag.Tag
instance GHC.Show.Show Amazonka.KeySpaces.Types.Tag.Tag
instance GHC.Read.Read Amazonka.KeySpaces.Types.Tag.Tag
instance GHC.Classes.Eq Amazonka.KeySpaces.Types.Tag.Tag
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.KeySpaces.Types.Tag.Tag
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.Types.Tag.Tag
instance Control.DeepSeq.NFData Amazonka.KeySpaces.Types.Tag.Tag
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.Types.Tag.Tag
module Amazonka.KeySpaces.Types.ThroughputMode
newtype ThroughputMode
ThroughputMode' :: Text -> ThroughputMode
[fromThroughputMode] :: ThroughputMode -> Text
pattern ThroughputMode_PAY_PER_REQUEST :: ThroughputMode
pattern ThroughputMode_PROVISIONED :: ThroughputMode
instance Amazonka.Data.XML.ToXML Amazonka.KeySpaces.Types.ThroughputMode.ThroughputMode
instance Amazonka.Data.XML.FromXML Amazonka.KeySpaces.Types.ThroughputMode.ThroughputMode
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.KeySpaces.Types.ThroughputMode.ThroughputMode
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.Types.ThroughputMode.ThroughputMode
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.KeySpaces.Types.ThroughputMode.ThroughputMode
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.KeySpaces.Types.ThroughputMode.ThroughputMode
instance Amazonka.Data.Query.ToQuery Amazonka.KeySpaces.Types.ThroughputMode.ThroughputMode
instance Amazonka.Data.Headers.ToHeader Amazonka.KeySpaces.Types.ThroughputMode.ThroughputMode
instance Amazonka.Data.Log.ToLog Amazonka.KeySpaces.Types.ThroughputMode.ThroughputMode
instance Amazonka.Data.ByteString.ToByteString Amazonka.KeySpaces.Types.ThroughputMode.ThroughputMode
instance Amazonka.Data.Text.ToText Amazonka.KeySpaces.Types.ThroughputMode.ThroughputMode
instance Amazonka.Data.Text.FromText Amazonka.KeySpaces.Types.ThroughputMode.ThroughputMode
instance Control.DeepSeq.NFData Amazonka.KeySpaces.Types.ThroughputMode.ThroughputMode
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.Types.ThroughputMode.ThroughputMode
instance GHC.Generics.Generic Amazonka.KeySpaces.Types.ThroughputMode.ThroughputMode
instance GHC.Classes.Ord Amazonka.KeySpaces.Types.ThroughputMode.ThroughputMode
instance GHC.Classes.Eq Amazonka.KeySpaces.Types.ThroughputMode.ThroughputMode
instance GHC.Read.Read Amazonka.KeySpaces.Types.ThroughputMode.ThroughputMode
instance GHC.Show.Show Amazonka.KeySpaces.Types.ThroughputMode.ThroughputMode
module Amazonka.KeySpaces.Types.CapacitySpecificationSummary
-- | The read/write throughput capacity mode for a table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
--
-- See: newCapacitySpecificationSummary smart constructor.
data CapacitySpecificationSummary
CapacitySpecificationSummary' :: Maybe POSIX -> Maybe Natural -> Maybe Natural -> ThroughputMode -> CapacitySpecificationSummary
-- | The timestamp of the last operation that changed the provisioned
-- throughput capacity of a table.
[$sel:lastUpdateToPayPerRequestTimestamp:CapacitySpecificationSummary'] :: CapacitySpecificationSummary -> Maybe POSIX
-- | The throughput capacity specified for read operations defined
-- in read capacity units (RCUs).
[$sel:readCapacityUnits:CapacitySpecificationSummary'] :: CapacitySpecificationSummary -> Maybe Natural
-- | The throughput capacity specified for write operations
-- defined in write capacity units (WCUs).
[$sel:writeCapacityUnits:CapacitySpecificationSummary'] :: CapacitySpecificationSummary -> Maybe Natural
-- | The read/write throughput capacity mode for a table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
[$sel:throughputMode:CapacitySpecificationSummary'] :: CapacitySpecificationSummary -> ThroughputMode
-- | Create a value of CapacitySpecificationSummary 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:lastUpdateToPayPerRequestTimestamp:CapacitySpecificationSummary',
-- capacitySpecificationSummary_lastUpdateToPayPerRequestTimestamp
-- - The timestamp of the last operation that changed the provisioned
-- throughput capacity of a table.
--
-- $sel:readCapacityUnits:CapacitySpecificationSummary',
-- capacitySpecificationSummary_readCapacityUnits - The throughput
-- capacity specified for read operations defined in read
-- capacity units (RCUs).
--
-- $sel:writeCapacityUnits:CapacitySpecificationSummary',
-- capacitySpecificationSummary_writeCapacityUnits - The
-- throughput capacity specified for write operations defined in
-- write capacity units (WCUs).
--
-- $sel:throughputMode:CapacitySpecificationSummary',
-- capacitySpecificationSummary_throughputMode - The read/write
-- throughput capacity mode for a table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
newCapacitySpecificationSummary :: ThroughputMode -> CapacitySpecificationSummary
-- | The timestamp of the last operation that changed the provisioned
-- throughput capacity of a table.
capacitySpecificationSummary_lastUpdateToPayPerRequestTimestamp :: Lens' CapacitySpecificationSummary (Maybe UTCTime)
-- | The throughput capacity specified for read operations defined
-- in read capacity units (RCUs).
capacitySpecificationSummary_readCapacityUnits :: Lens' CapacitySpecificationSummary (Maybe Natural)
-- | The throughput capacity specified for write operations
-- defined in write capacity units (WCUs).
capacitySpecificationSummary_writeCapacityUnits :: Lens' CapacitySpecificationSummary (Maybe Natural)
-- | The read/write throughput capacity mode for a table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
capacitySpecificationSummary_throughputMode :: Lens' CapacitySpecificationSummary ThroughputMode
instance GHC.Generics.Generic Amazonka.KeySpaces.Types.CapacitySpecificationSummary.CapacitySpecificationSummary
instance GHC.Show.Show Amazonka.KeySpaces.Types.CapacitySpecificationSummary.CapacitySpecificationSummary
instance GHC.Read.Read Amazonka.KeySpaces.Types.CapacitySpecificationSummary.CapacitySpecificationSummary
instance GHC.Classes.Eq Amazonka.KeySpaces.Types.CapacitySpecificationSummary.CapacitySpecificationSummary
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.KeySpaces.Types.CapacitySpecificationSummary.CapacitySpecificationSummary
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.Types.CapacitySpecificationSummary.CapacitySpecificationSummary
instance Control.DeepSeq.NFData Amazonka.KeySpaces.Types.CapacitySpecificationSummary.CapacitySpecificationSummary
module Amazonka.KeySpaces.Types.CapacitySpecification
-- | Amazon Keyspaces has two read/write capacity modes for processing
-- reads and writes on your tables:
--
-- • On-demand (default)
--
-- • Provisioned
--
-- The read/write capacity mode that you choose controls how you are
-- charged for read and write throughput and how table throughput
-- capacity is managed.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
--
-- See: newCapacitySpecification smart constructor.
data CapacitySpecification
CapacitySpecification' :: Maybe Natural -> Maybe Natural -> ThroughputMode -> CapacitySpecification
-- | The throughput capacity specified for read operations defined
-- in read capacity units (RCUs).
[$sel:readCapacityUnits:CapacitySpecification'] :: CapacitySpecification -> Maybe Natural
-- | The throughput capacity specified for write operations
-- defined in write capacity units (WCUs).
[$sel:writeCapacityUnits:CapacitySpecification'] :: CapacitySpecification -> Maybe Natural
-- | The read/write throughput capacity mode for a table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
[$sel:throughputMode:CapacitySpecification'] :: CapacitySpecification -> ThroughputMode
-- | Create a value of CapacitySpecification 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:readCapacityUnits:CapacitySpecification',
-- capacitySpecification_readCapacityUnits - The throughput
-- capacity specified for read operations defined in read
-- capacity units (RCUs).
--
-- $sel:writeCapacityUnits:CapacitySpecification',
-- capacitySpecification_writeCapacityUnits - The throughput
-- capacity specified for write operations defined in write
-- capacity units (WCUs).
--
-- $sel:throughputMode:CapacitySpecification',
-- capacitySpecification_throughputMode - The read/write
-- throughput capacity mode for a table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
newCapacitySpecification :: ThroughputMode -> CapacitySpecification
-- | The throughput capacity specified for read operations defined
-- in read capacity units (RCUs).
capacitySpecification_readCapacityUnits :: Lens' CapacitySpecification (Maybe Natural)
-- | The throughput capacity specified for write operations
-- defined in write capacity units (WCUs).
capacitySpecification_writeCapacityUnits :: Lens' CapacitySpecification (Maybe Natural)
-- | The read/write throughput capacity mode for a table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
capacitySpecification_throughputMode :: Lens' CapacitySpecification ThroughputMode
instance GHC.Generics.Generic Amazonka.KeySpaces.Types.CapacitySpecification.CapacitySpecification
instance GHC.Show.Show Amazonka.KeySpaces.Types.CapacitySpecification.CapacitySpecification
instance GHC.Read.Read Amazonka.KeySpaces.Types.CapacitySpecification.CapacitySpecification
instance GHC.Classes.Eq Amazonka.KeySpaces.Types.CapacitySpecification.CapacitySpecification
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.Types.CapacitySpecification.CapacitySpecification
instance Control.DeepSeq.NFData Amazonka.KeySpaces.Types.CapacitySpecification.CapacitySpecification
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.Types.CapacitySpecification.CapacitySpecification
module Amazonka.KeySpaces.Types.TimeToLiveStatus
newtype TimeToLiveStatus
TimeToLiveStatus' :: Text -> TimeToLiveStatus
[fromTimeToLiveStatus] :: TimeToLiveStatus -> Text
pattern TimeToLiveStatus_ENABLED :: TimeToLiveStatus
instance Amazonka.Data.XML.ToXML Amazonka.KeySpaces.Types.TimeToLiveStatus.TimeToLiveStatus
instance Amazonka.Data.XML.FromXML Amazonka.KeySpaces.Types.TimeToLiveStatus.TimeToLiveStatus
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.KeySpaces.Types.TimeToLiveStatus.TimeToLiveStatus
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.Types.TimeToLiveStatus.TimeToLiveStatus
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.KeySpaces.Types.TimeToLiveStatus.TimeToLiveStatus
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.KeySpaces.Types.TimeToLiveStatus.TimeToLiveStatus
instance Amazonka.Data.Query.ToQuery Amazonka.KeySpaces.Types.TimeToLiveStatus.TimeToLiveStatus
instance Amazonka.Data.Headers.ToHeader Amazonka.KeySpaces.Types.TimeToLiveStatus.TimeToLiveStatus
instance Amazonka.Data.Log.ToLog Amazonka.KeySpaces.Types.TimeToLiveStatus.TimeToLiveStatus
instance Amazonka.Data.ByteString.ToByteString Amazonka.KeySpaces.Types.TimeToLiveStatus.TimeToLiveStatus
instance Amazonka.Data.Text.ToText Amazonka.KeySpaces.Types.TimeToLiveStatus.TimeToLiveStatus
instance Amazonka.Data.Text.FromText Amazonka.KeySpaces.Types.TimeToLiveStatus.TimeToLiveStatus
instance Control.DeepSeq.NFData Amazonka.KeySpaces.Types.TimeToLiveStatus.TimeToLiveStatus
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.Types.TimeToLiveStatus.TimeToLiveStatus
instance GHC.Generics.Generic Amazonka.KeySpaces.Types.TimeToLiveStatus.TimeToLiveStatus
instance GHC.Classes.Ord Amazonka.KeySpaces.Types.TimeToLiveStatus.TimeToLiveStatus
instance GHC.Classes.Eq Amazonka.KeySpaces.Types.TimeToLiveStatus.TimeToLiveStatus
instance GHC.Read.Read Amazonka.KeySpaces.Types.TimeToLiveStatus.TimeToLiveStatus
instance GHC.Show.Show Amazonka.KeySpaces.Types.TimeToLiveStatus.TimeToLiveStatus
module Amazonka.KeySpaces.Types.TimeToLive
-- | Enable custom Time to Live (TTL) settings for rows and columns without
-- setting a TTL default for the specified table.
--
-- For more information, see Enabling TTL on tables in the
-- Amazon Keyspaces Developer Guide.
--
-- See: newTimeToLive smart constructor.
data TimeToLive
TimeToLive' :: TimeToLiveStatus -> TimeToLive
-- | Shows how to enable custom Time to Live (TTL) settings for the
-- specified table.
[$sel:status:TimeToLive'] :: TimeToLive -> TimeToLiveStatus
-- | Create a value of TimeToLive 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:status:TimeToLive', timeToLive_status - Shows how
-- to enable custom Time to Live (TTL) settings for the specified table.
newTimeToLive :: TimeToLiveStatus -> TimeToLive
-- | Shows how to enable custom Time to Live (TTL) settings for the
-- specified table.
timeToLive_status :: Lens' TimeToLive TimeToLiveStatus
instance GHC.Generics.Generic Amazonka.KeySpaces.Types.TimeToLive.TimeToLive
instance GHC.Show.Show Amazonka.KeySpaces.Types.TimeToLive.TimeToLive
instance GHC.Read.Read Amazonka.KeySpaces.Types.TimeToLive.TimeToLive
instance GHC.Classes.Eq Amazonka.KeySpaces.Types.TimeToLive.TimeToLive
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.KeySpaces.Types.TimeToLive.TimeToLive
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.Types.TimeToLive.TimeToLive
instance Control.DeepSeq.NFData Amazonka.KeySpaces.Types.TimeToLive.TimeToLive
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.Types.TimeToLive.TimeToLive
module Amazonka.KeySpaces.Types
-- | API version 2022-02-10 of the Amazon Keyspaces SDK
-- configuration.
defaultService :: Service
-- | You do not have sufficient access to perform this action.
_AccessDeniedException :: AsError a => Fold a ServiceError
-- | Amazon Keyspaces could not complete the requested action. This error
-- may occur if you try to perform an action and the same or a different
-- action is already in progress, or if you try to create a resource that
-- already exists.
_ConflictException :: AsError a => Fold a ServiceError
-- | Amazon Keyspaces was unable to fully process this request because of
-- an internal server error.
_InternalServerException :: AsError a => Fold a ServiceError
-- | The operation tried to access a keyspace or table that doesn't exist.
-- The resource might not be specified correctly, or its status might not
-- be ACTIVE.
_ResourceNotFoundException :: AsError a => Fold a ServiceError
-- | The operation exceeded the service quota for this resource. For more
-- information on service quotas, see Quotas in the Amazon
-- Keyspaces Developer Guide.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError
-- | The operation failed due to an invalid or malformed request.
_ValidationException :: AsError a => Fold a ServiceError
newtype EncryptionType
EncryptionType' :: Text -> EncryptionType
[fromEncryptionType] :: EncryptionType -> Text
pattern EncryptionType_AWS_OWNED_KMS_KEY :: EncryptionType
pattern EncryptionType_CUSTOMER_MANAGED_KMS_KEY :: EncryptionType
newtype PointInTimeRecoveryStatus
PointInTimeRecoveryStatus' :: Text -> PointInTimeRecoveryStatus
[fromPointInTimeRecoveryStatus] :: PointInTimeRecoveryStatus -> Text
pattern PointInTimeRecoveryStatus_DISABLED :: PointInTimeRecoveryStatus
pattern PointInTimeRecoveryStatus_ENABLED :: PointInTimeRecoveryStatus
newtype SortOrder
SortOrder' :: Text -> SortOrder
[fromSortOrder] :: SortOrder -> Text
pattern SortOrder_ASC :: SortOrder
pattern SortOrder_DESC :: SortOrder
newtype TableStatus
TableStatus' :: Text -> TableStatus
[fromTableStatus] :: TableStatus -> Text
pattern TableStatus_ACTIVE :: TableStatus
pattern TableStatus_CREATING :: TableStatus
pattern TableStatus_DELETED :: TableStatus
pattern TableStatus_DELETING :: TableStatus
pattern TableStatus_INACCESSIBLE_ENCRYPTION_CREDENTIALS :: TableStatus
pattern TableStatus_RESTORING :: TableStatus
pattern TableStatus_UPDATING :: TableStatus
newtype ThroughputMode
ThroughputMode' :: Text -> ThroughputMode
[fromThroughputMode] :: ThroughputMode -> Text
pattern ThroughputMode_PAY_PER_REQUEST :: ThroughputMode
pattern ThroughputMode_PROVISIONED :: ThroughputMode
newtype TimeToLiveStatus
TimeToLiveStatus' :: Text -> TimeToLiveStatus
[fromTimeToLiveStatus] :: TimeToLiveStatus -> Text
pattern TimeToLiveStatus_ENABLED :: TimeToLiveStatus
-- | Amazon Keyspaces has two read/write capacity modes for processing
-- reads and writes on your tables:
--
-- • On-demand (default)
--
-- • Provisioned
--
-- The read/write capacity mode that you choose controls how you are
-- charged for read and write throughput and how table throughput
-- capacity is managed.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
--
-- See: newCapacitySpecification smart constructor.
data CapacitySpecification
CapacitySpecification' :: Maybe Natural -> Maybe Natural -> ThroughputMode -> CapacitySpecification
-- | The throughput capacity specified for read operations defined
-- in read capacity units (RCUs).
[$sel:readCapacityUnits:CapacitySpecification'] :: CapacitySpecification -> Maybe Natural
-- | The throughput capacity specified for write operations
-- defined in write capacity units (WCUs).
[$sel:writeCapacityUnits:CapacitySpecification'] :: CapacitySpecification -> Maybe Natural
-- | The read/write throughput capacity mode for a table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
[$sel:throughputMode:CapacitySpecification'] :: CapacitySpecification -> ThroughputMode
-- | Create a value of CapacitySpecification 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:readCapacityUnits:CapacitySpecification',
-- capacitySpecification_readCapacityUnits - The throughput
-- capacity specified for read operations defined in read
-- capacity units (RCUs).
--
-- $sel:writeCapacityUnits:CapacitySpecification',
-- capacitySpecification_writeCapacityUnits - The throughput
-- capacity specified for write operations defined in write
-- capacity units (WCUs).
--
-- $sel:throughputMode:CapacitySpecification',
-- capacitySpecification_throughputMode - The read/write
-- throughput capacity mode for a table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
newCapacitySpecification :: ThroughputMode -> CapacitySpecification
-- | The throughput capacity specified for read operations defined
-- in read capacity units (RCUs).
capacitySpecification_readCapacityUnits :: Lens' CapacitySpecification (Maybe Natural)
-- | The throughput capacity specified for write operations
-- defined in write capacity units (WCUs).
capacitySpecification_writeCapacityUnits :: Lens' CapacitySpecification (Maybe Natural)
-- | The read/write throughput capacity mode for a table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
capacitySpecification_throughputMode :: Lens' CapacitySpecification ThroughputMode
-- | The read/write throughput capacity mode for a table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
--
-- See: newCapacitySpecificationSummary smart constructor.
data CapacitySpecificationSummary
CapacitySpecificationSummary' :: Maybe POSIX -> Maybe Natural -> Maybe Natural -> ThroughputMode -> CapacitySpecificationSummary
-- | The timestamp of the last operation that changed the provisioned
-- throughput capacity of a table.
[$sel:lastUpdateToPayPerRequestTimestamp:CapacitySpecificationSummary'] :: CapacitySpecificationSummary -> Maybe POSIX
-- | The throughput capacity specified for read operations defined
-- in read capacity units (RCUs).
[$sel:readCapacityUnits:CapacitySpecificationSummary'] :: CapacitySpecificationSummary -> Maybe Natural
-- | The throughput capacity specified for write operations
-- defined in write capacity units (WCUs).
[$sel:writeCapacityUnits:CapacitySpecificationSummary'] :: CapacitySpecificationSummary -> Maybe Natural
-- | The read/write throughput capacity mode for a table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
[$sel:throughputMode:CapacitySpecificationSummary'] :: CapacitySpecificationSummary -> ThroughputMode
-- | Create a value of CapacitySpecificationSummary 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:lastUpdateToPayPerRequestTimestamp:CapacitySpecificationSummary',
-- capacitySpecificationSummary_lastUpdateToPayPerRequestTimestamp
-- - The timestamp of the last operation that changed the provisioned
-- throughput capacity of a table.
--
-- $sel:readCapacityUnits:CapacitySpecificationSummary',
-- capacitySpecificationSummary_readCapacityUnits - The throughput
-- capacity specified for read operations defined in read
-- capacity units (RCUs).
--
-- $sel:writeCapacityUnits:CapacitySpecificationSummary',
-- capacitySpecificationSummary_writeCapacityUnits - The
-- throughput capacity specified for write operations defined in
-- write capacity units (WCUs).
--
-- $sel:throughputMode:CapacitySpecificationSummary',
-- capacitySpecificationSummary_throughputMode - The read/write
-- throughput capacity mode for a table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
newCapacitySpecificationSummary :: ThroughputMode -> CapacitySpecificationSummary
-- | The timestamp of the last operation that changed the provisioned
-- throughput capacity of a table.
capacitySpecificationSummary_lastUpdateToPayPerRequestTimestamp :: Lens' CapacitySpecificationSummary (Maybe UTCTime)
-- | The throughput capacity specified for read operations defined
-- in read capacity units (RCUs).
capacitySpecificationSummary_readCapacityUnits :: Lens' CapacitySpecificationSummary (Maybe Natural)
-- | The throughput capacity specified for write operations
-- defined in write capacity units (WCUs).
capacitySpecificationSummary_writeCapacityUnits :: Lens' CapacitySpecificationSummary (Maybe Natural)
-- | The read/write throughput capacity mode for a table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
capacitySpecificationSummary_throughputMode :: Lens' CapacitySpecificationSummary ThroughputMode
-- | The optional clustering column portion of your primary key determines
-- how the data is clustered and sorted within each partition.
--
-- See: newClusteringKey smart constructor.
data ClusteringKey
ClusteringKey' :: Text -> SortOrder -> ClusteringKey
-- | The name(s) of the clustering column(s).
[$sel:name:ClusteringKey'] :: ClusteringKey -> Text
-- | Sets the ascendant (ASC) or descendant (DESC) order
-- modifier.
[$sel:orderBy:ClusteringKey'] :: ClusteringKey -> SortOrder
-- | Create a value of ClusteringKey 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:name:ClusteringKey', clusteringKey_name - The
-- name(s) of the clustering column(s).
--
-- $sel:orderBy:ClusteringKey', clusteringKey_orderBy -
-- Sets the ascendant (ASC) or descendant (DESC) order
-- modifier.
newClusteringKey :: Text -> SortOrder -> ClusteringKey
-- | The name(s) of the clustering column(s).
clusteringKey_name :: Lens' ClusteringKey Text
-- | Sets the ascendant (ASC) or descendant (DESC) order
-- modifier.
clusteringKey_orderBy :: Lens' ClusteringKey SortOrder
-- | The names and data types of regular columns.
--
-- See: newColumnDefinition smart constructor.
data ColumnDefinition
ColumnDefinition' :: Text -> Text -> ColumnDefinition
-- | The name of the column.
[$sel:name:ColumnDefinition'] :: ColumnDefinition -> Text
-- | The data type of the column. For a list of available data types, see
-- Data types in the Amazon Keyspaces Developer Guide.
[$sel:type':ColumnDefinition'] :: ColumnDefinition -> Text
-- | Create a value of ColumnDefinition 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:name:ColumnDefinition', columnDefinition_name - The
-- name of the column.
--
-- $sel:type':ColumnDefinition', columnDefinition_type -
-- The data type of the column. For a list of available data types, see
-- Data types in the Amazon Keyspaces Developer Guide.
newColumnDefinition :: Text -> Text -> ColumnDefinition
-- | The name of the column.
columnDefinition_name :: Lens' ColumnDefinition Text
-- | The data type of the column. For a list of available data types, see
-- Data types in the Amazon Keyspaces Developer Guide.
columnDefinition_type :: Lens' ColumnDefinition Text
-- | An optional comment that describes the table.
--
-- See: newComment smart constructor.
data Comment
Comment' :: Text -> Comment
-- | An optional description of the table.
[$sel:message:Comment'] :: Comment -> Text
-- | Create a value of Comment 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:message:Comment', comment_message - An optional
-- description of the table.
newComment :: Text -> Comment
-- | An optional description of the table.
comment_message :: Lens' Comment Text
-- | Amazon Keyspaces encrypts and decrypts the table data at rest
-- transparently and integrates with Key Management Service for storing
-- and managing the encryption key. You can choose one of the following
-- KMS keys (KMS keys):
--
-- • Amazon Web Services owned key - This is the default encryption type.
-- The key is owned by Amazon Keyspaces (no additional charge).
--
-- • Customer managed key - This key is stored in your account and is
-- created, owned, and managed by you. You have full control over the
-- customer managed key (KMS charges apply).
--
-- For more information about encryption at rest in Amazon Keyspaces, see
-- Encryption at rest in the Amazon Keyspaces Developer
-- Guide.
--
-- For more information about KMS, see KMS management service
-- concepts in the Key Management Service Developer Guide.
--
-- See: newEncryptionSpecification smart constructor.
data EncryptionSpecification
EncryptionSpecification' :: Maybe Text -> EncryptionType -> EncryptionSpecification
-- | The Amazon Resource Name (ARN) of the customer managed KMS key, for
-- example kms_key_identifier:ARN.
[$sel:kmsKeyIdentifier:EncryptionSpecification'] :: EncryptionSpecification -> Maybe Text
-- | The encryption option specified for the table. You can choose one of
-- the following KMS keys (KMS keys):
--
-- • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon
-- Keyspaces.
--
-- • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your
-- account and is created, owned, and managed by you. This option
-- requires the kms_key_identifier of the KMS key in Amazon
-- Resource Name (ARN) format as input.
--
-- The default is type:AWS_OWNED_KMS_KEY.
--
-- For more information, see Encryption at rest in the Amazon
-- Keyspaces Developer Guide.
[$sel:type':EncryptionSpecification'] :: EncryptionSpecification -> EncryptionType
-- | Create a value of EncryptionSpecification 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:kmsKeyIdentifier:EncryptionSpecification',
-- encryptionSpecification_kmsKeyIdentifier - The Amazon Resource
-- Name (ARN) of the customer managed KMS key, for example
-- kms_key_identifier:ARN.
--
-- $sel:type':EncryptionSpecification',
-- encryptionSpecification_type - The encryption option specified
-- for the table. You can choose one of the following KMS keys (KMS
-- keys):
--
-- • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon
-- Keyspaces.
--
-- • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your
-- account and is created, owned, and managed by you. This option
-- requires the kms_key_identifier of the KMS key in Amazon
-- Resource Name (ARN) format as input.
--
-- The default is type:AWS_OWNED_KMS_KEY.
--
-- For more information, see Encryption at rest in the Amazon
-- Keyspaces Developer Guide.
newEncryptionSpecification :: EncryptionType -> EncryptionSpecification
-- | The Amazon Resource Name (ARN) of the customer managed KMS key, for
-- example kms_key_identifier:ARN.
encryptionSpecification_kmsKeyIdentifier :: Lens' EncryptionSpecification (Maybe Text)
-- | The encryption option specified for the table. You can choose one of
-- the following KMS keys (KMS keys):
--
-- • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon
-- Keyspaces.
--
-- • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your
-- account and is created, owned, and managed by you. This option
-- requires the kms_key_identifier of the KMS key in Amazon
-- Resource Name (ARN) format as input.
--
-- The default is type:AWS_OWNED_KMS_KEY.
--
-- For more information, see Encryption at rest in the Amazon
-- Keyspaces Developer Guide.
encryptionSpecification_type :: Lens' EncryptionSpecification EncryptionType
-- | Represents the properties of a keyspace.
--
-- See: newKeyspaceSummary smart constructor.
data KeyspaceSummary
KeyspaceSummary' :: Text -> Text -> KeyspaceSummary
-- | The name of the keyspace.
[$sel:keyspaceName:KeyspaceSummary'] :: KeyspaceSummary -> Text
-- | The unique identifier of the keyspace in the format of an Amazon
-- Resource Name (ARN).
[$sel:resourceArn:KeyspaceSummary'] :: KeyspaceSummary -> Text
-- | Create a value of KeyspaceSummary 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:keyspaceName:KeyspaceSummary',
-- keyspaceSummary_keyspaceName - The name of the keyspace.
--
-- $sel:resourceArn:KeyspaceSummary',
-- keyspaceSummary_resourceArn - The unique identifier of the
-- keyspace in the format of an Amazon Resource Name (ARN).
newKeyspaceSummary :: Text -> Text -> KeyspaceSummary
-- | The name of the keyspace.
keyspaceSummary_keyspaceName :: Lens' KeyspaceSummary Text
-- | The unique identifier of the keyspace in the format of an Amazon
-- Resource Name (ARN).
keyspaceSummary_resourceArn :: Lens' KeyspaceSummary Text
-- | The partition key portion of the primary key is required and
-- determines how Amazon Keyspaces stores the data. The partition key can
-- be a single column, or it can be a compound value composed of two or
-- more columns.
--
-- See: newPartitionKey smart constructor.
data PartitionKey
PartitionKey' :: Text -> PartitionKey
-- | The name(s) of the partition key column(s).
[$sel:name:PartitionKey'] :: PartitionKey -> Text
-- | Create a value of PartitionKey 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:name:PartitionKey', partitionKey_name - The name(s)
-- of the partition key column(s).
newPartitionKey :: Text -> PartitionKey
-- | The name(s) of the partition key column(s).
partitionKey_name :: Lens' PartitionKey Text
-- | Point-in-time recovery (PITR) helps protect your Amazon Keyspaces
-- tables from accidental write or delete operations by providing you
-- continuous backups of your table data.
--
-- For more information, see Point-in-time recovery in the
-- Amazon Keyspaces Developer Guide.
--
-- See: newPointInTimeRecovery smart constructor.
data PointInTimeRecovery
PointInTimeRecovery' :: PointInTimeRecoveryStatus -> PointInTimeRecovery
-- | The options are:
--
-- • ENABLED
--
-- • DISABLED
[$sel:status:PointInTimeRecovery'] :: PointInTimeRecovery -> PointInTimeRecoveryStatus
-- | Create a value of PointInTimeRecovery 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:status:PointInTimeRecovery',
-- pointInTimeRecovery_status - The options are:
--
-- • ENABLED
--
-- • DISABLED
newPointInTimeRecovery :: PointInTimeRecoveryStatus -> PointInTimeRecovery
-- | The options are:
--
-- • ENABLED
--
-- • DISABLED
pointInTimeRecovery_status :: Lens' PointInTimeRecovery PointInTimeRecoveryStatus
-- | The point-in-time recovery status of the specified table.
--
-- See: newPointInTimeRecoverySummary smart constructor.
data PointInTimeRecoverySummary
PointInTimeRecoverySummary' :: Maybe POSIX -> PointInTimeRecoveryStatus -> PointInTimeRecoverySummary
-- | Specifies the earliest possible restore point of the table in ISO 8601
-- format.
[$sel:earliestRestorableTimestamp:PointInTimeRecoverySummary'] :: PointInTimeRecoverySummary -> Maybe POSIX
-- | Shows if point-in-time recovery is enabled or disabled for the
-- specified table.
[$sel:status:PointInTimeRecoverySummary'] :: PointInTimeRecoverySummary -> PointInTimeRecoveryStatus
-- | Create a value of PointInTimeRecoverySummary 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:earliestRestorableTimestamp:PointInTimeRecoverySummary',
-- pointInTimeRecoverySummary_earliestRestorableTimestamp -
-- Specifies the earliest possible restore point of the table in ISO 8601
-- format.
--
-- $sel:status:PointInTimeRecoverySummary',
-- pointInTimeRecoverySummary_status - Shows if point-in-time
-- recovery is enabled or disabled for the specified table.
newPointInTimeRecoverySummary :: PointInTimeRecoveryStatus -> PointInTimeRecoverySummary
-- | Specifies the earliest possible restore point of the table in ISO 8601
-- format.
pointInTimeRecoverySummary_earliestRestorableTimestamp :: Lens' PointInTimeRecoverySummary (Maybe UTCTime)
-- | Shows if point-in-time recovery is enabled or disabled for the
-- specified table.
pointInTimeRecoverySummary_status :: Lens' PointInTimeRecoverySummary PointInTimeRecoveryStatus
-- | Describes the schema of the table.
--
-- See: newSchemaDefinition smart constructor.
data SchemaDefinition
SchemaDefinition' :: Maybe [ClusteringKey] -> Maybe [StaticColumn] -> NonEmpty ColumnDefinition -> NonEmpty PartitionKey -> SchemaDefinition
-- | The columns that are part of the clustering key of the table.
[$sel:clusteringKeys:SchemaDefinition'] :: SchemaDefinition -> Maybe [ClusteringKey]
-- | The columns that have been defined as STATIC. Static columns
-- store values that are shared by all rows in the same partition.
[$sel:staticColumns:SchemaDefinition'] :: SchemaDefinition -> Maybe [StaticColumn]
-- | The regular columns of the table.
[$sel:allColumns:SchemaDefinition'] :: SchemaDefinition -> NonEmpty ColumnDefinition
-- | The columns that are part of the partition key of the table .
[$sel:partitionKeys:SchemaDefinition'] :: SchemaDefinition -> NonEmpty PartitionKey
-- | Create a value of SchemaDefinition 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:clusteringKeys:SchemaDefinition',
-- schemaDefinition_clusteringKeys - The columns that are part of
-- the clustering key of the table.
--
-- $sel:staticColumns:SchemaDefinition',
-- schemaDefinition_staticColumns - The columns that have been
-- defined as STATIC. Static columns store values that are
-- shared by all rows in the same partition.
--
-- $sel:allColumns:SchemaDefinition',
-- schemaDefinition_allColumns - The regular columns of the table.
--
-- $sel:partitionKeys:SchemaDefinition',
-- schemaDefinition_partitionKeys - The columns that are part of
-- the partition key of the table .
newSchemaDefinition :: NonEmpty ColumnDefinition -> NonEmpty PartitionKey -> SchemaDefinition
-- | The columns that are part of the clustering key of the table.
schemaDefinition_clusteringKeys :: Lens' SchemaDefinition (Maybe [ClusteringKey])
-- | The columns that have been defined as STATIC. Static columns
-- store values that are shared by all rows in the same partition.
schemaDefinition_staticColumns :: Lens' SchemaDefinition (Maybe [StaticColumn])
-- | The regular columns of the table.
schemaDefinition_allColumns :: Lens' SchemaDefinition (NonEmpty ColumnDefinition)
-- | The columns that are part of the partition key of the table .
schemaDefinition_partitionKeys :: Lens' SchemaDefinition (NonEmpty PartitionKey)
-- | The static columns of the table. Static columns store values that are
-- shared by all rows in the same partition.
--
-- See: newStaticColumn smart constructor.
data StaticColumn
StaticColumn' :: Text -> StaticColumn
-- | The name of the static column.
[$sel:name:StaticColumn'] :: StaticColumn -> Text
-- | Create a value of StaticColumn 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:name:StaticColumn', staticColumn_name - The name of
-- the static column.
newStaticColumn :: Text -> StaticColumn
-- | The name of the static column.
staticColumn_name :: Lens' StaticColumn Text
-- | Returns the name of the specified table, the keyspace it is stored in,
-- and the unique identifier in the format of an Amazon Resource Name
-- (ARN).
--
-- See: newTableSummary smart constructor.
data TableSummary
TableSummary' :: Text -> Text -> Text -> TableSummary
-- | The name of the keyspace that the table is stored in.
[$sel:keyspaceName:TableSummary'] :: TableSummary -> Text
-- | The name of the table.
[$sel:tableName:TableSummary'] :: TableSummary -> Text
-- | The unique identifier of the table in the format of an Amazon Resource
-- Name (ARN).
[$sel:resourceArn:TableSummary'] :: TableSummary -> Text
-- | Create a value of TableSummary 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:keyspaceName:TableSummary',
-- tableSummary_keyspaceName - The name of the keyspace that the
-- table is stored in.
--
-- $sel:tableName:TableSummary', tableSummary_tableName -
-- The name of the table.
--
-- $sel:resourceArn:TableSummary', tableSummary_resourceArn
-- - The unique identifier of the table in the format of an Amazon
-- Resource Name (ARN).
newTableSummary :: Text -> Text -> Text -> TableSummary
-- | The name of the keyspace that the table is stored in.
tableSummary_keyspaceName :: Lens' TableSummary Text
-- | The name of the table.
tableSummary_tableName :: Lens' TableSummary Text
-- | The unique identifier of the table in the format of an Amazon Resource
-- Name (ARN).
tableSummary_resourceArn :: Lens' TableSummary Text
-- | Describes a tag. A tag is a key-value pair. You can add up to 50 tags
-- to a single Amazon Keyspaces resource.
--
-- Amazon Web Services-assigned tag names and values are automatically
-- assigned the aws: prefix, which the user cannot assign.
-- Amazon Web Services-assigned tag names do not count towards the tag
-- limit of 50. User-assigned tag names have the prefix user: in
-- the Cost Allocation Report. You cannot backdate the application of a
-- tag.
--
-- For more information, see Adding tags and labels to Amazon
-- Keyspaces resources in the Amazon Keyspaces Developer
-- Guide.
--
-- See: newTag smart constructor.
data Tag
Tag' :: Text -> Text -> Tag
-- | The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces
-- resource can only have up to one tag with the same key. If you try to
-- add an existing tag (same key), the existing tag value will be updated
-- to the new value.
[$sel:key:Tag'] :: Tag -> Text
-- | The value of the tag. Tag values are case-sensitive and can be null.
[$sel:value:Tag'] :: Tag -> Text
-- | Create a value of Tag 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:key:Tag', tag_key - The key of the tag. Tag keys
-- are case sensitive. Each Amazon Keyspaces resource can only have up to
-- one tag with the same key. If you try to add an existing tag (same
-- key), the existing tag value will be updated to the new value.
--
-- $sel:value:Tag', tag_value - The value of the tag. Tag
-- values are case-sensitive and can be null.
newTag :: Text -> Text -> Tag
-- | The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces
-- resource can only have up to one tag with the same key. If you try to
-- add an existing tag (same key), the existing tag value will be updated
-- to the new value.
tag_key :: Lens' Tag Text
-- | The value of the tag. Tag values are case-sensitive and can be null.
tag_value :: Lens' Tag Text
-- | Enable custom Time to Live (TTL) settings for rows and columns without
-- setting a TTL default for the specified table.
--
-- For more information, see Enabling TTL on tables in the
-- Amazon Keyspaces Developer Guide.
--
-- See: newTimeToLive smart constructor.
data TimeToLive
TimeToLive' :: TimeToLiveStatus -> TimeToLive
-- | Shows how to enable custom Time to Live (TTL) settings for the
-- specified table.
[$sel:status:TimeToLive'] :: TimeToLive -> TimeToLiveStatus
-- | Create a value of TimeToLive 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:status:TimeToLive', timeToLive_status - Shows how
-- to enable custom Time to Live (TTL) settings for the specified table.
newTimeToLive :: TimeToLiveStatus -> TimeToLive
-- | Shows how to enable custom Time to Live (TTL) settings for the
-- specified table.
timeToLive_status :: Lens' TimeToLive TimeToLiveStatus
-- | Associates a set of tags with a Amazon Keyspaces resource. You can
-- then activate these user-defined tags so that they appear on the Cost
-- Management Console for cost allocation tracking. For more information,
-- see Adding tags and labels to Amazon Keyspaces resources in the
-- Amazon Keyspaces Developer Guide.
--
-- For IAM policy examples that show how to control access to Amazon
-- Keyspaces resources based on tags, see Amazon Keyspaces resource
-- access based on tags in the Amazon Keyspaces Developer
-- Guide.
module Amazonka.KeySpaces.TagResource
-- | See: newTagResource smart constructor.
data TagResource
TagResource' :: Text -> NonEmpty Tag -> TagResource
-- | The Amazon Resource Name (ARN) of the Amazon Keyspaces resource to
-- which to add tags.
[$sel:resourceArn:TagResource'] :: TagResource -> Text
-- | The tags to be assigned to the Amazon Keyspaces resource.
[$sel:tags:TagResource'] :: TagResource -> NonEmpty Tag
-- | Create a value of TagResource 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:
--
-- TagResource, tagResource_resourceArn - The Amazon
-- Resource Name (ARN) of the Amazon Keyspaces resource to which to add
-- tags.
--
-- $sel:tags:TagResource', tagResource_tags - The tags to
-- be assigned to the Amazon Keyspaces resource.
newTagResource :: Text -> NonEmpty Tag -> TagResource
-- | The Amazon Resource Name (ARN) of the Amazon Keyspaces resource to
-- which to add tags.
tagResource_resourceArn :: Lens' TagResource Text
-- | The tags to be assigned to the Amazon Keyspaces resource.
tagResource_tags :: Lens' TagResource (NonEmpty Tag)
-- | See: newTagResourceResponse smart constructor.
data TagResourceResponse
TagResourceResponse' :: Int -> TagResourceResponse
-- | The response's http status code.
[$sel:httpStatus:TagResourceResponse'] :: TagResourceResponse -> Int
-- | Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse',
-- tagResourceResponse_httpStatus - The response's http status
-- code.
newTagResourceResponse :: Int -> TagResourceResponse
-- | The response's http status code.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
instance GHC.Generics.Generic Amazonka.KeySpaces.TagResource.TagResource
instance GHC.Show.Show Amazonka.KeySpaces.TagResource.TagResource
instance GHC.Read.Read Amazonka.KeySpaces.TagResource.TagResource
instance GHC.Classes.Eq Amazonka.KeySpaces.TagResource.TagResource
instance GHC.Generics.Generic Amazonka.KeySpaces.TagResource.TagResourceResponse
instance GHC.Show.Show Amazonka.KeySpaces.TagResource.TagResourceResponse
instance GHC.Read.Read Amazonka.KeySpaces.TagResource.TagResourceResponse
instance GHC.Classes.Eq Amazonka.KeySpaces.TagResource.TagResourceResponse
instance Amazonka.Types.AWSRequest Amazonka.KeySpaces.TagResource.TagResource
instance Control.DeepSeq.NFData Amazonka.KeySpaces.TagResource.TagResourceResponse
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.TagResource.TagResource
instance Control.DeepSeq.NFData Amazonka.KeySpaces.TagResource.TagResource
instance Amazonka.Data.Headers.ToHeaders Amazonka.KeySpaces.TagResource.TagResource
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.TagResource.TagResource
instance Amazonka.Data.Path.ToPath Amazonka.KeySpaces.TagResource.TagResource
instance Amazonka.Data.Query.ToQuery Amazonka.KeySpaces.TagResource.TagResource
-- | Restores the specified table to the specified point in time within the
-- earliest_restorable_timestamp and the current time. For more
-- information about restore points, see Time window for PITR
-- continuous backups in the Amazon Keyspaces Developer Guide.
--
-- Any number of users can execute up to 4 concurrent restores (any type
-- of restore) in a given account.
--
-- When you restore using point in time recovery, Amazon Keyspaces
-- restores your source table's schema and data to the state based on the
-- selected timestamp (day:hour:minute:second) to a new table.
-- The Time to Live (TTL) settings are also restored to the state based
-- on the selected timestamp.
--
-- In addition to the table's schema, data, and TTL settings,
-- RestoreTable restores the capacity mode, encryption, and
-- point-in-time recovery settings from the source table. Unlike the
-- table's schema data and TTL settings, which are restored based on the
-- selected timestamp, these settings are always restored based on the
-- table's settings as of the current time or when the table was deleted.
--
-- You can also overwrite these settings during restore:
--
-- • Read/write capacity mode
--
-- • Provisioned throughput capacity settings
--
-- • Point-in-time (PITR) settings
--
-- • Tags
--
-- For more information, see PITR restore settings in the
-- Amazon Keyspaces Developer Guide.
--
-- Note that the following settings are not restored, and you must
-- configure them manually for the new table:
--
-- • Automatic scaling policies (for tables that use provisioned capacity
-- mode)
--
-- • Identity and Access Management (IAM) policies
--
-- • Amazon CloudWatch metrics and alarms
module Amazonka.KeySpaces.RestoreTable
-- | See: newRestoreTable smart constructor.
data RestoreTable
RestoreTable' :: Maybe CapacitySpecification -> Maybe EncryptionSpecification -> Maybe PointInTimeRecovery -> Maybe POSIX -> Maybe (NonEmpty Tag) -> Text -> Text -> Text -> Text -> RestoreTable
-- | Specifies the read/write throughput capacity mode for the target
-- table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
[$sel:capacitySpecificationOverride:RestoreTable'] :: RestoreTable -> Maybe CapacitySpecification
-- | Specifies the encryption settings for the target table. You can choose
-- one of the following KMS key (KMS key):
--
-- • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon
-- Keyspaces.
--
-- • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your
-- account and is created, owned, and managed by you. This option
-- requires the kms_key_identifier of the KMS key in Amazon
-- Resource Name (ARN) format as input.
--
-- The default is type:AWS_OWNED_KMS_KEY.
--
-- For more information, see Encryption at rest in the Amazon
-- Keyspaces Developer Guide.
[$sel:encryptionSpecificationOverride:RestoreTable'] :: RestoreTable -> Maybe EncryptionSpecification
-- | Specifies the pointInTimeRecovery settings for the target
-- table. The options are:
--
-- • ENABLED
--
-- • DISABLED
--
-- If it's not specified, the default is DISABLED.
--
-- For more information, see Point-in-time recovery in the
-- Amazon Keyspaces Developer Guide.
[$sel:pointInTimeRecoveryOverride:RestoreTable'] :: RestoreTable -> Maybe PointInTimeRecovery
-- | The restore timestamp in ISO 8601 format.
[$sel:restoreTimestamp:RestoreTable'] :: RestoreTable -> Maybe POSIX
-- | A list of key-value pair tags to be attached to the restored table.
--
-- For more information, see Adding tags and labels to Amazon
-- Keyspaces resources in the Amazon Keyspaces Developer
-- Guide.
[$sel:tagsOverride:RestoreTable'] :: RestoreTable -> Maybe (NonEmpty Tag)
-- | The keyspace name of the source table.
[$sel:sourceKeyspaceName:RestoreTable'] :: RestoreTable -> Text
-- | The name of the source table.
[$sel:sourceTableName:RestoreTable'] :: RestoreTable -> Text
-- | The name of the target keyspace.
[$sel:targetKeyspaceName:RestoreTable'] :: RestoreTable -> Text
-- | The name of the target table.
[$sel:targetTableName:RestoreTable'] :: RestoreTable -> Text
-- | Create a value of RestoreTable 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:capacitySpecificationOverride:RestoreTable',
-- restoreTable_capacitySpecificationOverride - Specifies the
-- read/write throughput capacity mode for the target table. The options
-- are:
--
-- • throughputMode:PAY_PER_REQUEST
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
--
-- $sel:encryptionSpecificationOverride:RestoreTable',
-- restoreTable_encryptionSpecificationOverride - Specifies the
-- encryption settings for the target table. You can choose one of the
-- following KMS key (KMS key):
--
-- • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon
-- Keyspaces.
--
-- • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your
-- account and is created, owned, and managed by you. This option
-- requires the kms_key_identifier of the KMS key in Amazon
-- Resource Name (ARN) format as input.
--
-- The default is type:AWS_OWNED_KMS_KEY.
--
-- For more information, see Encryption at rest in the Amazon
-- Keyspaces Developer Guide.
--
-- $sel:pointInTimeRecoveryOverride:RestoreTable',
-- restoreTable_pointInTimeRecoveryOverride - Specifies the
-- pointInTimeRecovery settings for the target table. The
-- options are:
--
-- • ENABLED
--
-- • DISABLED
--
-- If it's not specified, the default is DISABLED.
--
-- For more information, see Point-in-time recovery in the
-- Amazon Keyspaces Developer Guide.
--
-- $sel:restoreTimestamp:RestoreTable',
-- restoreTable_restoreTimestamp - The restore timestamp in ISO
-- 8601 format.
--
-- $sel:tagsOverride:RestoreTable',
-- restoreTable_tagsOverride - A list of key-value pair tags to be
-- attached to the restored table.
--
-- For more information, see Adding tags and labels to Amazon
-- Keyspaces resources in the Amazon Keyspaces Developer
-- Guide.
--
-- $sel:sourceKeyspaceName:RestoreTable',
-- restoreTable_sourceKeyspaceName - The keyspace name of the
-- source table.
--
-- $sel:sourceTableName:RestoreTable',
-- restoreTable_sourceTableName - The name of the source table.
--
-- $sel:targetKeyspaceName:RestoreTable',
-- restoreTable_targetKeyspaceName - The name of the target
-- keyspace.
--
-- $sel:targetTableName:RestoreTable',
-- restoreTable_targetTableName - The name of the target table.
newRestoreTable :: Text -> Text -> Text -> Text -> RestoreTable
-- | Specifies the read/write throughput capacity mode for the target
-- table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
restoreTable_capacitySpecificationOverride :: Lens' RestoreTable (Maybe CapacitySpecification)
-- | Specifies the encryption settings for the target table. You can choose
-- one of the following KMS key (KMS key):
--
-- • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon
-- Keyspaces.
--
-- • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your
-- account and is created, owned, and managed by you. This option
-- requires the kms_key_identifier of the KMS key in Amazon
-- Resource Name (ARN) format as input.
--
-- The default is type:AWS_OWNED_KMS_KEY.
--
-- For more information, see Encryption at rest in the Amazon
-- Keyspaces Developer Guide.
restoreTable_encryptionSpecificationOverride :: Lens' RestoreTable (Maybe EncryptionSpecification)
-- | Specifies the pointInTimeRecovery settings for the target
-- table. The options are:
--
-- • ENABLED
--
-- • DISABLED
--
-- If it's not specified, the default is DISABLED.
--
-- For more information, see Point-in-time recovery in the
-- Amazon Keyspaces Developer Guide.
restoreTable_pointInTimeRecoveryOverride :: Lens' RestoreTable (Maybe PointInTimeRecovery)
-- | The restore timestamp in ISO 8601 format.
restoreTable_restoreTimestamp :: Lens' RestoreTable (Maybe UTCTime)
-- | A list of key-value pair tags to be attached to the restored table.
--
-- For more information, see Adding tags and labels to Amazon
-- Keyspaces resources in the Amazon Keyspaces Developer
-- Guide.
restoreTable_tagsOverride :: Lens' RestoreTable (Maybe (NonEmpty Tag))
-- | The keyspace name of the source table.
restoreTable_sourceKeyspaceName :: Lens' RestoreTable Text
-- | The name of the source table.
restoreTable_sourceTableName :: Lens' RestoreTable Text
-- | The name of the target keyspace.
restoreTable_targetKeyspaceName :: Lens' RestoreTable Text
-- | The name of the target table.
restoreTable_targetTableName :: Lens' RestoreTable Text
-- | See: newRestoreTableResponse smart constructor.
data RestoreTableResponse
RestoreTableResponse' :: Int -> Text -> RestoreTableResponse
-- | The response's http status code.
[$sel:httpStatus:RestoreTableResponse'] :: RestoreTableResponse -> Int
-- | The Amazon Resource Name (ARN) of the restored table.
[$sel:restoredTableARN:RestoreTableResponse'] :: RestoreTableResponse -> Text
-- | Create a value of RestoreTableResponse 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:httpStatus:RestoreTableResponse',
-- restoreTableResponse_httpStatus - The response's http status
-- code.
--
-- $sel:restoredTableARN:RestoreTableResponse',
-- restoreTableResponse_restoredTableARN - The Amazon Resource
-- Name (ARN) of the restored table.
newRestoreTableResponse :: Int -> Text -> RestoreTableResponse
-- | The response's http status code.
restoreTableResponse_httpStatus :: Lens' RestoreTableResponse Int
-- | The Amazon Resource Name (ARN) of the restored table.
restoreTableResponse_restoredTableARN :: Lens' RestoreTableResponse Text
instance GHC.Generics.Generic Amazonka.KeySpaces.RestoreTable.RestoreTable
instance GHC.Show.Show Amazonka.KeySpaces.RestoreTable.RestoreTable
instance GHC.Read.Read Amazonka.KeySpaces.RestoreTable.RestoreTable
instance GHC.Classes.Eq Amazonka.KeySpaces.RestoreTable.RestoreTable
instance GHC.Generics.Generic Amazonka.KeySpaces.RestoreTable.RestoreTableResponse
instance GHC.Show.Show Amazonka.KeySpaces.RestoreTable.RestoreTableResponse
instance GHC.Read.Read Amazonka.KeySpaces.RestoreTable.RestoreTableResponse
instance GHC.Classes.Eq Amazonka.KeySpaces.RestoreTable.RestoreTableResponse
instance Amazonka.Types.AWSRequest Amazonka.KeySpaces.RestoreTable.RestoreTable
instance Control.DeepSeq.NFData Amazonka.KeySpaces.RestoreTable.RestoreTableResponse
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.RestoreTable.RestoreTable
instance Control.DeepSeq.NFData Amazonka.KeySpaces.RestoreTable.RestoreTable
instance Amazonka.Data.Headers.ToHeaders Amazonka.KeySpaces.RestoreTable.RestoreTable
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.RestoreTable.RestoreTable
instance Amazonka.Data.Path.ToPath Amazonka.KeySpaces.RestoreTable.RestoreTable
instance Amazonka.Data.Query.ToQuery Amazonka.KeySpaces.RestoreTable.RestoreTable
-- | Returns a list of all tags associated with the specified Amazon
-- Keyspaces resource.
--
-- This operation returns paginated results.
module Amazonka.KeySpaces.ListTagsForResource
-- | See: newListTagsForResource smart constructor.
data ListTagsForResource
ListTagsForResource' :: Maybe Natural -> Maybe Text -> Text -> ListTagsForResource
-- | The total number of tags to return in the output. If the total number
-- of tags available is more than the value specified, a
-- NextToken is provided in the output. To resume pagination,
-- provide the NextToken value as an argument of a subsequent
-- API invocation.
[$sel:maxResults:ListTagsForResource'] :: ListTagsForResource -> Maybe Natural
-- | The pagination token. To resume pagination, provide the
-- NextToken value as argument of a subsequent API invocation.
[$sel:nextToken:ListTagsForResource'] :: ListTagsForResource -> Maybe Text
-- | The Amazon Resource Name (ARN) of the Amazon Keyspaces resource.
[$sel:resourceArn:ListTagsForResource'] :: ListTagsForResource -> Text
-- | Create a value of ListTagsForResource 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:maxResults:ListTagsForResource',
-- listTagsForResource_maxResults - The total number of tags to
-- return in the output. If the total number of tags available is more
-- than the value specified, a NextToken is provided in the
-- output. To resume pagination, provide the NextToken value as
-- an argument of a subsequent API invocation.
--
-- ListTagsForResource, listTagsForResource_nextToken - The
-- pagination token. To resume pagination, provide the NextToken
-- value as argument of a subsequent API invocation.
--
-- ListTagsForResource, listTagsForResource_resourceArn -
-- The Amazon Resource Name (ARN) of the Amazon Keyspaces resource.
newListTagsForResource :: Text -> ListTagsForResource
-- | The total number of tags to return in the output. If the total number
-- of tags available is more than the value specified, a
-- NextToken is provided in the output. To resume pagination,
-- provide the NextToken value as an argument of a subsequent
-- API invocation.
listTagsForResource_maxResults :: Lens' ListTagsForResource (Maybe Natural)
-- | The pagination token. To resume pagination, provide the
-- NextToken value as argument of a subsequent API invocation.
listTagsForResource_nextToken :: Lens' ListTagsForResource (Maybe Text)
-- | The Amazon Resource Name (ARN) of the Amazon Keyspaces resource.
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
-- | See: newListTagsForResourceResponse smart constructor.
data ListTagsForResourceResponse
ListTagsForResourceResponse' :: Maybe Text -> Maybe (NonEmpty Tag) -> Int -> ListTagsForResourceResponse
-- | A token to specify where to start paginating. This is the
-- NextToken from a previously truncated response.
[$sel:nextToken:ListTagsForResourceResponse'] :: ListTagsForResourceResponse -> Maybe Text
-- | A list of tags.
[$sel:tags:ListTagsForResourceResponse'] :: ListTagsForResourceResponse -> Maybe (NonEmpty Tag)
-- | The response's http status code.
[$sel:httpStatus:ListTagsForResourceResponse'] :: ListTagsForResourceResponse -> Int
-- | Create a value of ListTagsForResourceResponse 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:
--
-- ListTagsForResource,
-- listTagsForResourceResponse_nextToken - A token to specify
-- where to start paginating. This is the NextToken from a
-- previously truncated response.
--
-- $sel:tags:ListTagsForResourceResponse',
-- listTagsForResourceResponse_tags - A list of tags.
--
-- $sel:httpStatus:ListTagsForResourceResponse',
-- listTagsForResourceResponse_httpStatus - The response's http
-- status code.
newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
-- | A token to specify where to start paginating. This is the
-- NextToken from a previously truncated response.
listTagsForResourceResponse_nextToken :: Lens' ListTagsForResourceResponse (Maybe Text)
-- | A list of tags.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (NonEmpty Tag))
-- | The response's http status code.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
instance GHC.Generics.Generic Amazonka.KeySpaces.ListTagsForResource.ListTagsForResource
instance GHC.Show.Show Amazonka.KeySpaces.ListTagsForResource.ListTagsForResource
instance GHC.Read.Read Amazonka.KeySpaces.ListTagsForResource.ListTagsForResource
instance GHC.Classes.Eq Amazonka.KeySpaces.ListTagsForResource.ListTagsForResource
instance GHC.Generics.Generic Amazonka.KeySpaces.ListTagsForResource.ListTagsForResourceResponse
instance GHC.Show.Show Amazonka.KeySpaces.ListTagsForResource.ListTagsForResourceResponse
instance GHC.Read.Read Amazonka.KeySpaces.ListTagsForResource.ListTagsForResourceResponse
instance GHC.Classes.Eq Amazonka.KeySpaces.ListTagsForResource.ListTagsForResourceResponse
instance Amazonka.Types.AWSRequest Amazonka.KeySpaces.ListTagsForResource.ListTagsForResource
instance Control.DeepSeq.NFData Amazonka.KeySpaces.ListTagsForResource.ListTagsForResourceResponse
instance Amazonka.Pager.AWSPager Amazonka.KeySpaces.ListTagsForResource.ListTagsForResource
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.ListTagsForResource.ListTagsForResource
instance Control.DeepSeq.NFData Amazonka.KeySpaces.ListTagsForResource.ListTagsForResource
instance Amazonka.Data.Headers.ToHeaders Amazonka.KeySpaces.ListTagsForResource.ListTagsForResource
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.ListTagsForResource.ListTagsForResource
instance Amazonka.Data.Path.ToPath Amazonka.KeySpaces.ListTagsForResource.ListTagsForResource
instance Amazonka.Data.Query.ToQuery Amazonka.KeySpaces.ListTagsForResource.ListTagsForResource
-- | Returns a list of tables for a specified keyspace.
--
-- This operation returns paginated results.
module Amazonka.KeySpaces.ListTables
-- | See: newListTables smart constructor.
data ListTables
ListTables' :: Maybe Natural -> Maybe Text -> Text -> ListTables
-- | The total number of tables to return in the output. If the total
-- number of tables available is more than the value specified, a
-- NextToken is provided in the output. To resume pagination,
-- provide the NextToken value as an argument of a subsequent
-- API invocation.
[$sel:maxResults:ListTables'] :: ListTables -> Maybe Natural
-- | The pagination token. To resume pagination, provide the
-- NextToken value as an argument of a subsequent API
-- invocation.
[$sel:nextToken:ListTables'] :: ListTables -> Maybe Text
-- | The name of the keyspace.
[$sel:keyspaceName:ListTables'] :: ListTables -> Text
-- | Create a value of ListTables 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:maxResults:ListTables', listTables_maxResults - The
-- total number of tables to return in the output. If the total number of
-- tables available is more than the value specified, a
-- NextToken is provided in the output. To resume pagination,
-- provide the NextToken value as an argument of a subsequent
-- API invocation.
--
-- ListTables, listTables_nextToken - The pagination token.
-- To resume pagination, provide the NextToken value as an
-- argument of a subsequent API invocation.
--
-- ListTables, listTables_keyspaceName - The name of the
-- keyspace.
newListTables :: Text -> ListTables
-- | The total number of tables to return in the output. If the total
-- number of tables available is more than the value specified, a
-- NextToken is provided in the output. To resume pagination,
-- provide the NextToken value as an argument of a subsequent
-- API invocation.
listTables_maxResults :: Lens' ListTables (Maybe Natural)
-- | The pagination token. To resume pagination, provide the
-- NextToken value as an argument of a subsequent API
-- invocation.
listTables_nextToken :: Lens' ListTables (Maybe Text)
-- | The name of the keyspace.
listTables_keyspaceName :: Lens' ListTables Text
-- | See: newListTablesResponse smart constructor.
data ListTablesResponse
ListTablesResponse' :: Maybe Text -> Maybe [TableSummary] -> Int -> ListTablesResponse
-- | A token to specify where to start paginating. This is the
-- NextToken from a previously truncated response.
[$sel:nextToken:ListTablesResponse'] :: ListTablesResponse -> Maybe Text
-- | A list of tables.
[$sel:tables:ListTablesResponse'] :: ListTablesResponse -> Maybe [TableSummary]
-- | The response's http status code.
[$sel:httpStatus:ListTablesResponse'] :: ListTablesResponse -> Int
-- | Create a value of ListTablesResponse 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:
--
-- ListTables, listTablesResponse_nextToken - A token to
-- specify where to start paginating. This is the NextToken from
-- a previously truncated response.
--
-- $sel:tables:ListTablesResponse',
-- listTablesResponse_tables - A list of tables.
--
-- $sel:httpStatus:ListTablesResponse',
-- listTablesResponse_httpStatus - The response's http status
-- code.
newListTablesResponse :: Int -> ListTablesResponse
-- | A token to specify where to start paginating. This is the
-- NextToken from a previously truncated response.
listTablesResponse_nextToken :: Lens' ListTablesResponse (Maybe Text)
-- | A list of tables.
listTablesResponse_tables :: Lens' ListTablesResponse (Maybe [TableSummary])
-- | The response's http status code.
listTablesResponse_httpStatus :: Lens' ListTablesResponse Int
instance GHC.Generics.Generic Amazonka.KeySpaces.ListTables.ListTables
instance GHC.Show.Show Amazonka.KeySpaces.ListTables.ListTables
instance GHC.Read.Read Amazonka.KeySpaces.ListTables.ListTables
instance GHC.Classes.Eq Amazonka.KeySpaces.ListTables.ListTables
instance GHC.Generics.Generic Amazonka.KeySpaces.ListTables.ListTablesResponse
instance GHC.Show.Show Amazonka.KeySpaces.ListTables.ListTablesResponse
instance GHC.Read.Read Amazonka.KeySpaces.ListTables.ListTablesResponse
instance GHC.Classes.Eq Amazonka.KeySpaces.ListTables.ListTablesResponse
instance Amazonka.Types.AWSRequest Amazonka.KeySpaces.ListTables.ListTables
instance Control.DeepSeq.NFData Amazonka.KeySpaces.ListTables.ListTablesResponse
instance Amazonka.Pager.AWSPager Amazonka.KeySpaces.ListTables.ListTables
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.ListTables.ListTables
instance Control.DeepSeq.NFData Amazonka.KeySpaces.ListTables.ListTables
instance Amazonka.Data.Headers.ToHeaders Amazonka.KeySpaces.ListTables.ListTables
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.ListTables.ListTables
instance Amazonka.Data.Path.ToPath Amazonka.KeySpaces.ListTables.ListTables
instance Amazonka.Data.Query.ToQuery Amazonka.KeySpaces.ListTables.ListTables
-- | Returns a list of keyspaces.
--
-- This operation returns paginated results.
module Amazonka.KeySpaces.ListKeyspaces
-- | See: newListKeyspaces smart constructor.
data ListKeyspaces
ListKeyspaces' :: Maybe Natural -> Maybe Text -> ListKeyspaces
-- | The total number of keyspaces to return in the output. If the total
-- number of keyspaces available is more than the value specified, a
-- NextToken is provided in the output. To resume pagination,
-- provide the NextToken value as an argument of a subsequent
-- API invocation.
[$sel:maxResults:ListKeyspaces'] :: ListKeyspaces -> Maybe Natural
-- | The pagination token. To resume pagination, provide the
-- NextToken value as argument of a subsequent API invocation.
[$sel:nextToken:ListKeyspaces'] :: ListKeyspaces -> Maybe Text
-- | Create a value of ListKeyspaces 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:maxResults:ListKeyspaces', listKeyspaces_maxResults
-- - The total number of keyspaces to return in the output. If the total
-- number of keyspaces available is more than the value specified, a
-- NextToken is provided in the output. To resume pagination,
-- provide the NextToken value as an argument of a subsequent
-- API invocation.
--
-- ListKeyspaces, listKeyspaces_nextToken - The pagination
-- token. To resume pagination, provide the NextToken value as
-- argument of a subsequent API invocation.
newListKeyspaces :: ListKeyspaces
-- | The total number of keyspaces to return in the output. If the total
-- number of keyspaces available is more than the value specified, a
-- NextToken is provided in the output. To resume pagination,
-- provide the NextToken value as an argument of a subsequent
-- API invocation.
listKeyspaces_maxResults :: Lens' ListKeyspaces (Maybe Natural)
-- | The pagination token. To resume pagination, provide the
-- NextToken value as argument of a subsequent API invocation.
listKeyspaces_nextToken :: Lens' ListKeyspaces (Maybe Text)
-- | See: newListKeyspacesResponse smart constructor.
data ListKeyspacesResponse
ListKeyspacesResponse' :: Maybe Text -> Int -> [KeyspaceSummary] -> ListKeyspacesResponse
-- | A token to specify where to start paginating. This is the
-- NextToken from a previously truncated response.
[$sel:nextToken:ListKeyspacesResponse'] :: ListKeyspacesResponse -> Maybe Text
-- | The response's http status code.
[$sel:httpStatus:ListKeyspacesResponse'] :: ListKeyspacesResponse -> Int
-- | A list of keyspaces.
[$sel:keyspaces:ListKeyspacesResponse'] :: ListKeyspacesResponse -> [KeyspaceSummary]
-- | Create a value of ListKeyspacesResponse 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:
--
-- ListKeyspaces, listKeyspacesResponse_nextToken - A token
-- to specify where to start paginating. This is the NextToken
-- from a previously truncated response.
--
-- $sel:httpStatus:ListKeyspacesResponse',
-- listKeyspacesResponse_httpStatus - The response's http status
-- code.
--
-- $sel:keyspaces:ListKeyspacesResponse',
-- listKeyspacesResponse_keyspaces - A list of keyspaces.
newListKeyspacesResponse :: Int -> ListKeyspacesResponse
-- | A token to specify where to start paginating. This is the
-- NextToken from a previously truncated response.
listKeyspacesResponse_nextToken :: Lens' ListKeyspacesResponse (Maybe Text)
-- | The response's http status code.
listKeyspacesResponse_httpStatus :: Lens' ListKeyspacesResponse Int
-- | A list of keyspaces.
listKeyspacesResponse_keyspaces :: Lens' ListKeyspacesResponse [KeyspaceSummary]
instance GHC.Generics.Generic Amazonka.KeySpaces.ListKeyspaces.ListKeyspaces
instance GHC.Show.Show Amazonka.KeySpaces.ListKeyspaces.ListKeyspaces
instance GHC.Read.Read Amazonka.KeySpaces.ListKeyspaces.ListKeyspaces
instance GHC.Classes.Eq Amazonka.KeySpaces.ListKeyspaces.ListKeyspaces
instance GHC.Generics.Generic Amazonka.KeySpaces.ListKeyspaces.ListKeyspacesResponse
instance GHC.Show.Show Amazonka.KeySpaces.ListKeyspaces.ListKeyspacesResponse
instance GHC.Read.Read Amazonka.KeySpaces.ListKeyspaces.ListKeyspacesResponse
instance GHC.Classes.Eq Amazonka.KeySpaces.ListKeyspaces.ListKeyspacesResponse
instance Amazonka.Types.AWSRequest Amazonka.KeySpaces.ListKeyspaces.ListKeyspaces
instance Control.DeepSeq.NFData Amazonka.KeySpaces.ListKeyspaces.ListKeyspacesResponse
instance Amazonka.Pager.AWSPager Amazonka.KeySpaces.ListKeyspaces.ListKeyspaces
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.ListKeyspaces.ListKeyspaces
instance Control.DeepSeq.NFData Amazonka.KeySpaces.ListKeyspaces.ListKeyspaces
instance Amazonka.Data.Headers.ToHeaders Amazonka.KeySpaces.ListKeyspaces.ListKeyspaces
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.ListKeyspaces.ListKeyspaces
instance Amazonka.Data.Path.ToPath Amazonka.KeySpaces.ListKeyspaces.ListKeyspaces
instance Amazonka.Data.Query.ToQuery Amazonka.KeySpaces.ListKeyspaces.ListKeyspaces
-- | 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.
module Amazonka.KeySpaces.GetTable
-- | See: newGetTable smart constructor.
data GetTable
GetTable' :: Text -> Text -> GetTable
-- | The name of the keyspace that the table is stored in.
[$sel:keyspaceName:GetTable'] :: GetTable -> Text
-- | The name of the table.
[$sel:tableName:GetTable'] :: GetTable -> Text
-- | 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.
newGetTable :: Text -> Text -> GetTable
-- | The name of the keyspace that the table is stored in.
getTable_keyspaceName :: Lens' GetTable Text
-- | The name of the table.
getTable_tableName :: Lens' GetTable Text
-- | See: newGetTableResponse smart constructor.
data GetTableResponse
GetTableResponse' :: Maybe CapacitySpecificationSummary -> Maybe Comment -> Maybe POSIX -> Maybe Natural -> Maybe EncryptionSpecification -> Maybe PointInTimeRecoverySummary -> Maybe SchemaDefinition -> Maybe TableStatus -> Maybe TimeToLive -> Int -> Text -> Text -> Text -> GetTableResponse
-- | The read/write throughput capacity mode for a table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST
--
-- • throughputMode:PROVISIONED
[$sel:capacitySpecification:GetTableResponse'] :: GetTableResponse -> Maybe CapacitySpecificationSummary
-- | The the description of the specified table.
[$sel:comment:GetTableResponse'] :: GetTableResponse -> Maybe Comment
-- | The creation timestamp of the specified table.
[$sel:creationTimestamp:GetTableResponse'] :: GetTableResponse -> Maybe POSIX
-- | The default Time to Live settings of the specified table.
[$sel:defaultTimeToLive:GetTableResponse'] :: GetTableResponse -> Maybe Natural
-- | The encryption settings of the specified table.
[$sel:encryptionSpecification:GetTableResponse'] :: GetTableResponse -> Maybe EncryptionSpecification
-- | The point-in-time recovery status of the specified table.
[$sel:pointInTimeRecovery:GetTableResponse'] :: GetTableResponse -> Maybe PointInTimeRecoverySummary
-- | The schema definition of the specified table.
[$sel:schemaDefinition:GetTableResponse'] :: GetTableResponse -> Maybe SchemaDefinition
-- | The current status of the specified table.
[$sel:status:GetTableResponse'] :: GetTableResponse -> Maybe TableStatus
-- | The custom Time to Live settings of the specified table.
[$sel:ttl:GetTableResponse'] :: GetTableResponse -> Maybe TimeToLive
-- | The response's http status code.
[$sel:httpStatus:GetTableResponse'] :: GetTableResponse -> Int
-- | The name of the keyspace that the specified table is stored in.
[$sel:keyspaceName:GetTableResponse'] :: GetTableResponse -> Text
-- | The name of the specified table.
[$sel:tableName:GetTableResponse'] :: GetTableResponse -> Text
-- | The Amazon Resource Name (ARN) of the specified table.
[$sel:resourceArn:GetTableResponse'] :: GetTableResponse -> Text
-- | 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.
newGetTableResponse :: Int -> Text -> Text -> Text -> GetTableResponse
-- | The read/write throughput capacity mode for a table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST
--
-- • throughputMode:PROVISIONED
getTableResponse_capacitySpecification :: Lens' GetTableResponse (Maybe CapacitySpecificationSummary)
-- | The the description of the specified table.
getTableResponse_comment :: Lens' GetTableResponse (Maybe Comment)
-- | The creation timestamp of the specified table.
getTableResponse_creationTimestamp :: Lens' GetTableResponse (Maybe UTCTime)
-- | The default Time to Live settings of the specified table.
getTableResponse_defaultTimeToLive :: Lens' GetTableResponse (Maybe Natural)
-- | The encryption settings of the specified table.
getTableResponse_encryptionSpecification :: Lens' GetTableResponse (Maybe EncryptionSpecification)
-- | The point-in-time recovery status of the specified table.
getTableResponse_pointInTimeRecovery :: Lens' GetTableResponse (Maybe PointInTimeRecoverySummary)
-- | The schema definition of the specified table.
getTableResponse_schemaDefinition :: Lens' GetTableResponse (Maybe SchemaDefinition)
-- | The current status of the specified table.
getTableResponse_status :: Lens' GetTableResponse (Maybe TableStatus)
-- | The custom Time to Live settings of the specified table.
getTableResponse_ttl :: Lens' GetTableResponse (Maybe TimeToLive)
-- | The response's http status code.
getTableResponse_httpStatus :: Lens' GetTableResponse Int
-- | The name of the keyspace that the specified table is stored in.
getTableResponse_keyspaceName :: Lens' GetTableResponse Text
-- | The name of the specified table.
getTableResponse_tableName :: Lens' GetTableResponse Text
-- | The Amazon Resource Name (ARN) of the specified table.
getTableResponse_resourceArn :: Lens' GetTableResponse Text
instance GHC.Generics.Generic Amazonka.KeySpaces.GetTable.GetTable
instance GHC.Show.Show Amazonka.KeySpaces.GetTable.GetTable
instance GHC.Read.Read Amazonka.KeySpaces.GetTable.GetTable
instance GHC.Classes.Eq Amazonka.KeySpaces.GetTable.GetTable
instance GHC.Generics.Generic Amazonka.KeySpaces.GetTable.GetTableResponse
instance GHC.Show.Show Amazonka.KeySpaces.GetTable.GetTableResponse
instance GHC.Read.Read Amazonka.KeySpaces.GetTable.GetTableResponse
instance GHC.Classes.Eq Amazonka.KeySpaces.GetTable.GetTableResponse
instance Amazonka.Types.AWSRequest Amazonka.KeySpaces.GetTable.GetTable
instance Control.DeepSeq.NFData Amazonka.KeySpaces.GetTable.GetTableResponse
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.GetTable.GetTable
instance Control.DeepSeq.NFData Amazonka.KeySpaces.GetTable.GetTable
instance Amazonka.Data.Headers.ToHeaders Amazonka.KeySpaces.GetTable.GetTable
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.GetTable.GetTable
instance Amazonka.Data.Path.ToPath Amazonka.KeySpaces.GetTable.GetTable
instance Amazonka.Data.Query.ToQuery Amazonka.KeySpaces.GetTable.GetTable
-- | Returns the name and the Amazon Resource Name (ARN) of the specified
-- table.
module Amazonka.KeySpaces.GetKeyspace
-- | See: newGetKeyspace smart constructor.
data GetKeyspace
GetKeyspace' :: Text -> GetKeyspace
-- | The name of the keyspace.
[$sel:keyspaceName:GetKeyspace'] :: GetKeyspace -> Text
-- | Create a value of GetKeyspace 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:
--
-- GetKeyspace, getKeyspace_keyspaceName - The name of the
-- keyspace.
newGetKeyspace :: Text -> GetKeyspace
-- | The name of the keyspace.
getKeyspace_keyspaceName :: Lens' GetKeyspace Text
-- | See: newGetKeyspaceResponse smart constructor.
data GetKeyspaceResponse
GetKeyspaceResponse' :: Int -> Text -> Text -> GetKeyspaceResponse
-- | The response's http status code.
[$sel:httpStatus:GetKeyspaceResponse'] :: GetKeyspaceResponse -> Int
-- | The name of the keyspace.
[$sel:keyspaceName:GetKeyspaceResponse'] :: GetKeyspaceResponse -> Text
-- | The ARN of the keyspace.
[$sel:resourceArn:GetKeyspaceResponse'] :: GetKeyspaceResponse -> Text
-- | Create a value of GetKeyspaceResponse 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:httpStatus:GetKeyspaceResponse',
-- getKeyspaceResponse_httpStatus - The response's http status
-- code.
--
-- GetKeyspace, getKeyspaceResponse_keyspaceName - The name
-- of the keyspace.
--
-- GetKeyspaceResponse, getKeyspaceResponse_resourceArn -
-- The ARN of the keyspace.
newGetKeyspaceResponse :: Int -> Text -> Text -> GetKeyspaceResponse
-- | The response's http status code.
getKeyspaceResponse_httpStatus :: Lens' GetKeyspaceResponse Int
-- | The name of the keyspace.
getKeyspaceResponse_keyspaceName :: Lens' GetKeyspaceResponse Text
-- | The ARN of the keyspace.
getKeyspaceResponse_resourceArn :: Lens' GetKeyspaceResponse Text
instance GHC.Generics.Generic Amazonka.KeySpaces.GetKeyspace.GetKeyspace
instance GHC.Show.Show Amazonka.KeySpaces.GetKeyspace.GetKeyspace
instance GHC.Read.Read Amazonka.KeySpaces.GetKeyspace.GetKeyspace
instance GHC.Classes.Eq Amazonka.KeySpaces.GetKeyspace.GetKeyspace
instance GHC.Generics.Generic Amazonka.KeySpaces.GetKeyspace.GetKeyspaceResponse
instance GHC.Show.Show Amazonka.KeySpaces.GetKeyspace.GetKeyspaceResponse
instance GHC.Read.Read Amazonka.KeySpaces.GetKeyspace.GetKeyspaceResponse
instance GHC.Classes.Eq Amazonka.KeySpaces.GetKeyspace.GetKeyspaceResponse
instance Amazonka.Types.AWSRequest Amazonka.KeySpaces.GetKeyspace.GetKeyspace
instance Control.DeepSeq.NFData Amazonka.KeySpaces.GetKeyspace.GetKeyspaceResponse
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.GetKeyspace.GetKeyspace
instance Control.DeepSeq.NFData Amazonka.KeySpaces.GetKeyspace.GetKeyspace
instance Amazonka.Data.Headers.ToHeaders Amazonka.KeySpaces.GetKeyspace.GetKeyspace
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.GetKeyspace.GetKeyspace
instance Amazonka.Data.Path.ToPath Amazonka.KeySpaces.GetKeyspace.GetKeyspace
instance Amazonka.Data.Query.ToQuery Amazonka.KeySpaces.GetKeyspace.GetKeyspace
-- | The DeleteTable operation deletes a table and all of its
-- data. After a DeleteTable request is received, the specified
-- table is in the DELETING state until Amazon Keyspaces
-- completes the deletion. If the table is in the ACTIVE state,
-- you can delete it. If a table is either in the CREATING or
-- UPDATING states, then Amazon Keyspaces returns a
-- ResourceInUseException. If the specified table does not
-- exist, Amazon Keyspaces returns a ResourceNotFoundException.
-- If the table is already in the DELETING state, no error is
-- returned.
module Amazonka.KeySpaces.DeleteTable
-- | See: newDeleteTable smart constructor.
data DeleteTable
DeleteTable' :: Text -> Text -> DeleteTable
-- | The name of the keyspace of the to be deleted table.
[$sel:keyspaceName:DeleteTable'] :: DeleteTable -> Text
-- | The name of the table to be deleted.
[$sel:tableName:DeleteTable'] :: DeleteTable -> Text
-- | 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_keyspaceName - The name of the
-- keyspace of the to be deleted table.
--
-- DeleteTable, deleteTable_tableName - The name of the
-- table to be deleted.
newDeleteTable :: Text -> Text -> DeleteTable
-- | The name of the keyspace of the to be deleted table.
deleteTable_keyspaceName :: Lens' DeleteTable Text
-- | The name of the table to be deleted.
deleteTable_tableName :: Lens' DeleteTable Text
-- | See: newDeleteTableResponse smart constructor.
data DeleteTableResponse
DeleteTableResponse' :: Int -> DeleteTableResponse
-- | The response's http status code.
[$sel:httpStatus:DeleteTableResponse'] :: DeleteTableResponse -> Int
-- | 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:httpStatus:DeleteTableResponse',
-- deleteTableResponse_httpStatus - The response's http status
-- code.
newDeleteTableResponse :: Int -> DeleteTableResponse
-- | The response's http status code.
deleteTableResponse_httpStatus :: Lens' DeleteTableResponse Int
instance GHC.Generics.Generic Amazonka.KeySpaces.DeleteTable.DeleteTable
instance GHC.Show.Show Amazonka.KeySpaces.DeleteTable.DeleteTable
instance GHC.Read.Read Amazonka.KeySpaces.DeleteTable.DeleteTable
instance GHC.Classes.Eq Amazonka.KeySpaces.DeleteTable.DeleteTable
instance GHC.Generics.Generic Amazonka.KeySpaces.DeleteTable.DeleteTableResponse
instance GHC.Show.Show Amazonka.KeySpaces.DeleteTable.DeleteTableResponse
instance GHC.Read.Read Amazonka.KeySpaces.DeleteTable.DeleteTableResponse
instance GHC.Classes.Eq Amazonka.KeySpaces.DeleteTable.DeleteTableResponse
instance Amazonka.Types.AWSRequest Amazonka.KeySpaces.DeleteTable.DeleteTable
instance Control.DeepSeq.NFData Amazonka.KeySpaces.DeleteTable.DeleteTableResponse
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.DeleteTable.DeleteTable
instance Control.DeepSeq.NFData Amazonka.KeySpaces.DeleteTable.DeleteTable
instance Amazonka.Data.Headers.ToHeaders Amazonka.KeySpaces.DeleteTable.DeleteTable
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.DeleteTable.DeleteTable
instance Amazonka.Data.Path.ToPath Amazonka.KeySpaces.DeleteTable.DeleteTable
instance Amazonka.Data.Query.ToQuery Amazonka.KeySpaces.DeleteTable.DeleteTable
-- | The DeleteKeyspace operation deletes a keyspace and all of
-- its tables.
module Amazonka.KeySpaces.DeleteKeyspace
-- | See: newDeleteKeyspace smart constructor.
data DeleteKeyspace
DeleteKeyspace' :: Text -> DeleteKeyspace
-- | The name of the keyspace to be deleted.
[$sel:keyspaceName:DeleteKeyspace'] :: DeleteKeyspace -> Text
-- | Create a value of DeleteKeyspace 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:
--
-- DeleteKeyspace, deleteKeyspace_keyspaceName - The name
-- of the keyspace to be deleted.
newDeleteKeyspace :: Text -> DeleteKeyspace
-- | The name of the keyspace to be deleted.
deleteKeyspace_keyspaceName :: Lens' DeleteKeyspace Text
-- | See: newDeleteKeyspaceResponse smart constructor.
data DeleteKeyspaceResponse
DeleteKeyspaceResponse' :: Int -> DeleteKeyspaceResponse
-- | The response's http status code.
[$sel:httpStatus:DeleteKeyspaceResponse'] :: DeleteKeyspaceResponse -> Int
-- | Create a value of DeleteKeyspaceResponse 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:httpStatus:DeleteKeyspaceResponse',
-- deleteKeyspaceResponse_httpStatus - The response's http status
-- code.
newDeleteKeyspaceResponse :: Int -> DeleteKeyspaceResponse
-- | The response's http status code.
deleteKeyspaceResponse_httpStatus :: Lens' DeleteKeyspaceResponse Int
instance GHC.Generics.Generic Amazonka.KeySpaces.DeleteKeyspace.DeleteKeyspace
instance GHC.Show.Show Amazonka.KeySpaces.DeleteKeyspace.DeleteKeyspace
instance GHC.Read.Read Amazonka.KeySpaces.DeleteKeyspace.DeleteKeyspace
instance GHC.Classes.Eq Amazonka.KeySpaces.DeleteKeyspace.DeleteKeyspace
instance GHC.Generics.Generic Amazonka.KeySpaces.DeleteKeyspace.DeleteKeyspaceResponse
instance GHC.Show.Show Amazonka.KeySpaces.DeleteKeyspace.DeleteKeyspaceResponse
instance GHC.Read.Read Amazonka.KeySpaces.DeleteKeyspace.DeleteKeyspaceResponse
instance GHC.Classes.Eq Amazonka.KeySpaces.DeleteKeyspace.DeleteKeyspaceResponse
instance Amazonka.Types.AWSRequest Amazonka.KeySpaces.DeleteKeyspace.DeleteKeyspace
instance Control.DeepSeq.NFData Amazonka.KeySpaces.DeleteKeyspace.DeleteKeyspaceResponse
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.DeleteKeyspace.DeleteKeyspace
instance Control.DeepSeq.NFData Amazonka.KeySpaces.DeleteKeyspace.DeleteKeyspace
instance Amazonka.Data.Headers.ToHeaders Amazonka.KeySpaces.DeleteKeyspace.DeleteKeyspace
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.DeleteKeyspace.DeleteKeyspace
instance Amazonka.Data.Path.ToPath Amazonka.KeySpaces.DeleteKeyspace.DeleteKeyspace
instance Amazonka.Data.Query.ToQuery Amazonka.KeySpaces.DeleteKeyspace.DeleteKeyspace
-- | The CreateTable operation adds a new table to the specified
-- keyspace. Within a keyspace, table names must be unique.
--
-- CreateTable is an asynchronous operation. When the request is
-- received, the status of the table is set to CREATING. You can
-- monitor the creation status of the new table by using the
-- GetTable operation, which returns the current status
-- of the table. You can start using a table when the status is
-- ACTIVE.
--
-- For more information, see Creating tables in the Amazon
-- Keyspaces Developer Guide.
module Amazonka.KeySpaces.CreateTable
-- | See: newCreateTable smart constructor.
data CreateTable
CreateTable' :: Maybe CapacitySpecification -> Maybe Comment -> Maybe Natural -> Maybe EncryptionSpecification -> Maybe PointInTimeRecovery -> Maybe (NonEmpty Tag) -> Maybe TimeToLive -> Text -> Text -> SchemaDefinition -> CreateTable
-- | Specifies the read/write throughput capacity mode for the table. The
-- options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
[$sel:capacitySpecification:CreateTable'] :: CreateTable -> Maybe CapacitySpecification
-- | This parameter allows to enter a description of the table.
[$sel:comment:CreateTable'] :: CreateTable -> Maybe Comment
-- | The default Time to Live setting in seconds for the table.
--
-- For more information, see Setting the default TTL value for a
-- table in the Amazon Keyspaces Developer Guide.
[$sel:defaultTimeToLive:CreateTable'] :: CreateTable -> Maybe Natural
-- | Specifies how the encryption key for encryption at rest is managed for
-- the table. You can choose one of the following KMS key (KMS key):
--
-- • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon
-- Keyspaces.
--
-- • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your
-- account and is created, owned, and managed by you. This option
-- requires the kms_key_identifier of the KMS key in Amazon
-- Resource Name (ARN) format as input.
--
-- The default is type:AWS_OWNED_KMS_KEY.
--
-- For more information, see Encryption at rest in the Amazon
-- Keyspaces Developer Guide.
[$sel:encryptionSpecification:CreateTable'] :: CreateTable -> Maybe EncryptionSpecification
-- | Specifies if pointInTimeRecovery is enabled or disabled for
-- the table. The options are:
--
-- • ENABLED
--
-- • DISABLED
--
-- If it's not specified, the default is DISABLED.
--
-- For more information, see Point-in-time recovery in the
-- Amazon Keyspaces Developer Guide.
[$sel:pointInTimeRecovery:CreateTable'] :: CreateTable -> Maybe PointInTimeRecovery
-- | A list of key-value pair tags to be attached to the resource.
--
-- For more information, see Adding tags and labels to Amazon
-- Keyspaces resources in the Amazon Keyspaces Developer
-- Guide.
[$sel:tags:CreateTable'] :: CreateTable -> Maybe (NonEmpty Tag)
-- | Enables Time to Live custom settings for the table. The options are:
--
-- • status:enabled
--
-- • status:disabled
--
-- The default is status:disabled. After ttl is
-- enabled, you can't disable it for the table.
--
-- For more information, see Expiring data by using Amazon Keyspaces
-- Time to Live (TTL) in the Amazon Keyspaces Developer Guide.
[$sel:ttl:CreateTable'] :: CreateTable -> Maybe TimeToLive
-- | The name of the keyspace that the table is going to be created in.
[$sel:keyspaceName:CreateTable'] :: CreateTable -> Text
-- | The name of the table.
[$sel:tableName:CreateTable'] :: CreateTable -> Text
-- | The schemaDefinition consists of the following parameters.
--
-- For each column to be created:
--
-- • name - The name of the column.
--
-- • type - An Amazon Keyspaces data type. For more information,
-- see Data types in the Amazon Keyspaces Developer Guide.
--
-- The primary key of the table consists of the following columns:
--
-- • partitionKeys - The partition key can be a single column,
-- or it can be a compound value composed of two or more columns. The
-- partition key portion of the primary key is required and determines
-- how Amazon Keyspaces stores your data.
--
-- • name - The name of each partition key column.
--
-- • clusteringKeys - The optional clustering column portion of
-- your primary key determines how the data is clustered and sorted
-- within each partition.
--
-- • name - The name of the clustering column.
--
-- • orderBy - Sets the ascendant (ASC) or descendant
-- (DESC) order modifier.
--
-- To define a column as static use staticColumns - Static
-- columns store values that are shared by all rows in the same
-- partition:
--
-- • name - The name of the column.
--
-- • type - An Amazon Keyspaces data type.
[$sel:schemaDefinition:CreateTable'] :: CreateTable -> SchemaDefinition
-- | 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:
--
-- $sel:capacitySpecification:CreateTable',
-- createTable_capacitySpecification - Specifies the read/write
-- throughput capacity mode for the table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
--
-- $sel:comment:CreateTable', createTable_comment - This
-- parameter allows to enter a description of the table.
--
-- $sel:defaultTimeToLive:CreateTable',
-- createTable_defaultTimeToLive - The default Time to Live
-- setting in seconds for the table.
--
-- For more information, see Setting the default TTL value for a
-- table in the Amazon Keyspaces Developer Guide.
--
-- $sel:encryptionSpecification:CreateTable',
-- createTable_encryptionSpecification - Specifies how the
-- encryption key for encryption at rest is managed for the table. You
-- can choose one of the following KMS key (KMS key):
--
-- • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon
-- Keyspaces.
--
-- • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your
-- account and is created, owned, and managed by you. This option
-- requires the kms_key_identifier of the KMS key in Amazon
-- Resource Name (ARN) format as input.
--
-- The default is type:AWS_OWNED_KMS_KEY.
--
-- For more information, see Encryption at rest in the Amazon
-- Keyspaces Developer Guide.
--
-- $sel:pointInTimeRecovery:CreateTable',
-- createTable_pointInTimeRecovery - Specifies if
-- pointInTimeRecovery is enabled or disabled for the table. The
-- options are:
--
-- • ENABLED
--
-- • DISABLED
--
-- If it's not specified, the default is DISABLED.
--
-- For more information, see Point-in-time recovery in the
-- Amazon Keyspaces Developer Guide.
--
-- $sel:tags:CreateTable', createTable_tags - A list of
-- key-value pair tags to be attached to the resource.
--
-- For more information, see Adding tags and labels to Amazon
-- Keyspaces resources in the Amazon Keyspaces Developer
-- Guide.
--
-- $sel:ttl:CreateTable', createTable_ttl - Enables Time to
-- Live custom settings for the table. The options are:
--
-- • status:enabled
--
-- • status:disabled
--
-- The default is status:disabled. After ttl is
-- enabled, you can't disable it for the table.
--
-- For more information, see Expiring data by using Amazon Keyspaces
-- Time to Live (TTL) in the Amazon Keyspaces Developer Guide.
--
-- CreateTable, createTable_keyspaceName - The name of the
-- keyspace that the table is going to be created in.
--
-- CreateTable, createTable_tableName - The name of the
-- table.
--
-- $sel:schemaDefinition:CreateTable',
-- createTable_schemaDefinition - The schemaDefinition
-- consists of the following parameters.
--
-- For each column to be created:
--
-- • name - The name of the column.
--
-- • type - An Amazon Keyspaces data type. For more information,
-- see Data types in the Amazon Keyspaces Developer Guide.
--
-- The primary key of the table consists of the following columns:
--
-- • partitionKeys - The partition key can be a single column,
-- or it can be a compound value composed of two or more columns. The
-- partition key portion of the primary key is required and determines
-- how Amazon Keyspaces stores your data.
--
-- • name - The name of each partition key column.
--
-- • clusteringKeys - The optional clustering column portion of
-- your primary key determines how the data is clustered and sorted
-- within each partition.
--
-- • name - The name of the clustering column.
--
-- • orderBy - Sets the ascendant (ASC) or descendant
-- (DESC) order modifier.
--
-- To define a column as static use staticColumns - Static
-- columns store values that are shared by all rows in the same
-- partition:
--
-- • name - The name of the column.
--
-- • type - An Amazon Keyspaces data type.
newCreateTable :: Text -> Text -> SchemaDefinition -> CreateTable
-- | Specifies the read/write throughput capacity mode for the table. The
-- options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
createTable_capacitySpecification :: Lens' CreateTable (Maybe CapacitySpecification)
-- | This parameter allows to enter a description of the table.
createTable_comment :: Lens' CreateTable (Maybe Comment)
-- | The default Time to Live setting in seconds for the table.
--
-- For more information, see Setting the default TTL value for a
-- table in the Amazon Keyspaces Developer Guide.
createTable_defaultTimeToLive :: Lens' CreateTable (Maybe Natural)
-- | Specifies how the encryption key for encryption at rest is managed for
-- the table. You can choose one of the following KMS key (KMS key):
--
-- • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon
-- Keyspaces.
--
-- • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your
-- account and is created, owned, and managed by you. This option
-- requires the kms_key_identifier of the KMS key in Amazon
-- Resource Name (ARN) format as input.
--
-- The default is type:AWS_OWNED_KMS_KEY.
--
-- For more information, see Encryption at rest in the Amazon
-- Keyspaces Developer Guide.
createTable_encryptionSpecification :: Lens' CreateTable (Maybe EncryptionSpecification)
-- | Specifies if pointInTimeRecovery is enabled or disabled for
-- the table. The options are:
--
-- • ENABLED
--
-- • DISABLED
--
-- If it's not specified, the default is DISABLED.
--
-- For more information, see Point-in-time recovery in the
-- Amazon Keyspaces Developer Guide.
createTable_pointInTimeRecovery :: Lens' CreateTable (Maybe PointInTimeRecovery)
-- | A list of key-value pair tags to be attached to the resource.
--
-- For more information, see Adding tags and labels to Amazon
-- Keyspaces resources in the Amazon Keyspaces Developer
-- Guide.
createTable_tags :: Lens' CreateTable (Maybe (NonEmpty Tag))
-- | Enables Time to Live custom settings for the table. The options are:
--
-- • status:enabled
--
-- • status:disabled
--
-- The default is status:disabled. After ttl is
-- enabled, you can't disable it for the table.
--
-- For more information, see Expiring data by using Amazon Keyspaces
-- Time to Live (TTL) in the Amazon Keyspaces Developer Guide.
createTable_ttl :: Lens' CreateTable (Maybe TimeToLive)
-- | The name of the keyspace that the table is going to be created in.
createTable_keyspaceName :: Lens' CreateTable Text
-- | The name of the table.
createTable_tableName :: Lens' CreateTable Text
-- | The schemaDefinition consists of the following parameters.
--
-- For each column to be created:
--
-- • name - The name of the column.
--
-- • type - An Amazon Keyspaces data type. For more information,
-- see Data types in the Amazon Keyspaces Developer Guide.
--
-- The primary key of the table consists of the following columns:
--
-- • partitionKeys - The partition key can be a single column,
-- or it can be a compound value composed of two or more columns. The
-- partition key portion of the primary key is required and determines
-- how Amazon Keyspaces stores your data.
--
-- • name - The name of each partition key column.
--
-- • clusteringKeys - The optional clustering column portion of
-- your primary key determines how the data is clustered and sorted
-- within each partition.
--
-- • name - The name of the clustering column.
--
-- • orderBy - Sets the ascendant (ASC) or descendant
-- (DESC) order modifier.
--
-- To define a column as static use staticColumns - Static
-- columns store values that are shared by all rows in the same
-- partition:
--
-- • name - The name of the column.
--
-- • type - An Amazon Keyspaces data type.
createTable_schemaDefinition :: Lens' CreateTable SchemaDefinition
-- | See: newCreateTableResponse smart constructor.
data CreateTableResponse
CreateTableResponse' :: Int -> Text -> CreateTableResponse
-- | The response's http status code.
[$sel:httpStatus:CreateTableResponse'] :: CreateTableResponse -> Int
-- | The unique identifier of the table in the format of an Amazon Resource
-- Name (ARN).
[$sel:resourceArn:CreateTableResponse'] :: CreateTableResponse -> Text
-- | 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:httpStatus:CreateTableResponse',
-- createTableResponse_httpStatus - The response's http status
-- code.
--
-- CreateTableResponse, createTableResponse_resourceArn -
-- The unique identifier of the table in the format of an Amazon Resource
-- Name (ARN).
newCreateTableResponse :: Int -> Text -> CreateTableResponse
-- | The response's http status code.
createTableResponse_httpStatus :: Lens' CreateTableResponse Int
-- | The unique identifier of the table in the format of an Amazon Resource
-- Name (ARN).
createTableResponse_resourceArn :: Lens' CreateTableResponse Text
instance GHC.Generics.Generic Amazonka.KeySpaces.CreateTable.CreateTable
instance GHC.Show.Show Amazonka.KeySpaces.CreateTable.CreateTable
instance GHC.Read.Read Amazonka.KeySpaces.CreateTable.CreateTable
instance GHC.Classes.Eq Amazonka.KeySpaces.CreateTable.CreateTable
instance GHC.Generics.Generic Amazonka.KeySpaces.CreateTable.CreateTableResponse
instance GHC.Show.Show Amazonka.KeySpaces.CreateTable.CreateTableResponse
instance GHC.Read.Read Amazonka.KeySpaces.CreateTable.CreateTableResponse
instance GHC.Classes.Eq Amazonka.KeySpaces.CreateTable.CreateTableResponse
instance Amazonka.Types.AWSRequest Amazonka.KeySpaces.CreateTable.CreateTable
instance Control.DeepSeq.NFData Amazonka.KeySpaces.CreateTable.CreateTableResponse
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.CreateTable.CreateTable
instance Control.DeepSeq.NFData Amazonka.KeySpaces.CreateTable.CreateTable
instance Amazonka.Data.Headers.ToHeaders Amazonka.KeySpaces.CreateTable.CreateTable
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.CreateTable.CreateTable
instance Amazonka.Data.Path.ToPath Amazonka.KeySpaces.CreateTable.CreateTable
instance Amazonka.Data.Query.ToQuery Amazonka.KeySpaces.CreateTable.CreateTable
-- | The CreateKeyspace operation adds a new keyspace to your
-- account. In an Amazon Web Services account, keyspace names must be
-- unique within each Region.
--
-- CreateKeyspace is an asynchronous operation. You can monitor
-- the creation status of the new keyspace by using the
-- GetKeyspace operation.
--
-- For more information, see Creating keyspaces in the Amazon
-- Keyspaces Developer Guide.
module Amazonka.KeySpaces.CreateKeyspace
-- | See: newCreateKeyspace smart constructor.
data CreateKeyspace
CreateKeyspace' :: Maybe (NonEmpty Tag) -> Text -> CreateKeyspace
-- | A list of key-value pair tags to be attached to the keyspace.
--
-- For more information, see Adding tags and labels to Amazon
-- Keyspaces resources in the Amazon Keyspaces Developer
-- Guide.
[$sel:tags:CreateKeyspace'] :: CreateKeyspace -> Maybe (NonEmpty Tag)
-- | The name of the keyspace to be created.
[$sel:keyspaceName:CreateKeyspace'] :: CreateKeyspace -> Text
-- | Create a value of CreateKeyspace 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:tags:CreateKeyspace', createKeyspace_tags - A list
-- of key-value pair tags to be attached to the keyspace.
--
-- For more information, see Adding tags and labels to Amazon
-- Keyspaces resources in the Amazon Keyspaces Developer
-- Guide.
--
-- CreateKeyspace, createKeyspace_keyspaceName - The name
-- of the keyspace to be created.
newCreateKeyspace :: Text -> CreateKeyspace
-- | A list of key-value pair tags to be attached to the keyspace.
--
-- For more information, see Adding tags and labels to Amazon
-- Keyspaces resources in the Amazon Keyspaces Developer
-- Guide.
createKeyspace_tags :: Lens' CreateKeyspace (Maybe (NonEmpty Tag))
-- | The name of the keyspace to be created.
createKeyspace_keyspaceName :: Lens' CreateKeyspace Text
-- | See: newCreateKeyspaceResponse smart constructor.
data CreateKeyspaceResponse
CreateKeyspaceResponse' :: Int -> Text -> CreateKeyspaceResponse
-- | The response's http status code.
[$sel:httpStatus:CreateKeyspaceResponse'] :: CreateKeyspaceResponse -> Int
-- | The unique identifier of the keyspace in the format of an Amazon
-- Resource Name (ARN).
[$sel:resourceArn:CreateKeyspaceResponse'] :: CreateKeyspaceResponse -> Text
-- | Create a value of CreateKeyspaceResponse 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:httpStatus:CreateKeyspaceResponse',
-- createKeyspaceResponse_httpStatus - The response's http status
-- code.
--
-- CreateKeyspaceResponse,
-- createKeyspaceResponse_resourceArn - The unique identifier of
-- the keyspace in the format of an Amazon Resource Name (ARN).
newCreateKeyspaceResponse :: Int -> Text -> CreateKeyspaceResponse
-- | The response's http status code.
createKeyspaceResponse_httpStatus :: Lens' CreateKeyspaceResponse Int
-- | The unique identifier of the keyspace in the format of an Amazon
-- Resource Name (ARN).
createKeyspaceResponse_resourceArn :: Lens' CreateKeyspaceResponse Text
instance GHC.Generics.Generic Amazonka.KeySpaces.CreateKeyspace.CreateKeyspace
instance GHC.Show.Show Amazonka.KeySpaces.CreateKeyspace.CreateKeyspace
instance GHC.Read.Read Amazonka.KeySpaces.CreateKeyspace.CreateKeyspace
instance GHC.Classes.Eq Amazonka.KeySpaces.CreateKeyspace.CreateKeyspace
instance GHC.Generics.Generic Amazonka.KeySpaces.CreateKeyspace.CreateKeyspaceResponse
instance GHC.Show.Show Amazonka.KeySpaces.CreateKeyspace.CreateKeyspaceResponse
instance GHC.Read.Read Amazonka.KeySpaces.CreateKeyspace.CreateKeyspaceResponse
instance GHC.Classes.Eq Amazonka.KeySpaces.CreateKeyspace.CreateKeyspaceResponse
instance Amazonka.Types.AWSRequest Amazonka.KeySpaces.CreateKeyspace.CreateKeyspace
instance Control.DeepSeq.NFData Amazonka.KeySpaces.CreateKeyspace.CreateKeyspaceResponse
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.CreateKeyspace.CreateKeyspace
instance Control.DeepSeq.NFData Amazonka.KeySpaces.CreateKeyspace.CreateKeyspace
instance Amazonka.Data.Headers.ToHeaders Amazonka.KeySpaces.CreateKeyspace.CreateKeyspace
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.CreateKeyspace.CreateKeyspace
instance Amazonka.Data.Path.ToPath Amazonka.KeySpaces.CreateKeyspace.CreateKeyspace
instance Amazonka.Data.Query.ToQuery Amazonka.KeySpaces.CreateKeyspace.CreateKeyspace
-- | Removes the association of tags from a Amazon Keyspaces resource.
module Amazonka.KeySpaces.UntagResource
-- | See: newUntagResource smart constructor.
data UntagResource
UntagResource' :: Text -> NonEmpty Tag -> UntagResource
-- | The Amazon Keyspaces resource that the tags will be removed from. This
-- value is an Amazon Resource Name (ARN).
[$sel:resourceArn:UntagResource'] :: UntagResource -> Text
-- | A list of existing tags to be removed from the Amazon Keyspaces
-- resource.
[$sel:tags:UntagResource'] :: UntagResource -> NonEmpty Tag
-- | Create a value of UntagResource 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:
--
-- UntagResource, untagResource_resourceArn - The Amazon
-- Keyspaces resource that the tags will be removed from. This value is
-- an Amazon Resource Name (ARN).
--
-- $sel:tags:UntagResource', untagResource_tags - A list of
-- existing tags to be removed from the Amazon Keyspaces resource.
newUntagResource :: Text -> NonEmpty Tag -> UntagResource
-- | The Amazon Keyspaces resource that the tags will be removed from. This
-- value is an Amazon Resource Name (ARN).
untagResource_resourceArn :: Lens' UntagResource Text
-- | A list of existing tags to be removed from the Amazon Keyspaces
-- resource.
untagResource_tags :: Lens' UntagResource (NonEmpty Tag)
-- | See: newUntagResourceResponse smart constructor.
data UntagResourceResponse
UntagResourceResponse' :: Int -> UntagResourceResponse
-- | The response's http status code.
[$sel:httpStatus:UntagResourceResponse'] :: UntagResourceResponse -> Int
-- | Create a value of UntagResourceResponse 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:httpStatus:UntagResourceResponse',
-- untagResourceResponse_httpStatus - The response's http status
-- code.
newUntagResourceResponse :: Int -> UntagResourceResponse
-- | The response's http status code.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
instance GHC.Generics.Generic Amazonka.KeySpaces.UntagResource.UntagResource
instance GHC.Show.Show Amazonka.KeySpaces.UntagResource.UntagResource
instance GHC.Read.Read Amazonka.KeySpaces.UntagResource.UntagResource
instance GHC.Classes.Eq Amazonka.KeySpaces.UntagResource.UntagResource
instance GHC.Generics.Generic Amazonka.KeySpaces.UntagResource.UntagResourceResponse
instance GHC.Show.Show Amazonka.KeySpaces.UntagResource.UntagResourceResponse
instance GHC.Read.Read Amazonka.KeySpaces.UntagResource.UntagResourceResponse
instance GHC.Classes.Eq Amazonka.KeySpaces.UntagResource.UntagResourceResponse
instance Amazonka.Types.AWSRequest Amazonka.KeySpaces.UntagResource.UntagResource
instance Control.DeepSeq.NFData Amazonka.KeySpaces.UntagResource.UntagResourceResponse
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.UntagResource.UntagResource
instance Control.DeepSeq.NFData Amazonka.KeySpaces.UntagResource.UntagResource
instance Amazonka.Data.Headers.ToHeaders Amazonka.KeySpaces.UntagResource.UntagResource
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.UntagResource.UntagResource
instance Amazonka.Data.Path.ToPath Amazonka.KeySpaces.UntagResource.UntagResource
instance Amazonka.Data.Query.ToQuery Amazonka.KeySpaces.UntagResource.UntagResource
-- | Adds new columns to the table or updates one of the table's settings,
-- for example capacity mode, encryption, point-in-time recovery, or ttl
-- settings. Note that you can only update one specific table setting per
-- update operation.
module Amazonka.KeySpaces.UpdateTable
-- | See: newUpdateTable smart constructor.
data UpdateTable
UpdateTable' :: Maybe (NonEmpty ColumnDefinition) -> Maybe CapacitySpecification -> Maybe Natural -> Maybe EncryptionSpecification -> Maybe PointInTimeRecovery -> Maybe TimeToLive -> Text -> Text -> UpdateTable
-- | For each column to be added to the specified table:
--
-- • name - The name of the column.
--
-- • type - An Amazon Keyspaces data type. For more information,
-- see Data types in the Amazon Keyspaces Developer Guide.
[$sel:addColumns:UpdateTable'] :: UpdateTable -> Maybe (NonEmpty ColumnDefinition)
-- | Modifies the read/write throughput capacity mode for the table. The
-- options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
[$sel:capacitySpecification:UpdateTable'] :: UpdateTable -> Maybe CapacitySpecification
-- | The default Time to Live setting in seconds for the table.
--
-- For more information, see Setting the default TTL value for a
-- table in the Amazon Keyspaces Developer Guide.
[$sel:defaultTimeToLive:UpdateTable'] :: UpdateTable -> Maybe Natural
-- | Modifies the encryption settings of the table. You can choose one of
-- the following KMS key (KMS key):
--
-- • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon
-- Keyspaces.
--
-- • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your
-- account and is created, owned, and managed by you. This option
-- requires the kms_key_identifier of the KMS key in Amazon
-- Resource Name (ARN) format as input.
--
-- The default is AWS_OWNED_KMS_KEY.
--
-- For more information, see Encryption at rest in the Amazon
-- Keyspaces Developer Guide.
[$sel:encryptionSpecification:UpdateTable'] :: UpdateTable -> Maybe EncryptionSpecification
-- | Modifies the pointInTimeRecovery settings of the table. The
-- options are:
--
-- • ENABLED
--
-- • DISABLED
--
-- If it's not specified, the default is DISABLED.
--
-- For more information, see Point-in-time recovery in the
-- Amazon Keyspaces Developer Guide.
[$sel:pointInTimeRecovery:UpdateTable'] :: UpdateTable -> Maybe PointInTimeRecovery
-- | Modifies Time to Live custom settings for the table. The options are:
--
-- • status:enabled
--
-- • status:disabled
--
-- The default is status:disabled. After ttl is
-- enabled, you can't disable it for the table.
--
-- For more information, see Expiring data by using Amazon Keyspaces
-- Time to Live (TTL) in the Amazon Keyspaces Developer Guide.
[$sel:ttl:UpdateTable'] :: UpdateTable -> Maybe TimeToLive
-- | The name of the keyspace the specified table is stored in.
[$sel:keyspaceName:UpdateTable'] :: UpdateTable -> Text
-- | The name of the table.
[$sel:tableName:UpdateTable'] :: UpdateTable -> Text
-- | Create a value of UpdateTable 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:addColumns:UpdateTable', updateTable_addColumns -
-- For each column to be added to the specified table:
--
-- • name - The name of the column.
--
-- • type - An Amazon Keyspaces data type. For more information,
-- see Data types in the Amazon Keyspaces Developer Guide.
--
-- $sel:capacitySpecification:UpdateTable',
-- updateTable_capacitySpecification - Modifies the read/write
-- throughput capacity mode for the table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
--
-- $sel:defaultTimeToLive:UpdateTable',
-- updateTable_defaultTimeToLive - The default Time to Live
-- setting in seconds for the table.
--
-- For more information, see Setting the default TTL value for a
-- table in the Amazon Keyspaces Developer Guide.
--
-- $sel:encryptionSpecification:UpdateTable',
-- updateTable_encryptionSpecification - Modifies the encryption
-- settings of the table. You can choose one of the following KMS key
-- (KMS key):
--
-- • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon
-- Keyspaces.
--
-- • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your
-- account and is created, owned, and managed by you. This option
-- requires the kms_key_identifier of the KMS key in Amazon
-- Resource Name (ARN) format as input.
--
-- The default is AWS_OWNED_KMS_KEY.
--
-- For more information, see Encryption at rest in the Amazon
-- Keyspaces Developer Guide.
--
-- $sel:pointInTimeRecovery:UpdateTable',
-- updateTable_pointInTimeRecovery - Modifies the
-- pointInTimeRecovery settings of the table. The options are:
--
-- • ENABLED
--
-- • DISABLED
--
-- If it's not specified, the default is DISABLED.
--
-- For more information, see Point-in-time recovery in the
-- Amazon Keyspaces Developer Guide.
--
-- $sel:ttl:UpdateTable', updateTable_ttl - Modifies Time
-- to Live custom settings for the table. The options are:
--
-- • status:enabled
--
-- • status:disabled
--
-- The default is status:disabled. After ttl is
-- enabled, you can't disable it for the table.
--
-- For more information, see Expiring data by using Amazon Keyspaces
-- Time to Live (TTL) in the Amazon Keyspaces Developer Guide.
--
-- UpdateTable, updateTable_keyspaceName - The name of the
-- keyspace the specified table is stored in.
--
-- UpdateTable, updateTable_tableName - The name of the
-- table.
newUpdateTable :: Text -> Text -> UpdateTable
-- | For each column to be added to the specified table:
--
-- • name - The name of the column.
--
-- • type - An Amazon Keyspaces data type. For more information,
-- see Data types in the Amazon Keyspaces Developer Guide.
updateTable_addColumns :: Lens' UpdateTable (Maybe (NonEmpty ColumnDefinition))
-- | Modifies the read/write throughput capacity mode for the table. The
-- options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
updateTable_capacitySpecification :: Lens' UpdateTable (Maybe CapacitySpecification)
-- | The default Time to Live setting in seconds for the table.
--
-- For more information, see Setting the default TTL value for a
-- table in the Amazon Keyspaces Developer Guide.
updateTable_defaultTimeToLive :: Lens' UpdateTable (Maybe Natural)
-- | Modifies the encryption settings of the table. You can choose one of
-- the following KMS key (KMS key):
--
-- • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon
-- Keyspaces.
--
-- • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your
-- account and is created, owned, and managed by you. This option
-- requires the kms_key_identifier of the KMS key in Amazon
-- Resource Name (ARN) format as input.
--
-- The default is AWS_OWNED_KMS_KEY.
--
-- For more information, see Encryption at rest in the Amazon
-- Keyspaces Developer Guide.
updateTable_encryptionSpecification :: Lens' UpdateTable (Maybe EncryptionSpecification)
-- | Modifies the pointInTimeRecovery settings of the table. The
-- options are:
--
-- • ENABLED
--
-- • DISABLED
--
-- If it's not specified, the default is DISABLED.
--
-- For more information, see Point-in-time recovery in the
-- Amazon Keyspaces Developer Guide.
updateTable_pointInTimeRecovery :: Lens' UpdateTable (Maybe PointInTimeRecovery)
-- | Modifies Time to Live custom settings for the table. The options are:
--
-- • status:enabled
--
-- • status:disabled
--
-- The default is status:disabled. After ttl is
-- enabled, you can't disable it for the table.
--
-- For more information, see Expiring data by using Amazon Keyspaces
-- Time to Live (TTL) in the Amazon Keyspaces Developer Guide.
updateTable_ttl :: Lens' UpdateTable (Maybe TimeToLive)
-- | The name of the keyspace the specified table is stored in.
updateTable_keyspaceName :: Lens' UpdateTable Text
-- | The name of the table.
updateTable_tableName :: Lens' UpdateTable Text
-- | See: newUpdateTableResponse smart constructor.
data UpdateTableResponse
UpdateTableResponse' :: Int -> Text -> UpdateTableResponse
-- | The response's http status code.
[$sel:httpStatus:UpdateTableResponse'] :: UpdateTableResponse -> Int
-- | The Amazon Resource Name (ARN) of the modified table.
[$sel:resourceArn:UpdateTableResponse'] :: UpdateTableResponse -> Text
-- | Create a value of UpdateTableResponse 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:httpStatus:UpdateTableResponse',
-- updateTableResponse_httpStatus - The response's http status
-- code.
--
-- UpdateTableResponse, updateTableResponse_resourceArn -
-- The Amazon Resource Name (ARN) of the modified table.
newUpdateTableResponse :: Int -> Text -> UpdateTableResponse
-- | The response's http status code.
updateTableResponse_httpStatus :: Lens' UpdateTableResponse Int
-- | The Amazon Resource Name (ARN) of the modified table.
updateTableResponse_resourceArn :: Lens' UpdateTableResponse Text
instance GHC.Generics.Generic Amazonka.KeySpaces.UpdateTable.UpdateTable
instance GHC.Show.Show Amazonka.KeySpaces.UpdateTable.UpdateTable
instance GHC.Read.Read Amazonka.KeySpaces.UpdateTable.UpdateTable
instance GHC.Classes.Eq Amazonka.KeySpaces.UpdateTable.UpdateTable
instance GHC.Generics.Generic Amazonka.KeySpaces.UpdateTable.UpdateTableResponse
instance GHC.Show.Show Amazonka.KeySpaces.UpdateTable.UpdateTableResponse
instance GHC.Read.Read Amazonka.KeySpaces.UpdateTable.UpdateTableResponse
instance GHC.Classes.Eq Amazonka.KeySpaces.UpdateTable.UpdateTableResponse
instance Amazonka.Types.AWSRequest Amazonka.KeySpaces.UpdateTable.UpdateTable
instance Control.DeepSeq.NFData Amazonka.KeySpaces.UpdateTable.UpdateTableResponse
instance Data.Hashable.Class.Hashable Amazonka.KeySpaces.UpdateTable.UpdateTable
instance Control.DeepSeq.NFData Amazonka.KeySpaces.UpdateTable.UpdateTable
instance Amazonka.Data.Headers.ToHeaders Amazonka.KeySpaces.UpdateTable.UpdateTable
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.KeySpaces.UpdateTable.UpdateTable
instance Amazonka.Data.Path.ToPath Amazonka.KeySpaces.UpdateTable.UpdateTable
instance Amazonka.Data.Query.ToQuery Amazonka.KeySpaces.UpdateTable.UpdateTable
module Amazonka.KeySpaces.Lens
-- | A list of key-value pair tags to be attached to the keyspace.
--
-- For more information, see Adding tags and labels to Amazon
-- Keyspaces resources in the Amazon Keyspaces Developer
-- Guide.
createKeyspace_tags :: Lens' CreateKeyspace (Maybe (NonEmpty Tag))
-- | The name of the keyspace to be created.
createKeyspace_keyspaceName :: Lens' CreateKeyspace Text
-- | The response's http status code.
createKeyspaceResponse_httpStatus :: Lens' CreateKeyspaceResponse Int
-- | The unique identifier of the keyspace in the format of an Amazon
-- Resource Name (ARN).
createKeyspaceResponse_resourceArn :: Lens' CreateKeyspaceResponse Text
-- | Specifies the read/write throughput capacity mode for the table. The
-- options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
createTable_capacitySpecification :: Lens' CreateTable (Maybe CapacitySpecification)
-- | This parameter allows to enter a description of the table.
createTable_comment :: Lens' CreateTable (Maybe Comment)
-- | The default Time to Live setting in seconds for the table.
--
-- For more information, see Setting the default TTL value for a
-- table in the Amazon Keyspaces Developer Guide.
createTable_defaultTimeToLive :: Lens' CreateTable (Maybe Natural)
-- | Specifies how the encryption key for encryption at rest is managed for
-- the table. You can choose one of the following KMS key (KMS key):
--
-- • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon
-- Keyspaces.
--
-- • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your
-- account and is created, owned, and managed by you. This option
-- requires the kms_key_identifier of the KMS key in Amazon
-- Resource Name (ARN) format as input.
--
-- The default is type:AWS_OWNED_KMS_KEY.
--
-- For more information, see Encryption at rest in the Amazon
-- Keyspaces Developer Guide.
createTable_encryptionSpecification :: Lens' CreateTable (Maybe EncryptionSpecification)
-- | Specifies if pointInTimeRecovery is enabled or disabled for
-- the table. The options are:
--
-- • ENABLED
--
-- • DISABLED
--
-- If it's not specified, the default is DISABLED.
--
-- For more information, see Point-in-time recovery in the
-- Amazon Keyspaces Developer Guide.
createTable_pointInTimeRecovery :: Lens' CreateTable (Maybe PointInTimeRecovery)
-- | A list of key-value pair tags to be attached to the resource.
--
-- For more information, see Adding tags and labels to Amazon
-- Keyspaces resources in the Amazon Keyspaces Developer
-- Guide.
createTable_tags :: Lens' CreateTable (Maybe (NonEmpty Tag))
-- | Enables Time to Live custom settings for the table. The options are:
--
-- • status:enabled
--
-- • status:disabled
--
-- The default is status:disabled. After ttl is
-- enabled, you can't disable it for the table.
--
-- For more information, see Expiring data by using Amazon Keyspaces
-- Time to Live (TTL) in the Amazon Keyspaces Developer Guide.
createTable_ttl :: Lens' CreateTable (Maybe TimeToLive)
-- | The name of the keyspace that the table is going to be created in.
createTable_keyspaceName :: Lens' CreateTable Text
-- | The name of the table.
createTable_tableName :: Lens' CreateTable Text
-- | The schemaDefinition consists of the following parameters.
--
-- For each column to be created:
--
-- • name - The name of the column.
--
-- • type - An Amazon Keyspaces data type. For more information,
-- see Data types in the Amazon Keyspaces Developer Guide.
--
-- The primary key of the table consists of the following columns:
--
-- • partitionKeys - The partition key can be a single column,
-- or it can be a compound value composed of two or more columns. The
-- partition key portion of the primary key is required and determines
-- how Amazon Keyspaces stores your data.
--
-- • name - The name of each partition key column.
--
-- • clusteringKeys - The optional clustering column portion of
-- your primary key determines how the data is clustered and sorted
-- within each partition.
--
-- • name - The name of the clustering column.
--
-- • orderBy - Sets the ascendant (ASC) or descendant
-- (DESC) order modifier.
--
-- To define a column as static use staticColumns - Static
-- columns store values that are shared by all rows in the same
-- partition:
--
-- • name - The name of the column.
--
-- • type - An Amazon Keyspaces data type.
createTable_schemaDefinition :: Lens' CreateTable SchemaDefinition
-- | The response's http status code.
createTableResponse_httpStatus :: Lens' CreateTableResponse Int
-- | The unique identifier of the table in the format of an Amazon Resource
-- Name (ARN).
createTableResponse_resourceArn :: Lens' CreateTableResponse Text
-- | The name of the keyspace to be deleted.
deleteKeyspace_keyspaceName :: Lens' DeleteKeyspace Text
-- | The response's http status code.
deleteKeyspaceResponse_httpStatus :: Lens' DeleteKeyspaceResponse Int
-- | The name of the keyspace of the to be deleted table.
deleteTable_keyspaceName :: Lens' DeleteTable Text
-- | The name of the table to be deleted.
deleteTable_tableName :: Lens' DeleteTable Text
-- | The response's http status code.
deleteTableResponse_httpStatus :: Lens' DeleteTableResponse Int
-- | The name of the keyspace.
getKeyspace_keyspaceName :: Lens' GetKeyspace Text
-- | The response's http status code.
getKeyspaceResponse_httpStatus :: Lens' GetKeyspaceResponse Int
-- | The name of the keyspace.
getKeyspaceResponse_keyspaceName :: Lens' GetKeyspaceResponse Text
-- | The ARN of the keyspace.
getKeyspaceResponse_resourceArn :: Lens' GetKeyspaceResponse Text
-- | The name of the keyspace that the table is stored in.
getTable_keyspaceName :: Lens' GetTable Text
-- | The name of the table.
getTable_tableName :: Lens' GetTable Text
-- | The read/write throughput capacity mode for a table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST
--
-- • throughputMode:PROVISIONED
getTableResponse_capacitySpecification :: Lens' GetTableResponse (Maybe CapacitySpecificationSummary)
-- | The the description of the specified table.
getTableResponse_comment :: Lens' GetTableResponse (Maybe Comment)
-- | The creation timestamp of the specified table.
getTableResponse_creationTimestamp :: Lens' GetTableResponse (Maybe UTCTime)
-- | The default Time to Live settings of the specified table.
getTableResponse_defaultTimeToLive :: Lens' GetTableResponse (Maybe Natural)
-- | The encryption settings of the specified table.
getTableResponse_encryptionSpecification :: Lens' GetTableResponse (Maybe EncryptionSpecification)
-- | The point-in-time recovery status of the specified table.
getTableResponse_pointInTimeRecovery :: Lens' GetTableResponse (Maybe PointInTimeRecoverySummary)
-- | The schema definition of the specified table.
getTableResponse_schemaDefinition :: Lens' GetTableResponse (Maybe SchemaDefinition)
-- | The current status of the specified table.
getTableResponse_status :: Lens' GetTableResponse (Maybe TableStatus)
-- | The custom Time to Live settings of the specified table.
getTableResponse_ttl :: Lens' GetTableResponse (Maybe TimeToLive)
-- | The response's http status code.
getTableResponse_httpStatus :: Lens' GetTableResponse Int
-- | The name of the keyspace that the specified table is stored in.
getTableResponse_keyspaceName :: Lens' GetTableResponse Text
-- | The name of the specified table.
getTableResponse_tableName :: Lens' GetTableResponse Text
-- | The Amazon Resource Name (ARN) of the specified table.
getTableResponse_resourceArn :: Lens' GetTableResponse Text
-- | The total number of keyspaces to return in the output. If the total
-- number of keyspaces available is more than the value specified, a
-- NextToken is provided in the output. To resume pagination,
-- provide the NextToken value as an argument of a subsequent
-- API invocation.
listKeyspaces_maxResults :: Lens' ListKeyspaces (Maybe Natural)
-- | The pagination token. To resume pagination, provide the
-- NextToken value as argument of a subsequent API invocation.
listKeyspaces_nextToken :: Lens' ListKeyspaces (Maybe Text)
-- | A token to specify where to start paginating. This is the
-- NextToken from a previously truncated response.
listKeyspacesResponse_nextToken :: Lens' ListKeyspacesResponse (Maybe Text)
-- | The response's http status code.
listKeyspacesResponse_httpStatus :: Lens' ListKeyspacesResponse Int
-- | A list of keyspaces.
listKeyspacesResponse_keyspaces :: Lens' ListKeyspacesResponse [KeyspaceSummary]
-- | The total number of tables to return in the output. If the total
-- number of tables available is more than the value specified, a
-- NextToken is provided in the output. To resume pagination,
-- provide the NextToken value as an argument of a subsequent
-- API invocation.
listTables_maxResults :: Lens' ListTables (Maybe Natural)
-- | The pagination token. To resume pagination, provide the
-- NextToken value as an argument of a subsequent API
-- invocation.
listTables_nextToken :: Lens' ListTables (Maybe Text)
-- | The name of the keyspace.
listTables_keyspaceName :: Lens' ListTables Text
-- | A token to specify where to start paginating. This is the
-- NextToken from a previously truncated response.
listTablesResponse_nextToken :: Lens' ListTablesResponse (Maybe Text)
-- | A list of tables.
listTablesResponse_tables :: Lens' ListTablesResponse (Maybe [TableSummary])
-- | The response's http status code.
listTablesResponse_httpStatus :: Lens' ListTablesResponse Int
-- | The total number of tags to return in the output. If the total number
-- of tags available is more than the value specified, a
-- NextToken is provided in the output. To resume pagination,
-- provide the NextToken value as an argument of a subsequent
-- API invocation.
listTagsForResource_maxResults :: Lens' ListTagsForResource (Maybe Natural)
-- | The pagination token. To resume pagination, provide the
-- NextToken value as argument of a subsequent API invocation.
listTagsForResource_nextToken :: Lens' ListTagsForResource (Maybe Text)
-- | The Amazon Resource Name (ARN) of the Amazon Keyspaces resource.
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
-- | A token to specify where to start paginating. This is the
-- NextToken from a previously truncated response.
listTagsForResourceResponse_nextToken :: Lens' ListTagsForResourceResponse (Maybe Text)
-- | A list of tags.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (NonEmpty Tag))
-- | The response's http status code.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
-- | Specifies the read/write throughput capacity mode for the target
-- table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
restoreTable_capacitySpecificationOverride :: Lens' RestoreTable (Maybe CapacitySpecification)
-- | Specifies the encryption settings for the target table. You can choose
-- one of the following KMS key (KMS key):
--
-- • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon
-- Keyspaces.
--
-- • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your
-- account and is created, owned, and managed by you. This option
-- requires the kms_key_identifier of the KMS key in Amazon
-- Resource Name (ARN) format as input.
--
-- The default is type:AWS_OWNED_KMS_KEY.
--
-- For more information, see Encryption at rest in the Amazon
-- Keyspaces Developer Guide.
restoreTable_encryptionSpecificationOverride :: Lens' RestoreTable (Maybe EncryptionSpecification)
-- | Specifies the pointInTimeRecovery settings for the target
-- table. The options are:
--
-- • ENABLED
--
-- • DISABLED
--
-- If it's not specified, the default is DISABLED.
--
-- For more information, see Point-in-time recovery in the
-- Amazon Keyspaces Developer Guide.
restoreTable_pointInTimeRecoveryOverride :: Lens' RestoreTable (Maybe PointInTimeRecovery)
-- | The restore timestamp in ISO 8601 format.
restoreTable_restoreTimestamp :: Lens' RestoreTable (Maybe UTCTime)
-- | A list of key-value pair tags to be attached to the restored table.
--
-- For more information, see Adding tags and labels to Amazon
-- Keyspaces resources in the Amazon Keyspaces Developer
-- Guide.
restoreTable_tagsOverride :: Lens' RestoreTable (Maybe (NonEmpty Tag))
-- | The keyspace name of the source table.
restoreTable_sourceKeyspaceName :: Lens' RestoreTable Text
-- | The name of the source table.
restoreTable_sourceTableName :: Lens' RestoreTable Text
-- | The name of the target keyspace.
restoreTable_targetKeyspaceName :: Lens' RestoreTable Text
-- | The name of the target table.
restoreTable_targetTableName :: Lens' RestoreTable Text
-- | The response's http status code.
restoreTableResponse_httpStatus :: Lens' RestoreTableResponse Int
-- | The Amazon Resource Name (ARN) of the restored table.
restoreTableResponse_restoredTableARN :: Lens' RestoreTableResponse Text
-- | The Amazon Resource Name (ARN) of the Amazon Keyspaces resource to
-- which to add tags.
tagResource_resourceArn :: Lens' TagResource Text
-- | The tags to be assigned to the Amazon Keyspaces resource.
tagResource_tags :: Lens' TagResource (NonEmpty Tag)
-- | The response's http status code.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
-- | The Amazon Keyspaces resource that the tags will be removed from. This
-- value is an Amazon Resource Name (ARN).
untagResource_resourceArn :: Lens' UntagResource Text
-- | A list of existing tags to be removed from the Amazon Keyspaces
-- resource.
untagResource_tags :: Lens' UntagResource (NonEmpty Tag)
-- | The response's http status code.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
-- | For each column to be added to the specified table:
--
-- • name - The name of the column.
--
-- • type - An Amazon Keyspaces data type. For more information,
-- see Data types in the Amazon Keyspaces Developer Guide.
updateTable_addColumns :: Lens' UpdateTable (Maybe (NonEmpty ColumnDefinition))
-- | Modifies the read/write throughput capacity mode for the table. The
-- options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
updateTable_capacitySpecification :: Lens' UpdateTable (Maybe CapacitySpecification)
-- | The default Time to Live setting in seconds for the table.
--
-- For more information, see Setting the default TTL value for a
-- table in the Amazon Keyspaces Developer Guide.
updateTable_defaultTimeToLive :: Lens' UpdateTable (Maybe Natural)
-- | Modifies the encryption settings of the table. You can choose one of
-- the following KMS key (KMS key):
--
-- • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon
-- Keyspaces.
--
-- • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your
-- account and is created, owned, and managed by you. This option
-- requires the kms_key_identifier of the KMS key in Amazon
-- Resource Name (ARN) format as input.
--
-- The default is AWS_OWNED_KMS_KEY.
--
-- For more information, see Encryption at rest in the Amazon
-- Keyspaces Developer Guide.
updateTable_encryptionSpecification :: Lens' UpdateTable (Maybe EncryptionSpecification)
-- | Modifies the pointInTimeRecovery settings of the table. The
-- options are:
--
-- • ENABLED
--
-- • DISABLED
--
-- If it's not specified, the default is DISABLED.
--
-- For more information, see Point-in-time recovery in the
-- Amazon Keyspaces Developer Guide.
updateTable_pointInTimeRecovery :: Lens' UpdateTable (Maybe PointInTimeRecovery)
-- | Modifies Time to Live custom settings for the table. The options are:
--
-- • status:enabled
--
-- • status:disabled
--
-- The default is status:disabled. After ttl is
-- enabled, you can't disable it for the table.
--
-- For more information, see Expiring data by using Amazon Keyspaces
-- Time to Live (TTL) in the Amazon Keyspaces Developer Guide.
updateTable_ttl :: Lens' UpdateTable (Maybe TimeToLive)
-- | The name of the keyspace the specified table is stored in.
updateTable_keyspaceName :: Lens' UpdateTable Text
-- | The name of the table.
updateTable_tableName :: Lens' UpdateTable Text
-- | The response's http status code.
updateTableResponse_httpStatus :: Lens' UpdateTableResponse Int
-- | The Amazon Resource Name (ARN) of the modified table.
updateTableResponse_resourceArn :: Lens' UpdateTableResponse Text
-- | The throughput capacity specified for read operations defined
-- in read capacity units (RCUs).
capacitySpecification_readCapacityUnits :: Lens' CapacitySpecification (Maybe Natural)
-- | The throughput capacity specified for write operations
-- defined in write capacity units (WCUs).
capacitySpecification_writeCapacityUnits :: Lens' CapacitySpecification (Maybe Natural)
-- | The read/write throughput capacity mode for a table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
capacitySpecification_throughputMode :: Lens' CapacitySpecification ThroughputMode
-- | The timestamp of the last operation that changed the provisioned
-- throughput capacity of a table.
capacitySpecificationSummary_lastUpdateToPayPerRequestTimestamp :: Lens' CapacitySpecificationSummary (Maybe UTCTime)
-- | The throughput capacity specified for read operations defined
-- in read capacity units (RCUs).
capacitySpecificationSummary_readCapacityUnits :: Lens' CapacitySpecificationSummary (Maybe Natural)
-- | The throughput capacity specified for write operations
-- defined in write capacity units (WCUs).
capacitySpecificationSummary_writeCapacityUnits :: Lens' CapacitySpecificationSummary (Maybe Natural)
-- | The read/write throughput capacity mode for a table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
capacitySpecificationSummary_throughputMode :: Lens' CapacitySpecificationSummary ThroughputMode
-- | The name(s) of the clustering column(s).
clusteringKey_name :: Lens' ClusteringKey Text
-- | Sets the ascendant (ASC) or descendant (DESC) order
-- modifier.
clusteringKey_orderBy :: Lens' ClusteringKey SortOrder
-- | The name of the column.
columnDefinition_name :: Lens' ColumnDefinition Text
-- | The data type of the column. For a list of available data types, see
-- Data types in the Amazon Keyspaces Developer Guide.
columnDefinition_type :: Lens' ColumnDefinition Text
-- | An optional description of the table.
comment_message :: Lens' Comment Text
-- | The Amazon Resource Name (ARN) of the customer managed KMS key, for
-- example kms_key_identifier:ARN.
encryptionSpecification_kmsKeyIdentifier :: Lens' EncryptionSpecification (Maybe Text)
-- | The encryption option specified for the table. You can choose one of
-- the following KMS keys (KMS keys):
--
-- • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon
-- Keyspaces.
--
-- • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your
-- account and is created, owned, and managed by you. This option
-- requires the kms_key_identifier of the KMS key in Amazon
-- Resource Name (ARN) format as input.
--
-- The default is type:AWS_OWNED_KMS_KEY.
--
-- For more information, see Encryption at rest in the Amazon
-- Keyspaces Developer Guide.
encryptionSpecification_type :: Lens' EncryptionSpecification EncryptionType
-- | The name of the keyspace.
keyspaceSummary_keyspaceName :: Lens' KeyspaceSummary Text
-- | The unique identifier of the keyspace in the format of an Amazon
-- Resource Name (ARN).
keyspaceSummary_resourceArn :: Lens' KeyspaceSummary Text
-- | The name(s) of the partition key column(s).
partitionKey_name :: Lens' PartitionKey Text
-- | The options are:
--
-- • ENABLED
--
-- • DISABLED
pointInTimeRecovery_status :: Lens' PointInTimeRecovery PointInTimeRecoveryStatus
-- | Specifies the earliest possible restore point of the table in ISO 8601
-- format.
pointInTimeRecoverySummary_earliestRestorableTimestamp :: Lens' PointInTimeRecoverySummary (Maybe UTCTime)
-- | Shows if point-in-time recovery is enabled or disabled for the
-- specified table.
pointInTimeRecoverySummary_status :: Lens' PointInTimeRecoverySummary PointInTimeRecoveryStatus
-- | The columns that are part of the clustering key of the table.
schemaDefinition_clusteringKeys :: Lens' SchemaDefinition (Maybe [ClusteringKey])
-- | The columns that have been defined as STATIC. Static columns
-- store values that are shared by all rows in the same partition.
schemaDefinition_staticColumns :: Lens' SchemaDefinition (Maybe [StaticColumn])
-- | The regular columns of the table.
schemaDefinition_allColumns :: Lens' SchemaDefinition (NonEmpty ColumnDefinition)
-- | The columns that are part of the partition key of the table .
schemaDefinition_partitionKeys :: Lens' SchemaDefinition (NonEmpty PartitionKey)
-- | The name of the static column.
staticColumn_name :: Lens' StaticColumn Text
-- | The name of the keyspace that the table is stored in.
tableSummary_keyspaceName :: Lens' TableSummary Text
-- | The name of the table.
tableSummary_tableName :: Lens' TableSummary Text
-- | The unique identifier of the table in the format of an Amazon Resource
-- Name (ARN).
tableSummary_resourceArn :: Lens' TableSummary Text
-- | The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces
-- resource can only have up to one tag with the same key. If you try to
-- add an existing tag (same key), the existing tag value will be updated
-- to the new value.
tag_key :: Lens' Tag Text
-- | The value of the tag. Tag values are case-sensitive and can be null.
tag_value :: Lens' Tag Text
-- | Shows how to enable custom Time to Live (TTL) settings for the
-- specified table.
timeToLive_status :: Lens' TimeToLive TimeToLiveStatus
module Amazonka.KeySpaces.Waiters
-- | Derived from API version 2022-02-10 of the AWS service
-- descriptions, licensed under Apache 2.0.
--
-- Amazon Keyspaces (for Apache Cassandra) is a scalable, highly
-- available, and managed Apache Cassandra-compatible database service.
-- Amazon Keyspaces makes it easy to migrate, run, and scale Cassandra
-- workloads in the Amazon Web Services Cloud. With just a few clicks on
-- the Amazon Web Services Management Console or a few lines of code, you
-- can create keyspaces and tables in Amazon Keyspaces, without deploying
-- any infrastructure or installing software.
--
-- In addition to supporting Cassandra Query Language (CQL) requests via
-- open-source Cassandra drivers, Amazon Keyspaces supports data
-- definition language (DDL) operations to manage keyspaces and tables
-- using the Amazon Web Services SDK and CLI. This API reference
-- describes the supported DDL operations in detail.
--
-- For the list of all supported CQL APIs, see Supported Cassandra
-- APIs, operations, and data types in Amazon Keyspaces in the
-- Amazon Keyspaces Developer Guide.
--
-- To learn how Amazon Keyspaces API actions are recorded with
-- CloudTrail, see Amazon Keyspaces information in CloudTrail in
-- the Amazon Keyspaces Developer Guide.
--
-- For more information about Amazon Web Services APIs, for example how
-- to implement retry logic or how to sign Amazon Web Services API
-- requests, see Amazon Web Services APIs in the General
-- Reference.
module Amazonka.KeySpaces
-- | API version 2022-02-10 of the Amazon Keyspaces SDK
-- configuration.
defaultService :: Service
-- | You do not have sufficient access to perform this action.
_AccessDeniedException :: AsError a => Fold a ServiceError
-- | Amazon Keyspaces could not complete the requested action. This error
-- may occur if you try to perform an action and the same or a different
-- action is already in progress, or if you try to create a resource that
-- already exists.
_ConflictException :: AsError a => Fold a ServiceError
-- | Amazon Keyspaces was unable to fully process this request because of
-- an internal server error.
_InternalServerException :: AsError a => Fold a ServiceError
-- | The operation tried to access a keyspace or table that doesn't exist.
-- The resource might not be specified correctly, or its status might not
-- be ACTIVE.
_ResourceNotFoundException :: AsError a => Fold a ServiceError
-- | The operation exceeded the service quota for this resource. For more
-- information on service quotas, see Quotas in the Amazon
-- Keyspaces Developer Guide.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError
-- | The operation failed due to an invalid or malformed request.
_ValidationException :: AsError a => Fold a ServiceError
-- | See: newCreateKeyspace smart constructor.
data CreateKeyspace
CreateKeyspace' :: Maybe (NonEmpty Tag) -> Text -> CreateKeyspace
-- | Create a value of CreateKeyspace 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:tags:CreateKeyspace', createKeyspace_tags - A list
-- of key-value pair tags to be attached to the keyspace.
--
-- For more information, see Adding tags and labels to Amazon
-- Keyspaces resources in the Amazon Keyspaces Developer
-- Guide.
--
-- CreateKeyspace, createKeyspace_keyspaceName - The name
-- of the keyspace to be created.
newCreateKeyspace :: Text -> CreateKeyspace
-- | See: newCreateKeyspaceResponse smart constructor.
data CreateKeyspaceResponse
CreateKeyspaceResponse' :: Int -> Text -> CreateKeyspaceResponse
-- | Create a value of CreateKeyspaceResponse 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:httpStatus:CreateKeyspaceResponse',
-- createKeyspaceResponse_httpStatus - The response's http status
-- code.
--
-- CreateKeyspaceResponse,
-- createKeyspaceResponse_resourceArn - The unique identifier of
-- the keyspace in the format of an Amazon Resource Name (ARN).
newCreateKeyspaceResponse :: Int -> Text -> CreateKeyspaceResponse
-- | See: newCreateTable smart constructor.
data CreateTable
CreateTable' :: Maybe CapacitySpecification -> Maybe Comment -> Maybe Natural -> Maybe EncryptionSpecification -> Maybe PointInTimeRecovery -> Maybe (NonEmpty Tag) -> Maybe TimeToLive -> Text -> Text -> SchemaDefinition -> 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:
--
-- $sel:capacitySpecification:CreateTable',
-- createTable_capacitySpecification - Specifies the read/write
-- throughput capacity mode for the table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
--
-- $sel:comment:CreateTable', createTable_comment - This
-- parameter allows to enter a description of the table.
--
-- $sel:defaultTimeToLive:CreateTable',
-- createTable_defaultTimeToLive - The default Time to Live
-- setting in seconds for the table.
--
-- For more information, see Setting the default TTL value for a
-- table in the Amazon Keyspaces Developer Guide.
--
-- $sel:encryptionSpecification:CreateTable',
-- createTable_encryptionSpecification - Specifies how the
-- encryption key for encryption at rest is managed for the table. You
-- can choose one of the following KMS key (KMS key):
--
-- • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon
-- Keyspaces.
--
-- • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your
-- account and is created, owned, and managed by you. This option
-- requires the kms_key_identifier of the KMS key in Amazon
-- Resource Name (ARN) format as input.
--
-- The default is type:AWS_OWNED_KMS_KEY.
--
-- For more information, see Encryption at rest in the Amazon
-- Keyspaces Developer Guide.
--
-- $sel:pointInTimeRecovery:CreateTable',
-- createTable_pointInTimeRecovery - Specifies if
-- pointInTimeRecovery is enabled or disabled for the table. The
-- options are:
--
-- • ENABLED
--
-- • DISABLED
--
-- If it's not specified, the default is DISABLED.
--
-- For more information, see Point-in-time recovery in the
-- Amazon Keyspaces Developer Guide.
--
-- $sel:tags:CreateTable', createTable_tags - A list of
-- key-value pair tags to be attached to the resource.
--
-- For more information, see Adding tags and labels to Amazon
-- Keyspaces resources in the Amazon Keyspaces Developer
-- Guide.
--
-- $sel:ttl:CreateTable', createTable_ttl - Enables Time to
-- Live custom settings for the table. The options are:
--
-- • status:enabled
--
-- • status:disabled
--
-- The default is status:disabled. After ttl is
-- enabled, you can't disable it for the table.
--
-- For more information, see Expiring data by using Amazon Keyspaces
-- Time to Live (TTL) in the Amazon Keyspaces Developer Guide.
--
-- CreateTable, createTable_keyspaceName - The name of the
-- keyspace that the table is going to be created in.
--
-- CreateTable, createTable_tableName - The name of the
-- table.
--
-- $sel:schemaDefinition:CreateTable',
-- createTable_schemaDefinition - The schemaDefinition
-- consists of the following parameters.
--
-- For each column to be created:
--
-- • name - The name of the column.
--
-- • type - An Amazon Keyspaces data type. For more information,
-- see Data types in the Amazon Keyspaces Developer Guide.
--
-- The primary key of the table consists of the following columns:
--
-- • partitionKeys - The partition key can be a single column,
-- or it can be a compound value composed of two or more columns. The
-- partition key portion of the primary key is required and determines
-- how Amazon Keyspaces stores your data.
--
-- • name - The name of each partition key column.
--
-- • clusteringKeys - The optional clustering column portion of
-- your primary key determines how the data is clustered and sorted
-- within each partition.
--
-- • name - The name of the clustering column.
--
-- • orderBy - Sets the ascendant (ASC) or descendant
-- (DESC) order modifier.
--
-- To define a column as static use staticColumns - Static
-- columns store values that are shared by all rows in the same
-- partition:
--
-- • name - The name of the column.
--
-- • type - An Amazon Keyspaces data type.
newCreateTable :: Text -> Text -> SchemaDefinition -> CreateTable
-- | See: newCreateTableResponse smart constructor.
data CreateTableResponse
CreateTableResponse' :: Int -> Text -> 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:httpStatus:CreateTableResponse',
-- createTableResponse_httpStatus - The response's http status
-- code.
--
-- CreateTableResponse, createTableResponse_resourceArn -
-- The unique identifier of the table in the format of an Amazon Resource
-- Name (ARN).
newCreateTableResponse :: Int -> Text -> CreateTableResponse
-- | See: newDeleteKeyspace smart constructor.
data DeleteKeyspace
DeleteKeyspace' :: Text -> DeleteKeyspace
-- | Create a value of DeleteKeyspace 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:
--
-- DeleteKeyspace, deleteKeyspace_keyspaceName - The name
-- of the keyspace to be deleted.
newDeleteKeyspace :: Text -> DeleteKeyspace
-- | See: newDeleteKeyspaceResponse smart constructor.
data DeleteKeyspaceResponse
DeleteKeyspaceResponse' :: Int -> DeleteKeyspaceResponse
-- | Create a value of DeleteKeyspaceResponse 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:httpStatus:DeleteKeyspaceResponse',
-- deleteKeyspaceResponse_httpStatus - The response's http status
-- code.
newDeleteKeyspaceResponse :: Int -> DeleteKeyspaceResponse
-- | See: newDeleteTable smart constructor.
data DeleteTable
DeleteTable' :: Text -> Text -> 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_keyspaceName - The name of the
-- keyspace of the to be deleted table.
--
-- DeleteTable, deleteTable_tableName - The name of the
-- table to be deleted.
newDeleteTable :: Text -> Text -> DeleteTable
-- | See: newDeleteTableResponse smart constructor.
data DeleteTableResponse
DeleteTableResponse' :: Int -> 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:httpStatus:DeleteTableResponse',
-- deleteTableResponse_httpStatus - The response's http status
-- code.
newDeleteTableResponse :: Int -> DeleteTableResponse
-- | See: newGetKeyspace smart constructor.
data GetKeyspace
GetKeyspace' :: Text -> GetKeyspace
-- | Create a value of GetKeyspace 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:
--
-- GetKeyspace, getKeyspace_keyspaceName - The name of the
-- keyspace.
newGetKeyspace :: Text -> GetKeyspace
-- | See: newGetKeyspaceResponse smart constructor.
data GetKeyspaceResponse
GetKeyspaceResponse' :: Int -> Text -> Text -> GetKeyspaceResponse
-- | Create a value of GetKeyspaceResponse 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:httpStatus:GetKeyspaceResponse',
-- getKeyspaceResponse_httpStatus - The response's http status
-- code.
--
-- GetKeyspace, getKeyspaceResponse_keyspaceName - The name
-- of the keyspace.
--
-- GetKeyspaceResponse, getKeyspaceResponse_resourceArn -
-- The ARN of the keyspace.
newGetKeyspaceResponse :: Int -> Text -> Text -> GetKeyspaceResponse
-- | See: newGetTable smart constructor.
data GetTable
GetTable' :: Text -> Text -> 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.
newGetTable :: Text -> Text -> GetTable
-- | See: newGetTableResponse smart constructor.
data GetTableResponse
GetTableResponse' :: Maybe CapacitySpecificationSummary -> Maybe Comment -> Maybe POSIX -> Maybe Natural -> Maybe EncryptionSpecification -> Maybe PointInTimeRecoverySummary -> Maybe SchemaDefinition -> Maybe TableStatus -> Maybe TimeToLive -> Int -> Text -> Text -> Text -> 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.
newGetTableResponse :: Int -> Text -> Text -> Text -> GetTableResponse
-- | See: newListKeyspaces smart constructor.
data ListKeyspaces
ListKeyspaces' :: Maybe Natural -> Maybe Text -> ListKeyspaces
-- | Create a value of ListKeyspaces 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:maxResults:ListKeyspaces', listKeyspaces_maxResults
-- - The total number of keyspaces to return in the output. If the total
-- number of keyspaces available is more than the value specified, a
-- NextToken is provided in the output. To resume pagination,
-- provide the NextToken value as an argument of a subsequent
-- API invocation.
--
-- ListKeyspaces, listKeyspaces_nextToken - The pagination
-- token. To resume pagination, provide the NextToken value as
-- argument of a subsequent API invocation.
newListKeyspaces :: ListKeyspaces
-- | See: newListKeyspacesResponse smart constructor.
data ListKeyspacesResponse
ListKeyspacesResponse' :: Maybe Text -> Int -> [KeyspaceSummary] -> ListKeyspacesResponse
-- | Create a value of ListKeyspacesResponse 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:
--
-- ListKeyspaces, listKeyspacesResponse_nextToken - A token
-- to specify where to start paginating. This is the NextToken
-- from a previously truncated response.
--
-- $sel:httpStatus:ListKeyspacesResponse',
-- listKeyspacesResponse_httpStatus - The response's http status
-- code.
--
-- $sel:keyspaces:ListKeyspacesResponse',
-- listKeyspacesResponse_keyspaces - A list of keyspaces.
newListKeyspacesResponse :: Int -> ListKeyspacesResponse
-- | See: newListTables smart constructor.
data ListTables
ListTables' :: Maybe Natural -> Maybe Text -> Text -> ListTables
-- | Create a value of ListTables 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:maxResults:ListTables', listTables_maxResults - The
-- total number of tables to return in the output. If the total number of
-- tables available is more than the value specified, a
-- NextToken is provided in the output. To resume pagination,
-- provide the NextToken value as an argument of a subsequent
-- API invocation.
--
-- ListTables, listTables_nextToken - The pagination token.
-- To resume pagination, provide the NextToken value as an
-- argument of a subsequent API invocation.
--
-- ListTables, listTables_keyspaceName - The name of the
-- keyspace.
newListTables :: Text -> ListTables
-- | See: newListTablesResponse smart constructor.
data ListTablesResponse
ListTablesResponse' :: Maybe Text -> Maybe [TableSummary] -> Int -> ListTablesResponse
-- | Create a value of ListTablesResponse 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:
--
-- ListTables, listTablesResponse_nextToken - A token to
-- specify where to start paginating. This is the NextToken from
-- a previously truncated response.
--
-- $sel:tables:ListTablesResponse',
-- listTablesResponse_tables - A list of tables.
--
-- $sel:httpStatus:ListTablesResponse',
-- listTablesResponse_httpStatus - The response's http status
-- code.
newListTablesResponse :: Int -> ListTablesResponse
-- | See: newListTagsForResource smart constructor.
data ListTagsForResource
ListTagsForResource' :: Maybe Natural -> Maybe Text -> Text -> ListTagsForResource
-- | Create a value of ListTagsForResource 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:maxResults:ListTagsForResource',
-- listTagsForResource_maxResults - The total number of tags to
-- return in the output. If the total number of tags available is more
-- than the value specified, a NextToken is provided in the
-- output. To resume pagination, provide the NextToken value as
-- an argument of a subsequent API invocation.
--
-- ListTagsForResource, listTagsForResource_nextToken - The
-- pagination token. To resume pagination, provide the NextToken
-- value as argument of a subsequent API invocation.
--
-- ListTagsForResource, listTagsForResource_resourceArn -
-- The Amazon Resource Name (ARN) of the Amazon Keyspaces resource.
newListTagsForResource :: Text -> ListTagsForResource
-- | See: newListTagsForResourceResponse smart constructor.
data ListTagsForResourceResponse
ListTagsForResourceResponse' :: Maybe Text -> Maybe (NonEmpty Tag) -> Int -> ListTagsForResourceResponse
-- | Create a value of ListTagsForResourceResponse 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:
--
-- ListTagsForResource,
-- listTagsForResourceResponse_nextToken - A token to specify
-- where to start paginating. This is the NextToken from a
-- previously truncated response.
--
-- $sel:tags:ListTagsForResourceResponse',
-- listTagsForResourceResponse_tags - A list of tags.
--
-- $sel:httpStatus:ListTagsForResourceResponse',
-- listTagsForResourceResponse_httpStatus - The response's http
-- status code.
newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
-- | See: newRestoreTable smart constructor.
data RestoreTable
RestoreTable' :: Maybe CapacitySpecification -> Maybe EncryptionSpecification -> Maybe PointInTimeRecovery -> Maybe POSIX -> Maybe (NonEmpty Tag) -> Text -> Text -> Text -> Text -> RestoreTable
-- | Create a value of RestoreTable 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:capacitySpecificationOverride:RestoreTable',
-- restoreTable_capacitySpecificationOverride - Specifies the
-- read/write throughput capacity mode for the target table. The options
-- are:
--
-- • throughputMode:PAY_PER_REQUEST
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
--
-- $sel:encryptionSpecificationOverride:RestoreTable',
-- restoreTable_encryptionSpecificationOverride - Specifies the
-- encryption settings for the target table. You can choose one of the
-- following KMS key (KMS key):
--
-- • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon
-- Keyspaces.
--
-- • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your
-- account and is created, owned, and managed by you. This option
-- requires the kms_key_identifier of the KMS key in Amazon
-- Resource Name (ARN) format as input.
--
-- The default is type:AWS_OWNED_KMS_KEY.
--
-- For more information, see Encryption at rest in the Amazon
-- Keyspaces Developer Guide.
--
-- $sel:pointInTimeRecoveryOverride:RestoreTable',
-- restoreTable_pointInTimeRecoveryOverride - Specifies the
-- pointInTimeRecovery settings for the target table. The
-- options are:
--
-- • ENABLED
--
-- • DISABLED
--
-- If it's not specified, the default is DISABLED.
--
-- For more information, see Point-in-time recovery in the
-- Amazon Keyspaces Developer Guide.
--
-- $sel:restoreTimestamp:RestoreTable',
-- restoreTable_restoreTimestamp - The restore timestamp in ISO
-- 8601 format.
--
-- $sel:tagsOverride:RestoreTable',
-- restoreTable_tagsOverride - A list of key-value pair tags to be
-- attached to the restored table.
--
-- For more information, see Adding tags and labels to Amazon
-- Keyspaces resources in the Amazon Keyspaces Developer
-- Guide.
--
-- $sel:sourceKeyspaceName:RestoreTable',
-- restoreTable_sourceKeyspaceName - The keyspace name of the
-- source table.
--
-- $sel:sourceTableName:RestoreTable',
-- restoreTable_sourceTableName - The name of the source table.
--
-- $sel:targetKeyspaceName:RestoreTable',
-- restoreTable_targetKeyspaceName - The name of the target
-- keyspace.
--
-- $sel:targetTableName:RestoreTable',
-- restoreTable_targetTableName - The name of the target table.
newRestoreTable :: Text -> Text -> Text -> Text -> RestoreTable
-- | See: newRestoreTableResponse smart constructor.
data RestoreTableResponse
RestoreTableResponse' :: Int -> Text -> RestoreTableResponse
-- | Create a value of RestoreTableResponse 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:httpStatus:RestoreTableResponse',
-- restoreTableResponse_httpStatus - The response's http status
-- code.
--
-- $sel:restoredTableARN:RestoreTableResponse',
-- restoreTableResponse_restoredTableARN - The Amazon Resource
-- Name (ARN) of the restored table.
newRestoreTableResponse :: Int -> Text -> RestoreTableResponse
-- | See: newTagResource smart constructor.
data TagResource
TagResource' :: Text -> NonEmpty Tag -> TagResource
-- | Create a value of TagResource 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:
--
-- TagResource, tagResource_resourceArn - The Amazon
-- Resource Name (ARN) of the Amazon Keyspaces resource to which to add
-- tags.
--
-- $sel:tags:TagResource', tagResource_tags - The tags to
-- be assigned to the Amazon Keyspaces resource.
newTagResource :: Text -> NonEmpty Tag -> TagResource
-- | See: newTagResourceResponse smart constructor.
data TagResourceResponse
TagResourceResponse' :: Int -> TagResourceResponse
-- | Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse',
-- tagResourceResponse_httpStatus - The response's http status
-- code.
newTagResourceResponse :: Int -> TagResourceResponse
-- | See: newUntagResource smart constructor.
data UntagResource
UntagResource' :: Text -> NonEmpty Tag -> UntagResource
-- | Create a value of UntagResource 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:
--
-- UntagResource, untagResource_resourceArn - The Amazon
-- Keyspaces resource that the tags will be removed from. This value is
-- an Amazon Resource Name (ARN).
--
-- $sel:tags:UntagResource', untagResource_tags - A list of
-- existing tags to be removed from the Amazon Keyspaces resource.
newUntagResource :: Text -> NonEmpty Tag -> UntagResource
-- | See: newUntagResourceResponse smart constructor.
data UntagResourceResponse
UntagResourceResponse' :: Int -> UntagResourceResponse
-- | Create a value of UntagResourceResponse 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:httpStatus:UntagResourceResponse',
-- untagResourceResponse_httpStatus - The response's http status
-- code.
newUntagResourceResponse :: Int -> UntagResourceResponse
-- | See: newUpdateTable smart constructor.
data UpdateTable
UpdateTable' :: Maybe (NonEmpty ColumnDefinition) -> Maybe CapacitySpecification -> Maybe Natural -> Maybe EncryptionSpecification -> Maybe PointInTimeRecovery -> Maybe TimeToLive -> Text -> Text -> UpdateTable
-- | Create a value of UpdateTable 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:addColumns:UpdateTable', updateTable_addColumns -
-- For each column to be added to the specified table:
--
-- • name - The name of the column.
--
-- • type - An Amazon Keyspaces data type. For more information,
-- see Data types in the Amazon Keyspaces Developer Guide.
--
-- $sel:capacitySpecification:UpdateTable',
-- updateTable_capacitySpecification - Modifies the read/write
-- throughput capacity mode for the table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
--
-- $sel:defaultTimeToLive:UpdateTable',
-- updateTable_defaultTimeToLive - The default Time to Live
-- setting in seconds for the table.
--
-- For more information, see Setting the default TTL value for a
-- table in the Amazon Keyspaces Developer Guide.
--
-- $sel:encryptionSpecification:UpdateTable',
-- updateTable_encryptionSpecification - Modifies the encryption
-- settings of the table. You can choose one of the following KMS key
-- (KMS key):
--
-- • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon
-- Keyspaces.
--
-- • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your
-- account and is created, owned, and managed by you. This option
-- requires the kms_key_identifier of the KMS key in Amazon
-- Resource Name (ARN) format as input.
--
-- The default is AWS_OWNED_KMS_KEY.
--
-- For more information, see Encryption at rest in the Amazon
-- Keyspaces Developer Guide.
--
-- $sel:pointInTimeRecovery:UpdateTable',
-- updateTable_pointInTimeRecovery - Modifies the
-- pointInTimeRecovery settings of the table. The options are:
--
-- • ENABLED
--
-- • DISABLED
--
-- If it's not specified, the default is DISABLED.
--
-- For more information, see Point-in-time recovery in the
-- Amazon Keyspaces Developer Guide.
--
-- $sel:ttl:UpdateTable', updateTable_ttl - Modifies Time
-- to Live custom settings for the table. The options are:
--
-- • status:enabled
--
-- • status:disabled
--
-- The default is status:disabled. After ttl is
-- enabled, you can't disable it for the table.
--
-- For more information, see Expiring data by using Amazon Keyspaces
-- Time to Live (TTL) in the Amazon Keyspaces Developer Guide.
--
-- UpdateTable, updateTable_keyspaceName - The name of the
-- keyspace the specified table is stored in.
--
-- UpdateTable, updateTable_tableName - The name of the
-- table.
newUpdateTable :: Text -> Text -> UpdateTable
-- | See: newUpdateTableResponse smart constructor.
data UpdateTableResponse
UpdateTableResponse' :: Int -> Text -> UpdateTableResponse
-- | Create a value of UpdateTableResponse 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:httpStatus:UpdateTableResponse',
-- updateTableResponse_httpStatus - The response's http status
-- code.
--
-- UpdateTableResponse, updateTableResponse_resourceArn -
-- The Amazon Resource Name (ARN) of the modified table.
newUpdateTableResponse :: Int -> Text -> UpdateTableResponse
newtype EncryptionType
EncryptionType' :: Text -> EncryptionType
[fromEncryptionType] :: EncryptionType -> Text
pattern EncryptionType_AWS_OWNED_KMS_KEY :: EncryptionType
pattern EncryptionType_CUSTOMER_MANAGED_KMS_KEY :: EncryptionType
newtype PointInTimeRecoveryStatus
PointInTimeRecoveryStatus' :: Text -> PointInTimeRecoveryStatus
[fromPointInTimeRecoveryStatus] :: PointInTimeRecoveryStatus -> Text
pattern PointInTimeRecoveryStatus_DISABLED :: PointInTimeRecoveryStatus
pattern PointInTimeRecoveryStatus_ENABLED :: PointInTimeRecoveryStatus
newtype SortOrder
SortOrder' :: Text -> SortOrder
[fromSortOrder] :: SortOrder -> Text
pattern SortOrder_ASC :: SortOrder
pattern SortOrder_DESC :: SortOrder
newtype TableStatus
TableStatus' :: Text -> TableStatus
[fromTableStatus] :: TableStatus -> Text
pattern TableStatus_ACTIVE :: TableStatus
pattern TableStatus_CREATING :: TableStatus
pattern TableStatus_DELETED :: TableStatus
pattern TableStatus_DELETING :: TableStatus
pattern TableStatus_INACCESSIBLE_ENCRYPTION_CREDENTIALS :: TableStatus
pattern TableStatus_RESTORING :: TableStatus
pattern TableStatus_UPDATING :: TableStatus
newtype ThroughputMode
ThroughputMode' :: Text -> ThroughputMode
[fromThroughputMode] :: ThroughputMode -> Text
pattern ThroughputMode_PAY_PER_REQUEST :: ThroughputMode
pattern ThroughputMode_PROVISIONED :: ThroughputMode
newtype TimeToLiveStatus
TimeToLiveStatus' :: Text -> TimeToLiveStatus
[fromTimeToLiveStatus] :: TimeToLiveStatus -> Text
pattern TimeToLiveStatus_ENABLED :: TimeToLiveStatus
-- | Amazon Keyspaces has two read/write capacity modes for processing
-- reads and writes on your tables:
--
-- • On-demand (default)
--
-- • Provisioned
--
-- The read/write capacity mode that you choose controls how you are
-- charged for read and write throughput and how table throughput
-- capacity is managed.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
--
-- See: newCapacitySpecification smart constructor.
data CapacitySpecification
CapacitySpecification' :: Maybe Natural -> Maybe Natural -> ThroughputMode -> CapacitySpecification
-- | Create a value of CapacitySpecification 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:readCapacityUnits:CapacitySpecification',
-- capacitySpecification_readCapacityUnits - The throughput
-- capacity specified for read operations defined in read
-- capacity units (RCUs).
--
-- $sel:writeCapacityUnits:CapacitySpecification',
-- capacitySpecification_writeCapacityUnits - The throughput
-- capacity specified for write operations defined in write
-- capacity units (WCUs).
--
-- $sel:throughputMode:CapacitySpecification',
-- capacitySpecification_throughputMode - The read/write
-- throughput capacity mode for a table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
newCapacitySpecification :: ThroughputMode -> CapacitySpecification
-- | The read/write throughput capacity mode for a table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
--
-- See: newCapacitySpecificationSummary smart constructor.
data CapacitySpecificationSummary
CapacitySpecificationSummary' :: Maybe POSIX -> Maybe Natural -> Maybe Natural -> ThroughputMode -> CapacitySpecificationSummary
-- | Create a value of CapacitySpecificationSummary 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:lastUpdateToPayPerRequestTimestamp:CapacitySpecificationSummary',
-- capacitySpecificationSummary_lastUpdateToPayPerRequestTimestamp
-- - The timestamp of the last operation that changed the provisioned
-- throughput capacity of a table.
--
-- $sel:readCapacityUnits:CapacitySpecificationSummary',
-- capacitySpecificationSummary_readCapacityUnits - The throughput
-- capacity specified for read operations defined in read
-- capacity units (RCUs).
--
-- $sel:writeCapacityUnits:CapacitySpecificationSummary',
-- capacitySpecificationSummary_writeCapacityUnits - The
-- throughput capacity specified for write operations defined in
-- write capacity units (WCUs).
--
-- $sel:throughputMode:CapacitySpecificationSummary',
-- capacitySpecificationSummary_throughputMode - The read/write
-- throughput capacity mode for a table. The options are:
--
-- • throughputMode:PAY_PER_REQUEST and
--
-- • throughputMode:PROVISIONED - Provisioned capacity mode
-- requires readCapacityUnits and writeCapacityUnits as
-- input.
--
-- The default is throughput_mode:PAY_PER_REQUEST.
--
-- For more information, see Read/write capacity modes in the
-- Amazon Keyspaces Developer Guide.
newCapacitySpecificationSummary :: ThroughputMode -> CapacitySpecificationSummary
-- | The optional clustering column portion of your primary key determines
-- how the data is clustered and sorted within each partition.
--
-- See: newClusteringKey smart constructor.
data ClusteringKey
ClusteringKey' :: Text -> SortOrder -> ClusteringKey
-- | Create a value of ClusteringKey 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:name:ClusteringKey', clusteringKey_name - The
-- name(s) of the clustering column(s).
--
-- $sel:orderBy:ClusteringKey', clusteringKey_orderBy -
-- Sets the ascendant (ASC) or descendant (DESC) order
-- modifier.
newClusteringKey :: Text -> SortOrder -> ClusteringKey
-- | The names and data types of regular columns.
--
-- See: newColumnDefinition smart constructor.
data ColumnDefinition
ColumnDefinition' :: Text -> Text -> ColumnDefinition
-- | Create a value of ColumnDefinition 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:name:ColumnDefinition', columnDefinition_name - The
-- name of the column.
--
-- $sel:type':ColumnDefinition', columnDefinition_type -
-- The data type of the column. For a list of available data types, see
-- Data types in the Amazon Keyspaces Developer Guide.
newColumnDefinition :: Text -> Text -> ColumnDefinition
-- | An optional comment that describes the table.
--
-- See: newComment smart constructor.
data Comment
Comment' :: Text -> Comment
-- | Create a value of Comment 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:message:Comment', comment_message - An optional
-- description of the table.
newComment :: Text -> Comment
-- | Amazon Keyspaces encrypts and decrypts the table data at rest
-- transparently and integrates with Key Management Service for storing
-- and managing the encryption key. You can choose one of the following
-- KMS keys (KMS keys):
--
-- • Amazon Web Services owned key - This is the default encryption type.
-- The key is owned by Amazon Keyspaces (no additional charge).
--
-- • Customer managed key - This key is stored in your account and is
-- created, owned, and managed by you. You have full control over the
-- customer managed key (KMS charges apply).
--
-- For more information about encryption at rest in Amazon Keyspaces, see
-- Encryption at rest in the Amazon Keyspaces Developer
-- Guide.
--
-- For more information about KMS, see KMS management service
-- concepts in the Key Management Service Developer Guide.
--
-- See: newEncryptionSpecification smart constructor.
data EncryptionSpecification
EncryptionSpecification' :: Maybe Text -> EncryptionType -> EncryptionSpecification
-- | Create a value of EncryptionSpecification 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:kmsKeyIdentifier:EncryptionSpecification',
-- encryptionSpecification_kmsKeyIdentifier - The Amazon Resource
-- Name (ARN) of the customer managed KMS key, for example
-- kms_key_identifier:ARN.
--
-- $sel:type':EncryptionSpecification',
-- encryptionSpecification_type - The encryption option specified
-- for the table. You can choose one of the following KMS keys (KMS
-- keys):
--
-- • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon
-- Keyspaces.
--
-- • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your
-- account and is created, owned, and managed by you. This option
-- requires the kms_key_identifier of the KMS key in Amazon
-- Resource Name (ARN) format as input.
--
-- The default is type:AWS_OWNED_KMS_KEY.
--
-- For more information, see Encryption at rest in the Amazon
-- Keyspaces Developer Guide.
newEncryptionSpecification :: EncryptionType -> EncryptionSpecification
-- | Represents the properties of a keyspace.
--
-- See: newKeyspaceSummary smart constructor.
data KeyspaceSummary
KeyspaceSummary' :: Text -> Text -> KeyspaceSummary
-- | Create a value of KeyspaceSummary 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:keyspaceName:KeyspaceSummary',
-- keyspaceSummary_keyspaceName - The name of the keyspace.
--
-- $sel:resourceArn:KeyspaceSummary',
-- keyspaceSummary_resourceArn - The unique identifier of the
-- keyspace in the format of an Amazon Resource Name (ARN).
newKeyspaceSummary :: Text -> Text -> KeyspaceSummary
-- | The partition key portion of the primary key is required and
-- determines how Amazon Keyspaces stores the data. The partition key can
-- be a single column, or it can be a compound value composed of two or
-- more columns.
--
-- See: newPartitionKey smart constructor.
data PartitionKey
PartitionKey' :: Text -> PartitionKey
-- | Create a value of PartitionKey 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:name:PartitionKey', partitionKey_name - The name(s)
-- of the partition key column(s).
newPartitionKey :: Text -> PartitionKey
-- | Point-in-time recovery (PITR) helps protect your Amazon Keyspaces
-- tables from accidental write or delete operations by providing you
-- continuous backups of your table data.
--
-- For more information, see Point-in-time recovery in the
-- Amazon Keyspaces Developer Guide.
--
-- See: newPointInTimeRecovery smart constructor.
data PointInTimeRecovery
PointInTimeRecovery' :: PointInTimeRecoveryStatus -> PointInTimeRecovery
-- | Create a value of PointInTimeRecovery 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:status:PointInTimeRecovery',
-- pointInTimeRecovery_status - The options are:
--
-- • ENABLED
--
-- • DISABLED
newPointInTimeRecovery :: PointInTimeRecoveryStatus -> PointInTimeRecovery
-- | The point-in-time recovery status of the specified table.
--
-- See: newPointInTimeRecoverySummary smart constructor.
data PointInTimeRecoverySummary
PointInTimeRecoverySummary' :: Maybe POSIX -> PointInTimeRecoveryStatus -> PointInTimeRecoverySummary
-- | Create a value of PointInTimeRecoverySummary 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:earliestRestorableTimestamp:PointInTimeRecoverySummary',
-- pointInTimeRecoverySummary_earliestRestorableTimestamp -
-- Specifies the earliest possible restore point of the table in ISO 8601
-- format.
--
-- $sel:status:PointInTimeRecoverySummary',
-- pointInTimeRecoverySummary_status - Shows if point-in-time
-- recovery is enabled or disabled for the specified table.
newPointInTimeRecoverySummary :: PointInTimeRecoveryStatus -> PointInTimeRecoverySummary
-- | Describes the schema of the table.
--
-- See: newSchemaDefinition smart constructor.
data SchemaDefinition
SchemaDefinition' :: Maybe [ClusteringKey] -> Maybe [StaticColumn] -> NonEmpty ColumnDefinition -> NonEmpty PartitionKey -> SchemaDefinition
-- | Create a value of SchemaDefinition 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:clusteringKeys:SchemaDefinition',
-- schemaDefinition_clusteringKeys - The columns that are part of
-- the clustering key of the table.
--
-- $sel:staticColumns:SchemaDefinition',
-- schemaDefinition_staticColumns - The columns that have been
-- defined as STATIC. Static columns store values that are
-- shared by all rows in the same partition.
--
-- $sel:allColumns:SchemaDefinition',
-- schemaDefinition_allColumns - The regular columns of the table.
--
-- $sel:partitionKeys:SchemaDefinition',
-- schemaDefinition_partitionKeys - The columns that are part of
-- the partition key of the table .
newSchemaDefinition :: NonEmpty ColumnDefinition -> NonEmpty PartitionKey -> SchemaDefinition
-- | The static columns of the table. Static columns store values that are
-- shared by all rows in the same partition.
--
-- See: newStaticColumn smart constructor.
data StaticColumn
StaticColumn' :: Text -> StaticColumn
-- | Create a value of StaticColumn 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:name:StaticColumn', staticColumn_name - The name of
-- the static column.
newStaticColumn :: Text -> StaticColumn
-- | Returns the name of the specified table, the keyspace it is stored in,
-- and the unique identifier in the format of an Amazon Resource Name
-- (ARN).
--
-- See: newTableSummary smart constructor.
data TableSummary
TableSummary' :: Text -> Text -> Text -> TableSummary
-- | Create a value of TableSummary 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:keyspaceName:TableSummary',
-- tableSummary_keyspaceName - The name of the keyspace that the
-- table is stored in.
--
-- $sel:tableName:TableSummary', tableSummary_tableName -
-- The name of the table.
--
-- $sel:resourceArn:TableSummary', tableSummary_resourceArn
-- - The unique identifier of the table in the format of an Amazon
-- Resource Name (ARN).
newTableSummary :: Text -> Text -> Text -> TableSummary
-- | Describes a tag. A tag is a key-value pair. You can add up to 50 tags
-- to a single Amazon Keyspaces resource.
--
-- Amazon Web Services-assigned tag names and values are automatically
-- assigned the aws: prefix, which the user cannot assign.
-- Amazon Web Services-assigned tag names do not count towards the tag
-- limit of 50. User-assigned tag names have the prefix user: in
-- the Cost Allocation Report. You cannot backdate the application of a
-- tag.
--
-- For more information, see Adding tags and labels to Amazon
-- Keyspaces resources in the Amazon Keyspaces Developer
-- Guide.
--
-- See: newTag smart constructor.
data Tag
Tag' :: Text -> Text -> Tag
-- | Create a value of Tag 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:key:Tag', tag_key - The key of the tag. Tag keys
-- are case sensitive. Each Amazon Keyspaces resource can only have up to
-- one tag with the same key. If you try to add an existing tag (same
-- key), the existing tag value will be updated to the new value.
--
-- $sel:value:Tag', tag_value - The value of the tag. Tag
-- values are case-sensitive and can be null.
newTag :: Text -> Text -> Tag
-- | Enable custom Time to Live (TTL) settings for rows and columns without
-- setting a TTL default for the specified table.
--
-- For more information, see Enabling TTL on tables in the
-- Amazon Keyspaces Developer Guide.
--
-- See: newTimeToLive smart constructor.
data TimeToLive
TimeToLive' :: TimeToLiveStatus -> TimeToLive
-- | Create a value of TimeToLive 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:status:TimeToLive', timeToLive_status - Shows how
-- to enable custom Time to Live (TTL) settings for the specified table.
newTimeToLive :: TimeToLiveStatus -> TimeToLive