Class: Aws::Keyspaces::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/client.rb

Overview

An API client for Keyspaces. To construct a client, you need to configure a :region and :credentials.

client = Aws::Keyspaces::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy"

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy"

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :token_provider (Aws::TokenProvider)

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean)

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean)

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::Keyspaces::EndpointProvider)

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::Keyspaces::EndpointParameters

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Float) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :ssl_timeout (Float) — default: nil

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



375
376
377
# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/client.rb', line 375

def initialize(*args)
  super
end

Instance Method Details

#create_keyspace(params = {}) ⇒ Types::CreateKeyspaceResponse

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.

Examples:

Request syntax with placeholder values


resp = client.create_keyspace({
  keyspace_name: "KeyspaceName", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.resource_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

Returns:

See Also:



433
434
435
436
# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/client.rb', line 433

def create_keyspace(params = {}, options = {})
  req = build_request(:create_keyspace, params)
  req.send_request(options)
end

#create_table(params = {}) ⇒ Types::CreateTableResponse

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.

Examples:

Request syntax with placeholder values


resp = client.create_table({
  keyspace_name: "KeyspaceName", # required
  table_name: "TableName", # required
  schema_definition: { # required
    all_columns: [ # required
      {
        name: "GenericString", # required
        type: "GenericString", # required
      },
    ],
    partition_keys: [ # required
      {
        name: "GenericString", # required
      },
    ],
    clustering_keys: [
      {
        name: "GenericString", # required
        order_by: "ASC", # required, accepts ASC, DESC
      },
    ],
    static_columns: [
      {
        name: "GenericString", # required
      },
    ],
  },
  comment: {
    message: "String", # required
  },
  capacity_specification: {
    throughput_mode: "PAY_PER_REQUEST", # required, accepts PAY_PER_REQUEST, PROVISIONED
    read_capacity_units: 1,
    write_capacity_units: 1,
  },
  encryption_specification: {
    type: "CUSTOMER_MANAGED_KMS_KEY", # required, accepts CUSTOMER_MANAGED_KMS_KEY, AWS_OWNED_KMS_KEY
    kms_key_identifier: "kmsKeyARN",
  },
  point_in_time_recovery: {
    status: "ENABLED", # required, accepts ENABLED, DISABLED
  },
  ttl: {
    status: "ENABLED", # required, accepts ENABLED
  },
  default_time_to_live: 1,
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.resource_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :keyspace_name (required, String)

    The name of the keyspace that the table is going to be created in.

  • :table_name (required, String)

    The name of the table.

  • :schema_definition (required, Types::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.

  • :comment (Types::Comment)

    This parameter allows to enter a description of the table.

  • :capacity_specification (Types::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.

  • :encryption_specification (Types::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.

  • :point_in_time_recovery (Types::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.

  • :ttl (Types::TimeToLive)

    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.

  • :default_time_to_live (Integer)

    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.

  • :tags (Array<Types::Tag>)

    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.

Returns:

See Also:



662
663
664
665
# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/client.rb', line 662

def create_table(params = {}, options = {})
  req = build_request(:create_table, params)
  req.send_request(options)
end

#delete_keyspace(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_keyspace({
  keyspace_name: "KeyspaceName", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :keyspace_name (required, String)

    The name of the keyspace to be deleted.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



685
686
687
688
# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/client.rb', line 685

def delete_keyspace(params = {}, options = {})
  req = build_request(:delete_keyspace, params)
  req.send_request(options)
end

#delete_table(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.delete_table({
  keyspace_name: "KeyspaceName", # required
  table_name: "TableName", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :keyspace_name (required, String)

    The name of the keyspace of the to be deleted table.

  • :table_name (required, String)

    The name of the table to be deleted.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



718
719
720
721
# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/client.rb', line 718

def delete_table(params = {}, options = {})
  req = build_request(:delete_table, params)
  req.send_request(options)
end

#get_keyspace(params = {}) ⇒ Types::GetKeyspaceResponse

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

Examples:

Request syntax with placeholder values


resp = client.get_keyspace({
  keyspace_name: "KeyspaceName", # required
})

Response structure


resp.keyspace_name #=> String
resp.resource_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :keyspace_name (required, String)

    The name of the keyspace.

Returns:

See Also:



749
750
751
752
# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/client.rb', line 749

def get_keyspace(params = {}, options = {})
  req = build_request(:get_keyspace, params)
  req.send_request(options)
end

#get_table(params = {}) ⇒ Types::GetTableResponse

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.

Examples:

Request syntax with placeholder values


resp = client.get_table({
  keyspace_name: "KeyspaceName", # required
  table_name: "TableName", # required
})

Response structure


resp.keyspace_name #=> String
resp.table_name #=> String
resp.resource_arn #=> String
resp.creation_timestamp #=> Time
resp.status #=> String, one of "ACTIVE", "CREATING", "UPDATING", "DELETING", "DELETED", "RESTORING", "INACCESSIBLE_ENCRYPTION_CREDENTIALS"
resp.schema_definition.all_columns #=> Array
resp.schema_definition.all_columns[0].name #=> String
resp.schema_definition.all_columns[0].type #=> String
resp.schema_definition.partition_keys #=> Array
resp.schema_definition.partition_keys[0].name #=> String
resp.schema_definition.clustering_keys #=> Array
resp.schema_definition.clustering_keys[0].name #=> String
resp.schema_definition.clustering_keys[0].order_by #=> String, one of "ASC", "DESC"
resp.schema_definition.static_columns #=> Array
resp.schema_definition.static_columns[0].name #=> String
resp.capacity_specification.throughput_mode #=> String, one of "PAY_PER_REQUEST", "PROVISIONED"
resp.capacity_specification.read_capacity_units #=> Integer
resp.capacity_specification.write_capacity_units #=> Integer
resp.capacity_specification.last_update_to_pay_per_request_timestamp #=> Time
resp.encryption_specification.type #=> String, one of "CUSTOMER_MANAGED_KMS_KEY", "AWS_OWNED_KMS_KEY"
resp.encryption_specification.kms_key_identifier #=> String
resp.point_in_time_recovery.status #=> String, one of "ENABLED", "DISABLED"
resp.point_in_time_recovery.earliest_restorable_timestamp #=> Time
resp.ttl.status #=> String, one of "ENABLED"
resp.default_time_to_live #=> Integer
resp.comment.message #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :keyspace_name (required, String)

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

  • :table_name (required, String)

    The name of the table.

Returns:

See Also:



823
824
825
826
# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/client.rb', line 823

def get_table(params = {}, options = {})
  req = build_request(:get_table, params)
  req.send_request(options)
end

#list_keyspaces(params = {}) ⇒ Types::ListKeyspacesResponse

Returns a list of keyspaces.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_keyspaces({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.keyspaces #=> Array
resp.keyspaces[0].keyspace_name #=> String
resp.keyspaces[0].resource_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :next_token (String)

    The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

  • :max_results (Integer)

    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.

Returns:

See Also:



865
866
867
868
# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/client.rb', line 865

def list_keyspaces(params = {}, options = {})
  req = build_request(:list_keyspaces, params)
  req.send_request(options)
end

#list_tables(params = {}) ⇒ Types::ListTablesResponse

Returns a list of tables for a specified keyspace.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_tables({
  next_token: "NextToken",
  max_results: 1,
  keyspace_name: "KeyspaceName", # required
})

Response structure


resp.next_token #=> String
resp.tables #=> Array
resp.tables[0].keyspace_name #=> String
resp.tables[0].table_name #=> String
resp.tables[0].resource_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :next_token (String)

    The pagination token. To resume pagination, provide the NextToken value as an argument of a subsequent API invocation.

  • :max_results (Integer)

    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.

  • :keyspace_name (required, String)

    The name of the keyspace.

Returns:

See Also:



912
913
914
915
# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/client.rb', line 912

def list_tables(params = {}, options = {})
  req = build_request(:list_tables, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ARN", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

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

  • :next_token (String)

    The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

  • :max_results (Integer)

    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.

Returns:

See Also:



959
960
961
962
# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/client.rb', line 959

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#restore_table(params = {}) ⇒ Types::RestoreTableResponse

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

Examples:

Request syntax with placeholder values


resp = client.restore_table({
  source_keyspace_name: "KeyspaceName", # required
  source_table_name: "TableName", # required
  target_keyspace_name: "KeyspaceName", # required
  target_table_name: "TableName", # required
  restore_timestamp: Time.now,
  capacity_specification_override: {
    throughput_mode: "PAY_PER_REQUEST", # required, accepts PAY_PER_REQUEST, PROVISIONED
    read_capacity_units: 1,
    write_capacity_units: 1,
  },
  encryption_specification_override: {
    type: "CUSTOMER_MANAGED_KMS_KEY", # required, accepts CUSTOMER_MANAGED_KMS_KEY, AWS_OWNED_KMS_KEY
    kms_key_identifier: "kmsKeyARN",
  },
  point_in_time_recovery_override: {
    status: "ENABLED", # required, accepts ENABLED, DISABLED
  },
  tags_override: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.restored_table_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :source_keyspace_name (required, String)

    The keyspace name of the source table.

  • :source_table_name (required, String)

    The name of the source table.

  • :target_keyspace_name (required, String)

    The name of the target keyspace.

  • :target_table_name (required, String)

    The name of the target table.

  • :restore_timestamp (Time, DateTime, Date, Integer, String)

    The restore timestamp in ISO 8601 format.

  • :capacity_specification_override (Types::CapacitySpecification)

    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.

  • :encryption_specification_override (Types::EncryptionSpecification)

    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.

  • :point_in_time_recovery_override (Types::PointInTimeRecovery)

    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.

  • :tags_override (Array<Types::Tag>)

    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.

Returns:

See Also:



1134
1135
1136
1137
# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/client.rb', line 1134

def restore_table(params = {}, options = {})
  req = build_request(:restore_table, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ARN", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the Amazon Keyspaces resource to which to add tags.

  • :tags (required, Array<Types::Tag>)

    The tags to be assigned to the Amazon Keyspaces resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1179
1180
1181
1182
# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/client.rb', line 1179

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes the association of tags from a Amazon Keyspaces resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ARN", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Keyspaces resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).

  • :tags (required, Array<Types::Tag>)

    A list of existing tags to be removed from the Amazon Keyspaces resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1212
1213
1214
1215
# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/client.rb', line 1212

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_table(params = {}) ⇒ Types::UpdateTableResponse

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.

Examples:

Request syntax with placeholder values


resp = client.update_table({
  keyspace_name: "KeyspaceName", # required
  table_name: "TableName", # required
  add_columns: [
    {
      name: "GenericString", # required
      type: "GenericString", # required
    },
  ],
  capacity_specification: {
    throughput_mode: "PAY_PER_REQUEST", # required, accepts PAY_PER_REQUEST, PROVISIONED
    read_capacity_units: 1,
    write_capacity_units: 1,
  },
  encryption_specification: {
    type: "CUSTOMER_MANAGED_KMS_KEY", # required, accepts CUSTOMER_MANAGED_KMS_KEY, AWS_OWNED_KMS_KEY
    kms_key_identifier: "kmsKeyARN",
  },
  point_in_time_recovery: {
    status: "ENABLED", # required, accepts ENABLED, DISABLED
  },
  ttl: {
    status: "ENABLED", # required, accepts ENABLED
  },
  default_time_to_live: 1,
})

Response structure


resp.resource_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :keyspace_name (required, String)

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

  • :table_name (required, String)

    The name of the table.

  • :add_columns (Array<Types::ColumnDefinition>)

    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.

  • :capacity_specification (Types::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.

  • :encryption_specification (Types::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.

  • :point_in_time_recovery (Types::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.

  • :ttl (Types::TimeToLive)

    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.

  • :default_time_to_live (Integer)

    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.

Returns:

See Also:



1363
1364
1365
1366
# File 'gems/aws-sdk-keyspaces/lib/aws-sdk-keyspaces/client.rb', line 1363

def update_table(params = {}, options = {})
  req = build_request(:update_table, params)
  req.send_request(options)
end