JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
  • Summary:
  • Nested |
  • Field |
  • Constr |
  • Method
  • Detail:
  • Field |
  • Constr |
  • Method
com.amazonaws.services.keyspaces

Interface AmazonKeyspacesAsync

  • All Superinterfaces:
    AmazonKeyspaces
    All Known Implementing Classes:
    AbstractAmazonKeyspacesAsync, AmazonKeyspacesAsyncClient 

    @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonKeyspacesAsync
extends AmazonKeyspaces
    Interface for accessing Amazon Keyspaces asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

    Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonKeyspacesAsync instead.

    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, as well as infrastructure as code (IaC) services and tools such as CloudFormation and Terraform. 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.

    • Method Detail

      • createKeyspaceAsync

        Future<CreateKeyspaceResult> createKeyspaceAsync(CreateKeyspaceRequest createKeyspaceRequest)

        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.

        Parameters:
        createKeyspaceRequest -
        Returns:
        A Java Future containing the result of the CreateKeyspace operation returned by the service.
        See Also:
        AWS API Documentation

      • createKeyspaceAsync

        Future<CreateKeyspaceResult> createKeyspaceAsync(CreateKeyspaceRequest createKeyspaceRequest,
 AsyncHandler<CreateKeyspaceRequest,CreateKeyspaceResult> asyncHandler)

        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.

        Parameters:
        createKeyspaceRequest -
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the CreateKeyspace operation returned by the service.
        See Also:
        AWS API Documentation

      • createTableAsync

        Future<CreateTableResult> createTableAsync(CreateTableRequest createTableRequest)

        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.

        Parameters:
        createTableRequest -
        Returns:
        A Java Future containing the result of the CreateTable operation returned by the service.
        See Also:
        AWS API Documentation

      • createTableAsync

        Future<CreateTableResult> createTableAsync(CreateTableRequest createTableRequest,
 AsyncHandler<CreateTableRequest,CreateTableResult> asyncHandler)

        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.

        Parameters:
        createTableRequest -
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the CreateTable operation returned by the service.
        See Also:
        AWS API Documentation

      • deleteKeyspaceAsync

        Future<DeleteKeyspaceResult> deleteKeyspaceAsync(DeleteKeyspaceRequest deleteKeyspaceRequest)

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

        Parameters:
        deleteKeyspaceRequest -
        Returns:
        A Java Future containing the result of the DeleteKeyspace operation returned by the service.
        See Also:
        AWS API Documentation

      • deleteKeyspaceAsync

        Future<DeleteKeyspaceResult> deleteKeyspaceAsync(DeleteKeyspaceRequest deleteKeyspaceRequest,
 AsyncHandler<DeleteKeyspaceRequest,DeleteKeyspaceResult> asyncHandler)

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

        Parameters:
        deleteKeyspaceRequest -
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the DeleteKeyspace operation returned by the service.
        See Also:
        AWS API Documentation

      • deleteTableAsync

        Future<DeleteTableResult> deleteTableAsync(DeleteTableRequest deleteTableRequest)

        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.

        Parameters:
        deleteTableRequest -
        Returns:
        A Java Future containing the result of the DeleteTable operation returned by the service.
        See Also:
        AWS API Documentation

      • deleteTableAsync

        Future<DeleteTableResult> deleteTableAsync(DeleteTableRequest deleteTableRequest,
 AsyncHandler<DeleteTableRequest,DeleteTableResult> asyncHandler)

        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.

        Parameters:
        deleteTableRequest -
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the DeleteTable operation returned by the service.
        See Also:
        AWS API Documentation

      • getKeyspaceAsync

        Future<GetKeyspaceResult> getKeyspaceAsync(GetKeyspaceRequest getKeyspaceRequest)

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

        Parameters:
        getKeyspaceRequest -
        Returns:
        A Java Future containing the result of the GetKeyspace operation returned by the service.
        See Also:
        AWS API Documentation

      • getKeyspaceAsync

        Future<GetKeyspaceResult> getKeyspaceAsync(GetKeyspaceRequest getKeyspaceRequest,
 AsyncHandler<GetKeyspaceRequest,GetKeyspaceResult> asyncHandler)

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

        Parameters:
        getKeyspaceRequest -
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the GetKeyspace operation returned by the service.
        See Also:
        AWS API Documentation

      • getTableAsync

        Future<GetTableResult> getTableAsync(GetTableRequest getTableRequest)

        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.

        Parameters:
        getTableRequest -
        Returns:
        A Java Future containing the result of the GetTable operation returned by the service.
        See Also:
        AWS API Documentation

      • getTableAsync

        Future<GetTableResult> getTableAsync(GetTableRequest getTableRequest,
 AsyncHandler<GetTableRequest,GetTableResult> asyncHandler)

        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.

        Parameters:
        getTableRequest -
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the GetTable operation returned by the service.
        See Also:
        AWS API Documentation

      • getTableAutoScalingSettingsAsync

        Future<GetTableAutoScalingSettingsResult> getTableAutoScalingSettingsAsync(GetTableAutoScalingSettingsRequest getTableAutoScalingSettingsRequest)

        Returns auto scaling related settings of the specified table in JSON format. If the table is a multi-Region table, the Amazon Web Services Region specific auto scaling settings of the table are included.

        Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic. For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.

        GetTableAutoScalingSettings can't be used as an action in an IAM policy.

        To define permissions for GetTableAutoScalingSettings, you must allow the following two actions in the IAM policy statement's Action element:

        • application-autoscaling:DescribeScalableTargets

        • application-autoscaling:DescribeScalingPolicies

        Parameters:
        getTableAutoScalingSettingsRequest -
        Returns:
        A Java Future containing the result of the GetTableAutoScalingSettings operation returned by the service.
        See Also:
        AWS API Documentation

      • getTableAutoScalingSettingsAsync

        Future<GetTableAutoScalingSettingsResult> getTableAutoScalingSettingsAsync(GetTableAutoScalingSettingsRequest getTableAutoScalingSettingsRequest,
 AsyncHandler<GetTableAutoScalingSettingsRequest,GetTableAutoScalingSettingsResult> asyncHandler)

        Returns auto scaling related settings of the specified table in JSON format. If the table is a multi-Region table, the Amazon Web Services Region specific auto scaling settings of the table are included.

        Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic. For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.

        GetTableAutoScalingSettings can't be used as an action in an IAM policy.

        To define permissions for GetTableAutoScalingSettings, you must allow the following two actions in the IAM policy statement's Action element:

        • application-autoscaling:DescribeScalableTargets

        • application-autoscaling:DescribeScalingPolicies

        Parameters:
        getTableAutoScalingSettingsRequest -
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the GetTableAutoScalingSettings operation returned by the service.
        See Also:
        AWS API Documentation

      • listKeyspacesAsync

        Future<ListKeyspacesResult> listKeyspacesAsync(ListKeyspacesRequest listKeyspacesRequest,
 AsyncHandler<ListKeyspacesRequest,ListKeyspacesResult> asyncHandler)

        Returns a list of keyspaces.

        Parameters:
        listKeyspacesRequest -
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the ListKeyspaces operation returned by the service.
        See Also:
        AWS API Documentation

      • listTablesAsync

        Future<ListTablesResult> listTablesAsync(ListTablesRequest listTablesRequest)

        Returns a list of tables for a specified keyspace.

        Parameters:
        listTablesRequest -
        Returns:
        A Java Future containing the result of the ListTables operation returned by the service.
        See Also:
        AWS API Documentation

      • listTablesAsync

        Future<ListTablesResult> listTablesAsync(ListTablesRequest listTablesRequest,
 AsyncHandler<ListTablesRequest,ListTablesResult> asyncHandler)

        Returns a list of tables for a specified keyspace.

        Parameters:
        listTablesRequest -
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the ListTables operation returned by the service.
        See Also:
        AWS API Documentation

      • listTagsForResourceAsync

        Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)

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

        Parameters:
        listTagsForResourceRequest -
        Returns:
        A Java Future containing the result of the ListTagsForResource operation returned by the service.
        See Also:
        AWS API Documentation

      • listTagsForResourceAsync

        Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
 AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)

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

        Parameters:
        listTagsForResourceRequest -
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the ListTagsForResource operation returned by the service.
        See Also:
        AWS API Documentation

      • restoreTableAsync

        Future<RestoreTableResult> restoreTableAsync(RestoreTableRequest restoreTableRequest)

        Restores the 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, auto scaling settings, encryption settings, 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 units

        • Auto scaling 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:

        • Identity and Access Management (IAM) policies

        • Amazon CloudWatch metrics and alarms

        Parameters:
        restoreTableRequest -
        Returns:
        A Java Future containing the result of the RestoreTable operation returned by the service.
        See Also:
        AWS API Documentation

      • restoreTableAsync

        Future<RestoreTableResult> restoreTableAsync(RestoreTableRequest restoreTableRequest,
 AsyncHandler<RestoreTableRequest,RestoreTableResult> asyncHandler)

        Restores the 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, auto scaling settings, encryption settings, 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 units

        • Auto scaling 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:

        • Identity and Access Management (IAM) policies

        • Amazon CloudWatch metrics and alarms

        Parameters:
        restoreTableRequest -
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the RestoreTable operation returned by the service.
        See Also:
        AWS API Documentation

      • tagResourceAsync

        Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest,
 AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)

        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.

        Parameters:
        tagResourceRequest -
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the TagResource operation returned by the service.
        See Also:
        AWS API Documentation

      • untagResourceAsync

        Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)

        Removes the association of tags from a Amazon Keyspaces resource.

        Parameters:
        untagResourceRequest -
        Returns:
        A Java Future containing the result of the UntagResource operation returned by the service.
        See Also:
        AWS API Documentation

      • untagResourceAsync

        Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest,
 AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)

        Removes the association of tags from a Amazon Keyspaces resource.

        Parameters:
        untagResourceRequest -
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the UntagResource operation returned by the service.
        See Also:
        AWS API Documentation

      • updateTableAsync

        Future<UpdateTableResult> updateTableAsync(UpdateTableRequest updateTableRequest)

        Adds new columns to the table or updates one of the table's settings, for example capacity mode, auto scaling, encryption, point-in-time recovery, or ttl settings. Note that you can only update one specific table setting per update operation.

        Parameters:
        updateTableRequest -
        Returns:
        A Java Future containing the result of the UpdateTable operation returned by the service.
        See Also:
        AWS API Documentation

      • updateTableAsync

        Future<UpdateTableResult> updateTableAsync(UpdateTableRequest updateTableRequest,
 AsyncHandler<UpdateTableRequest,UpdateTableResult> asyncHandler)

        Adds new columns to the table or updates one of the table's settings, for example capacity mode, auto scaling, encryption, point-in-time recovery, or ttl settings. Note that you can only update one specific table setting per update operation.

        Parameters:
        updateTableRequest -
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the UpdateTable operation returned by the service.
        See Also:
        AWS API Documentation
Skip navigation links
  • Summary:
  • Nested |
  • Field |
  • Constr |
  • Method
  • Detail:
  • Field |
  • Constr |
  • Method

AltStyle によって変換されたページ (->オリジナル) /