| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.KeySpaces
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- Types
- EncryptionType
- PointInTimeRecoveryStatus
- SortOrder
- TableStatus
- ThroughputMode
- TimeToLiveStatus
- CapacitySpecification
- CapacitySpecificationSummary
- ClusteringKey
- ColumnDefinition
- Comment
- EncryptionSpecification
- KeyspaceSummary
- PartitionKey
- PointInTimeRecovery
- PointInTimeRecoverySummary
- SchemaDefinition
- StaticColumn
- TableSummary
- Tag
- TimeToLive
Description
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.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data CreateKeyspace = CreateKeyspace' (Maybe (NonEmpty Tag)) Text
- newCreateKeyspace :: Text -> CreateKeyspace
- data CreateKeyspaceResponse = CreateKeyspaceResponse' Int Text
- newCreateKeyspaceResponse :: Int -> Text -> CreateKeyspaceResponse
- data CreateTable = CreateTable' (Maybe CapacitySpecification) (Maybe Comment) (Maybe Natural) (Maybe EncryptionSpecification) (Maybe PointInTimeRecovery) (Maybe (NonEmpty Tag)) (Maybe TimeToLive) Text Text SchemaDefinition
- newCreateTable :: Text -> Text -> SchemaDefinition -> CreateTable
- data CreateTableResponse = CreateTableResponse' Int Text
- newCreateTableResponse :: Int -> Text -> CreateTableResponse
- data DeleteKeyspace = DeleteKeyspace' Text
- newDeleteKeyspace :: Text -> DeleteKeyspace
- data DeleteKeyspaceResponse = DeleteKeyspaceResponse' Int
- newDeleteKeyspaceResponse :: Int -> DeleteKeyspaceResponse
- data DeleteTable = DeleteTable' Text Text
- newDeleteTable :: Text -> Text -> DeleteTable
- data DeleteTableResponse = DeleteTableResponse' Int
- newDeleteTableResponse :: Int -> DeleteTableResponse
- data GetKeyspace = GetKeyspace' Text
- newGetKeyspace :: Text -> GetKeyspace
- data GetKeyspaceResponse = GetKeyspaceResponse' Int Text Text
- newGetKeyspaceResponse :: Int -> Text -> Text -> GetKeyspaceResponse
- data GetTable = GetTable' Text Text
- newGetTable :: Text -> Text -> GetTable
- 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
- newGetTableResponse :: Int -> Text -> Text -> Text -> GetTableResponse
- data ListKeyspaces = ListKeyspaces' (Maybe Natural) (Maybe Text)
- newListKeyspaces :: ListKeyspaces
- data ListKeyspacesResponse = ListKeyspacesResponse' (Maybe Text) Int [KeyspaceSummary]
- newListKeyspacesResponse :: Int -> ListKeyspacesResponse
- data ListTables = ListTables' (Maybe Natural) (Maybe Text) Text
- newListTables :: Text -> ListTables
- data ListTablesResponse = ListTablesResponse' (Maybe Text) (Maybe [TableSummary]) Int
- newListTablesResponse :: Int -> ListTablesResponse
- data ListTagsForResource = ListTagsForResource' (Maybe Natural) (Maybe Text) Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe Text) (Maybe (NonEmpty Tag)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data RestoreTable = RestoreTable' (Maybe CapacitySpecification) (Maybe EncryptionSpecification) (Maybe PointInTimeRecovery) (Maybe POSIX) (Maybe (NonEmpty Tag)) Text Text Text Text
- newRestoreTable :: Text -> Text -> Text -> Text -> RestoreTable
- data RestoreTableResponse = RestoreTableResponse' Int Text
- newRestoreTableResponse :: Int -> Text -> RestoreTableResponse
- data TagResource = TagResource' Text (NonEmpty Tag)
- newTagResource :: Text -> NonEmpty Tag -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text (NonEmpty Tag)
- newUntagResource :: Text -> NonEmpty Tag -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateTable = UpdateTable' (Maybe (NonEmpty ColumnDefinition)) (Maybe CapacitySpecification) (Maybe Natural) (Maybe EncryptionSpecification) (Maybe PointInTimeRecovery) (Maybe TimeToLive) Text Text
- newUpdateTable :: Text -> Text -> UpdateTable
- data UpdateTableResponse = UpdateTableResponse' Int Text
- newUpdateTableResponse :: Int -> Text -> UpdateTableResponse
- newtype EncryptionType where
- newtype PointInTimeRecoveryStatus where
- newtype SortOrder where
- SortOrder' { }
- pattern SortOrder_ASC :: SortOrder
- pattern SortOrder_DESC :: SortOrder
- newtype TableStatus where
- TableStatus' { }
- 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 where
- ThroughputMode' { }
- pattern ThroughputMode_PAY_PER_REQUEST :: ThroughputMode
- pattern ThroughputMode_PROVISIONED :: ThroughputMode
- newtype TimeToLiveStatus where
- TimeToLiveStatus' { }
- pattern TimeToLiveStatus_ENABLED :: TimeToLiveStatus
- data CapacitySpecification = CapacitySpecification' (Maybe Natural) (Maybe Natural) ThroughputMode
- newCapacitySpecification :: ThroughputMode -> CapacitySpecification
- data CapacitySpecificationSummary = CapacitySpecificationSummary' (Maybe POSIX) (Maybe Natural) (Maybe Natural) ThroughputMode
- newCapacitySpecificationSummary :: ThroughputMode -> CapacitySpecificationSummary
- data ClusteringKey = ClusteringKey' Text SortOrder
- newClusteringKey :: Text -> SortOrder -> ClusteringKey
- data ColumnDefinition = ColumnDefinition' Text Text
- newColumnDefinition :: Text -> Text -> ColumnDefinition
- data Comment = Comment' Text
- newComment :: Text -> Comment
- data EncryptionSpecification = EncryptionSpecification' (Maybe Text) EncryptionType
- newEncryptionSpecification :: EncryptionType -> EncryptionSpecification
- data KeyspaceSummary = KeyspaceSummary' Text Text
- newKeyspaceSummary :: Text -> Text -> KeyspaceSummary
- data PartitionKey = PartitionKey' Text
- newPartitionKey :: Text -> PartitionKey
- data PointInTimeRecovery = PointInTimeRecovery' PointInTimeRecoveryStatus
- newPointInTimeRecovery :: PointInTimeRecoveryStatus -> PointInTimeRecovery
- data PointInTimeRecoverySummary = PointInTimeRecoverySummary' (Maybe POSIX) PointInTimeRecoveryStatus
- newPointInTimeRecoverySummary :: PointInTimeRecoveryStatus -> PointInTimeRecoverySummary
- data SchemaDefinition = SchemaDefinition' (Maybe [ClusteringKey]) (Maybe [StaticColumn]) (NonEmpty ColumnDefinition) (NonEmpty PartitionKey)
- newSchemaDefinition :: NonEmpty ColumnDefinition -> NonEmpty PartitionKey -> SchemaDefinition
- data StaticColumn = StaticColumn' Text
- newStaticColumn :: Text -> StaticColumn
- data TableSummary = TableSummary' Text Text Text
- newTableSummary :: Text -> Text -> Text -> TableSummary
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data TimeToLive = TimeToLive' TimeToLiveStatus
- newTimeToLive :: TimeToLiveStatus -> TimeToLive
Service Configuration
defaultService :: Service Source #
API version 2022-02-10 of the Amazon Keyspaces SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by KeySpaces.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient access to perform this action.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
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.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
Amazon Keyspaces was unable to fully process this request because of an internal server error.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
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.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The operation failed due to an invalid or malformed request.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateKeyspace
data CreateKeyspace Source #
See: newCreateKeyspace smart constructor.
Constructors
| CreateKeyspace' (Maybe (NonEmpty Tag)) Text |
Instances
Arguments
| :: 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.
data CreateKeyspaceResponse Source #
See: newCreateKeyspaceResponse smart constructor.
Constructors
| CreateKeyspaceResponse' Int Text |
Instances
newCreateKeyspaceResponse Source #
Arguments
| :: 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).
CreateTable
data CreateTable Source #
See: newCreateTable smart constructor.
Constructors
Instances
Arguments
| :: 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.
data CreateTableResponse Source #
See: newCreateTableResponse smart constructor.
Constructors
| CreateTableResponse' Int Text |
Instances
newCreateTableResponse Source #
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).
DeleteKeyspace
data DeleteKeyspace Source #
See: newDeleteKeyspace smart constructor.
Constructors
| DeleteKeyspace' Text |
Instances
Arguments
| :: 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.
data DeleteKeyspaceResponse Source #
See: newDeleteKeyspaceResponse smart constructor.
Constructors
| DeleteKeyspaceResponse' Int |
Instances
newDeleteKeyspaceResponse Source #
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.
DeleteTable
data DeleteTable Source #
See: newDeleteTable smart constructor.
Constructors
| DeleteTable' Text Text |
Instances
Arguments
| :: 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.
data DeleteTableResponse Source #
See: newDeleteTableResponse smart constructor.
Constructors
| DeleteTableResponse' Int |
Instances
newDeleteTableResponse Source #
Arguments
| :: 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.
GetKeyspace
data GetKeyspace Source #
See: newGetKeyspace smart constructor.
Constructors
| GetKeyspace' Text |
Instances
Arguments
| :: 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.
data GetKeyspaceResponse Source #
See: newGetKeyspaceResponse smart constructor.
Constructors
| GetKeyspaceResponse' Int Text Text |
Instances
newGetKeyspaceResponse Source #
Arguments
| :: 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.
GetTable
See: newGetTable smart constructor.
Instances
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.
data GetTableResponse Source #
See: newGetTableResponse smart constructor.
Constructors
Instances
Arguments
| :: 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.
ListKeyspaces (Paginated)
data ListKeyspaces Source #
See: newListKeyspaces smart constructor.
Constructors
| ListKeyspaces' (Maybe Natural) (Maybe Text) |
Instances
newListKeyspaces :: ListKeyspaces Source #
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.
data ListKeyspacesResponse Source #
See: newListKeyspacesResponse smart constructor.
Constructors
| ListKeyspacesResponse' (Maybe Text) Int [KeyspaceSummary] |
Instances
newListKeyspacesResponse Source #
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.
ListTables (Paginated)
data ListTables Source #
See: newListTables smart constructor.
Instances
Arguments
| :: 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.
data ListTablesResponse Source #
See: newListTablesResponse smart constructor.
Constructors
| ListTablesResponse' (Maybe Text) (Maybe [TableSummary]) Int |
Instances
newListTablesResponse Source #
Arguments
| :: 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.
ListTagsForResource (Paginated)
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Instances
newListTagsForResource Source #
Arguments
| :: 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.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
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.
RestoreTable
data RestoreTable Source #
See: newRestoreTable smart constructor.
Constructors
| RestoreTable' (Maybe CapacitySpecification) (Maybe EncryptionSpecification) (Maybe PointInTimeRecovery) (Maybe POSIX) (Maybe (NonEmpty Tag)) Text Text Text Text |
Instances
Arguments
| :: 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.
data RestoreTableResponse Source #
See: newRestoreTableResponse smart constructor.
Constructors
| RestoreTableResponse' Int Text |
Instances
newRestoreTableResponse Source #
Arguments
| :: 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.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text (NonEmpty Tag) |
Instances
Arguments
| :: 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.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: 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.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text (NonEmpty Tag) |
Instances
Arguments
| :: 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.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
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.
UpdateTable
data UpdateTable Source #
See: newUpdateTable smart constructor.
Constructors
| UpdateTable' (Maybe (NonEmpty ColumnDefinition)) (Maybe CapacitySpecification) (Maybe Natural) (Maybe EncryptionSpecification) (Maybe PointInTimeRecovery) (Maybe TimeToLive) Text Text |
Instances
Arguments
| :: 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.
data UpdateTableResponse Source #
See: newUpdateTableResponse smart constructor.
Constructors
| UpdateTableResponse' Int Text |
Instances
newUpdateTableResponse Source #
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.
Types
EncryptionType
newtype EncryptionType Source #
Constructors
| EncryptionType' | |
Fields | |
Bundled Patterns
| pattern EncryptionType_AWS_OWNED_KMS_KEY :: EncryptionType | |
| pattern EncryptionType_CUSTOMER_MANAGED_KMS_KEY :: EncryptionType |
Instances
PointInTimeRecoveryStatus
newtype PointInTimeRecoveryStatus Source #
Constructors
| PointInTimeRecoveryStatus' | |
Fields | |
Bundled Patterns
| pattern PointInTimeRecoveryStatus_DISABLED :: PointInTimeRecoveryStatus | |
| pattern PointInTimeRecoveryStatus_ENABLED :: PointInTimeRecoveryStatus |
Instances
SortOrder
Constructors
| SortOrder' | |
Fields | |
Bundled Patterns
| pattern SortOrder_ASC :: SortOrder | |
| pattern SortOrder_DESC :: SortOrder |
Instances
TableStatus
newtype TableStatus Source #
Constructors
| TableStatus' | |
Fields | |
Bundled Patterns
| 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 |
Instances
ThroughputMode
newtype ThroughputMode Source #
Constructors
| ThroughputMode' | |
Fields | |
Bundled Patterns
| pattern ThroughputMode_PAY_PER_REQUEST :: ThroughputMode | |
| pattern ThroughputMode_PROVISIONED :: ThroughputMode |
Instances
TimeToLiveStatus
newtype TimeToLiveStatus Source #
Constructors
| TimeToLiveStatus' | |
Fields | |
Bundled Patterns
| pattern TimeToLiveStatus_ENABLED :: TimeToLiveStatus |
Instances
CapacitySpecification
data CapacitySpecification Source #
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.
Constructors
| CapacitySpecification' (Maybe Natural) (Maybe Natural) ThroughputMode |
Instances
newCapacitySpecification Source #
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.
CapacitySpecificationSummary
data CapacitySpecificationSummary Source #
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.
Constructors
| CapacitySpecificationSummary' (Maybe POSIX) (Maybe Natural) (Maybe Natural) ThroughputMode |
Instances
newCapacitySpecificationSummary Source #
Arguments
| :: 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.
ClusteringKey
data ClusteringKey Source #
The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition.
See: newClusteringKey smart constructor.
Constructors
| ClusteringKey' Text SortOrder |
Instances
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.
ColumnDefinition
data ColumnDefinition Source #
The names and data types of regular columns.
See: newColumnDefinition smart constructor.
Constructors
| ColumnDefinition' Text Text |
Instances
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.
Comment
An optional comment that describes the table.
See: newComment smart constructor.
Instances
| FromJSON Comment Source # | |
| ToJSON Comment Source # | |
Defined in Amazonka.KeySpaces.Types.Comment | |
| Generic Comment Source # | |
| Read Comment Source # | |
| Show Comment Source # | |
| NFData Comment Source # | |
Defined in Amazonka.KeySpaces.Types.Comment | |
| Eq Comment Source # | |
| Hashable Comment Source # | |
Defined in Amazonka.KeySpaces.Types.Comment | |
| type Rep Comment Source # | |
Defined in Amazonka.KeySpaces.Types.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.
EncryptionSpecification
data EncryptionSpecification Source #
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.
Constructors
| EncryptionSpecification' (Maybe Text) EncryptionType |
Instances
newEncryptionSpecification Source #
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.
KeyspaceSummary
data KeyspaceSummary Source #
Represents the properties of a keyspace.
See: newKeyspaceSummary smart constructor.
Constructors
| KeyspaceSummary' Text Text |
Instances
Arguments
| :: 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).
PartitionKey
data PartitionKey Source #
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.
Constructors
| PartitionKey' Text |
Instances
Arguments
| :: 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).
PointInTimeRecovery
data PointInTimeRecovery Source #
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.
Constructors
| PointInTimeRecovery' PointInTimeRecoveryStatus |
Instances
newPointInTimeRecovery Source #
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
PointInTimeRecoverySummary
data PointInTimeRecoverySummary Source #
The point-in-time recovery status of the specified table.
See: newPointInTimeRecoverySummary smart constructor.
Constructors
| PointInTimeRecoverySummary' (Maybe POSIX) PointInTimeRecoveryStatus |
Instances
newPointInTimeRecoverySummary Source #
Arguments
| :: 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.
SchemaDefinition
data SchemaDefinition Source #
Describes the schema of the table.
See: newSchemaDefinition smart constructor.
Constructors
| SchemaDefinition' (Maybe [ClusteringKey]) (Maybe [StaticColumn]) (NonEmpty ColumnDefinition) (NonEmpty PartitionKey) |
Instances
Arguments
| :: 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 .
StaticColumn
data StaticColumn Source #
The static columns of the table. Static columns store values that are shared by all rows in the same partition.
See: newStaticColumn smart constructor.
Constructors
| StaticColumn' Text |
Instances
Arguments
| :: 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.
TableSummary
data TableSummary Source #
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.
Constructors
| TableSummary' Text Text Text |
Instances
Arguments
| :: 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).
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.
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.KeySpaces.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.KeySpaces.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.KeySpaces.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.KeySpaces.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.KeySpaces.Types.Tag" "amazonka-keyspaces-2.0-IgmNF4xdaFLH03VHAkrBWw" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 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.
TimeToLive
data TimeToLive Source #
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.
Constructors
| TimeToLive' TimeToLiveStatus |
Instances
Arguments
| :: 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.