Keyspaces

This page documents function available when using the Keyspaces module, created with @service Keyspaces.

Index

Documentation

Main.Keyspaces.create_keyspaceMethod
create_keyspace(keyspace_name)
create_keyspace(keyspace_name, params::Dict{String,<:Any})

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.

Arguments

  • keyspace_name: The name of the keyspace to be created.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "replicationSpecification": The replication specification of the keyspace includes: replicationStrategy - the required value is SINGLEREGION or MULTIREGION. regionList - if the replicationStrategy is MULTI_REGION, the regionList requires the current Region and at least one additional Amazon Web Services Region where the keyspace is going to be replicated in. The maximum number of supported replication Regions including the current Region is six.
  • "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.
Main.Keyspaces.create_tableMethod
create_table(keyspace_name, schema_definition, table_name)
create_table(keyspace_name, schema_definition, table_name, params::Dict{String,<:Any})

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.

Arguments

  • keyspace_name: The name of the keyspace that the table is going to be created in.
  • schema_definition: 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.
  • table_name: The name of the table.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "capacitySpecification": Specifies the read/write throughput capacity mode for the table. The options are: throughputMode:PAYPERREQUEST and throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input. The default is throughputmode:PAYPER_REQUEST. For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
  • "clientSideTimestamps": Enables client-side timestamps for the table. By default, the setting is disabled. You can enable client-side timestamps with the following option: status: "enabled" Once client-side timestamps are enabled for a table, this setting cannot be disabled.
  • "comment": This parameter allows to enter a description of the table.
  • "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.
  • "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:AWSOWNEDKMSKEY - This key is owned by Amazon Keyspaces. type:CUSTOMERMANAGEDKMSKEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kmskeyidentifier of the KMS key in Amazon Resource Name (ARN) format as input. The default is type:AWSOWNEDKMS_KEY. For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
  • "pointInTimeRecovery": Specifies if pointInTimeRecovery is enabled or disabled for the table. The options are: status=ENABLED status=DISABLED If it's not specified, the default is status=DISABLED. For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
  • "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.
  • "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.
Main.Keyspaces.delete_keyspaceMethod
delete_keyspace(keyspace_name)
delete_keyspace(keyspace_name, params::Dict{String,<:Any})

The DeleteKeyspace operation deletes a keyspace and all of its tables.

Arguments

  • keyspace_name: The name of the keyspace to be deleted.
Main.Keyspaces.delete_tableMethod
delete_table(keyspace_name, table_name)
delete_table(keyspace_name, table_name, params::Dict{String,<:Any})

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.

Arguments

  • keyspace_name: The name of the keyspace of the to be deleted table.
  • table_name: The name of the table to be deleted.
Main.Keyspaces.get_keyspaceMethod
get_keyspace(keyspace_name)
get_keyspace(keyspace_name, params::Dict{String,<:Any})

Returns the name and the Amazon Resource Name (ARN) of the specified table.

Arguments

  • keyspace_name: The name of the keyspace.
Main.Keyspaces.get_tableMethod
get_table(keyspace_name, table_name)
get_table(keyspace_name, table_name, params::Dict{String,<:Any})

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.

Arguments

  • keyspace_name: The name of the keyspace that the table is stored in.
  • table_name: The name of the table.
Main.Keyspaces.list_keyspacesMethod
list_keyspaces()
list_keyspaces(params::Dict{String,<:Any})

Returns a list of keyspaces.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
  • "nextToken": The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
Main.Keyspaces.list_tablesMethod
list_tables(keyspace_name)
list_tables(keyspace_name, params::Dict{String,<:Any})

Returns a list of tables for a specified keyspace.

Arguments

  • keyspace_name: The name of the keyspace.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
  • "nextToken": The pagination token. To resume pagination, provide the NextToken value as an argument of a subsequent API invocation.
Main.Keyspaces.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Returns a list of all tags associated with the specified Amazon Keyspaces resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the Amazon Keyspaces resource.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
  • "nextToken": The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
Main.Keyspaces.restore_tableMethod
restore_table(source_keyspace_name, source_table_name, target_keyspace_name, target_table_name)
restore_table(source_keyspace_name, source_table_name, target_keyspace_name, target_table_name, params::Dict{String,<:Any})

Restores the specified table to the specified point in time within the earliestrestorabletimestamp 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

Arguments

  • source_keyspace_name: The keyspace name of the source table.
  • source_table_name: The name of the source table.
  • target_keyspace_name: The name of the target keyspace.
  • target_table_name: The name of the target table.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "capacitySpecificationOverride": Specifies the read/write throughput capacity mode for the target table. The options are: throughputMode:PAYPERREQUEST throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input. The default is throughputmode:PAYPER_REQUEST. For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
  • "encryptionSpecificationOverride": Specifies the encryption settings for the target table. You can choose one of the following KMS key (KMS key): type:AWSOWNEDKMSKEY - This key is owned by Amazon Keyspaces. type:CUSTOMERMANAGEDKMSKEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kmskeyidentifier of the KMS key in Amazon Resource Name (ARN) format as input. The default is type:AWSOWNEDKMS_KEY. For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
  • "pointInTimeRecoveryOverride": Specifies the pointInTimeRecovery settings for the target table. The options are: status=ENABLED status=DISABLED If it's not specified, the default is status=DISABLED. For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
  • "restoreTimestamp": The restore timestamp in ISO 8601 format.
  • "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.
Main.Keyspaces.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

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.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the Amazon Keyspaces resource to which to add tags.
  • tags: The tags to be assigned to the Amazon Keyspaces resource.
Main.Keyspaces.untag_resourceMethod
untag_resource(resource_arn, tags)
untag_resource(resource_arn, tags, params::Dict{String,<:Any})

Removes the association of tags from a Amazon Keyspaces resource.

Arguments

  • resource_arn: The Amazon Keyspaces resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).
  • tags: A list of existing tags to be removed from the Amazon Keyspaces resource.
Main.Keyspaces.update_tableMethod
update_table(keyspace_name, table_name)
update_table(keyspace_name, table_name, params::Dict{String,<:Any})

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.

Arguments

  • keyspace_name: The name of the keyspace the specified table is stored in.
  • table_name: The name of the table.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
  • "capacitySpecification": Modifies the read/write throughput capacity mode for the table. The options are: throughputMode:PAYPERREQUEST and throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input. The default is throughputmode:PAYPER_REQUEST. For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
  • "clientSideTimestamps": Enables client-side timestamps for the table. By default, the setting is disabled. You can enable client-side timestamps with the following option: status: "enabled" Once client-side timestamps are enabled for a table, this setting cannot be disabled.
  • "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.
  • "encryptionSpecification": Modifies the encryption settings of the table. You can choose one of the following KMS key (KMS key): type:AWSOWNEDKMSKEY - This key is owned by Amazon Keyspaces. type:CUSTOMERMANAGEDKMSKEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kmskeyidentifier of the KMS key in Amazon Resource Name (ARN) format as input. The default is AWSOWNEDKMS_KEY. For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
  • "pointInTimeRecovery": Modifies the pointInTimeRecovery settings of the table. The options are: status=ENABLED status=DISABLED If it's not specified, the default is status=DISABLED. For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
  • "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.